| SpotDiffuseEffect Class |
Lighting effect creates an image that appears to be an illuminated non-reflective
surface where the light source is limited to a directed cone of light. This
effect uses the alpha channel as a height map, and lights it with a point light
source. Note, height map is not supported with Composition.
Inheritance HierarchySystem.Object
Microsoft.Graphics.Canvas.Effects.SpotDiffuseEffect
Microsoft.Graphics.Canvas.Effects.SpotDiffuseEffect
Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
SyntaxC#
public sealed class SpotDiffuseEffect : ICanvasEffect, IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable
The SpotDiffuseEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SpotDiffuseEffect | Initializes a new instance of the SpotDiffuseEffect class. |
Properties| Name | Description | |
|---|---|---|
 | 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. |
| Focus | Focus of the spot light. Default value 1. |
| 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. |
| LightPosition | Position of the light source. Default value (0,0,0). |
| LightTarget | Target that the spot light is pointing at. Default value (0,0,0). |
| LimitingConeAngle | Angle (in radians) that restricts the region where light is projected.
No light is projected outside the cone. Default value pi/2. |
| Name | Attaches a user-defined name string to the effect. |
| Source | Gets or sets the input source for SpotDiffuse effect. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the effect. |
| GetBounds(ICanvasResourceCreator) | Retrieves the bounds of this SpotDiffuseEffect. |
| GetBounds(ICanvasResourceCreator, Matrix3x2) | Retrieves the bounds of this SpotDiffuseEffect. |
| 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 Spot-diffuse lighting effect.
See Also