Class GlowLayerEffect

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

Composites a glow beneath the contents of a compositing layer when it is restored: the content's own silhouette tinted with the glow colour and blurred, spreading evenly in all directions.

public sealed class GlowLayerEffect : LayerEffect

Inheritance

object

LayerEffect

GlowLayerEffect

Inherited Members

LayerEffect.IsPassThrough

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GlowLayerEffect(float, Color)

Initializes a new instance of the GlowLayerEffect class.

public GlowLayerEffect(float sigma, Color color)

Parameters

sigma float

The Gaussian blur sigma, in pixels, controlling the glow's spread.

color Color

The glow colour. Its alpha scales the content's alpha, so a semi-transparent colour draws a fainter glow.

Properties

Color

Gets the glow colour.

public Color Color { get; }

Property Value

Color

Reach

Gets the distance, in pixels, the effect can push content beyond its source region. Layer and processing bounds are expanded by this reach so the effect output is not cut off. Effects constructed over a fallback inherit the fallback's reach.

public override int Reach { get; }

Property Value

int

Sigma

Gets the Gaussian blur sigma, in pixels, controlling the glow's spread.

public float Sigma { get; }

Property Value

float

WriteBackOffset

Gets the offset, in pixels, at which the processed pixels are written back relative to the region they were read from.

public override Point WriteBackOffset { get; }

Property Value

Point

WriteBackOptions

Gets the graphics options used to composite the processed pixels back onto the layer, or null to replace the processed region outright.

public override GraphicsOptions? WriteBackOptions { get; }

Property Value

GraphicsOptions