| DistantDiffuseEffect Class |
Lighting effect creates an image that appears to be an illuminated non-reflective
surface. This effect uses the alpha channel as a height map, and lights it with
an infinitely distant light source (such as the sun). Note, height map is not
supported with Composition.
Inheritance HierarchySystem.Object
Microsoft.Graphics.Canvas.Effects.DistantDiffuseEffect
Microsoft.Graphics.Canvas.Effects.DistantDiffuseEffect
Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
SyntaxC#
public sealed class DistantDiffuseEffect : ICanvasEffect, IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable
The DistantDiffuseEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DistantDiffuseEffect | Initializes a new instance of the DistantDiffuseEffect class. |
Properties| Name | Description | |
|---|---|---|
 | Azimuth | Direction of the light source, measured in radians in the XY plane,
counter-clockwise relative to the X axis. Default value 0, range 0 to 2*pi. |
| BufferPrecision | Specifies what precision to use for intermediate buffers when drawing this effect. |
| CacheOutput | Enables caching the output from drawing this effect. |
| DiffuseAmount | Intensity of the diffuse light. Default value 1. |
| Elevation | Elevation of the light source, measured in radians in the YZ plane,
counter-clockwise relative to the Y axis. Default value 0, range 0 to 2*pi. |
| HeightMapInterpolationMode | [NoComposition] Interpolation mode used to filter the height map.
Default value Linear. |
| HeightMapKernelSize | [NoComposition] Size of the Sobel filter kernel used to convert the input heightmap to
surface normal vectors. Default value (1,1). |
| HeightMapScale | [NoComposition] Height map scale factor in the Z direction. Default value 1. |
| LightColor | Color of the incoming light. Default value white. |
| LightColorHdr | High-dynamic-range color of the incoming light. Default value white. |
| Name | Attaches a user-defined name string to the effect. |
| Source | Gets or sets the input source for DistantDiffuse effect. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the effect. |
| GetBounds(ICanvasResourceCreator) | Retrieves the bounds of this DistantDiffuseEffect. |
| GetBounds(ICanvasResourceCreator, Matrix3x2) | Retrieves the bounds of this DistantDiffuseEffect. |
| GetInvalidRectangles | Queries what regions of the effect output have changed since it was last drawn. |
 | GetRequiredSourceRectangle | Queries what part of an effect source image is needed to draw an output region. |
| GetRequiredSourceRectangles | Queries what parts of the effect source images are needed to draw an output region. |
| InvalidateSourceRectangle | Notifies the effect that one of its source images has changed. |
RemarksThis Windows Runtime type corresponds to the D2D Distant-diffuse lighting effect.
See Also