Click or drag to resize
PointDiffuseEffect 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 a point light source. Note, height map is not supported with Composition.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsPointDiffuseEffect

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntax
C#
Copy
public sealed class PointDiffuseEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The PointDiffuseEffect type exposes the following members.

Constructors
  NameDescription
Public methodPointDiffuseEffect
Initializes a new instance of the PointDiffuseEffect class.
Top
Properties
  NameDescription
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 propertyDiffuseAmount
Intensity of the diffuse light. Default value 1.
Public propertyHeightMapInterpolationMode
[NoComposition] Interpolation mode used to filter the height map. Default value Linear.
Public propertyHeightMapKernelSize
[NoComposition] Size of the Sobel filter kernel used to convert the input heightmap to surface normal vectors. Default value (1,1).
Public propertyHeightMapScale
[NoComposition] Height map scale factor in the Z direction. Default value 1.
Public propertyLightColor
Color of the incoming light. Default value white.
Public propertyLightColorHdr
High-dynamic-range color of the incoming light. Default value white.
Public propertyLightPosition
Position of the light source. Default value (0,0,0).
Public propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for PointDiffuse effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this PointDiffuseEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this PointDiffuseEffect.
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.
Top
Remarks

This Windows Runtime type corresponds to the D2D Point-diffuse lighting effect.

See Also