Class DropShadowLayerEffect

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

Composites a drop shadow beneath the contents of a compositing layer when it is restored. The shadow is the content's own silhouette tinted with the shadow colour, blurred, and offset.

public sealed class DropShadowLayerEffect : LayerEffect

Inheritance

object

LayerEffect

DropShadowLayerEffect

Inherited Members

LayerEffect.IsPassThrough

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DropShadowLayerEffect(Point, float, Color)

Initializes a new instance of the DropShadowLayerEffect class.

public DropShadowLayerEffect(Point offset, float sigma, Color color)

Parameters

offset Point

The shadow offset, in pixels.

sigma float

The Gaussian blur sigma, in pixels; zero draws a hard shadow.

color Color

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

Properties

Color

Gets the shadow colour.

public Color Color { get; }

Property Value

Color

Offset

Gets the shadow offset, in pixels.

public Point Offset { get; }

Property Value

Point

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.

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