Click or drag to resize
ShadowEffect Class
[NoComposition] Generates a shadow from the alpha channel of an image. The shadow is more opaque for higher alpha values and more transparent for lower alpha values. You can set the amount of blur and the color of the shadow.
Inheritance Hierarchy

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version:
public sealed class ShadowEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The ShadowEffect type exposes the following members.

Public methodShadowEffect
Initializes a new instance of the ShadowEffect class.
Public propertyBlurAmount
The amount of blur to be applied to the alpha channel of the image. Default value 3.
Public propertyBufferPrecision
Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
Enables caching the output from drawing this effect.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyOptimization
Level of performance optimization. Default value Balanced.
Public propertyShadowColor
Color of the shadow. Default black.
Public propertyShadowColorHdr
High-dynaimc-range color of the shadow. Default black.
Public propertySource
Gets or sets the input source for Shadow effect.
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this ShadowEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this ShadowEffect.
Public methodGetInvalidRectangles
Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
Notifies the effect that one of its source images has changed.

Supported by Win2D but not Windows.UI.Composition.

To add a drop shadow to an image, use the shadow effect, translate it by the desired shadow offset, then composite the original image over the top.

This Windows Runtime type corresponds to the D2D Shadow effect.

See Also