Click or drag to resize
DistantSpecularEffect Class
Lighting effect creates an image that appears to be a 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) applying the specular portion of the Phong lighting model. Note, height map is not supported with Composition.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsDistantSpecularEffect

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 DistantSpecularEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The DistantSpecularEffect type exposes the following members.

Constructors
  NameDescription
Public methodDistantSpecularEffect
Initializes a new instance of the DistantSpecularEffect class.
Top
Properties
  NameDescription
Public propertyAzimuth
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.
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 propertyElevation
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.
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 propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for DistantSpecular effect.
Public propertySpecularAmount
Intensity of the specular light. Default value 1.
Public propertySpecularExponent
Specular power for the Phong lighting model. Larger values produce more sharply defined highlights. Default value 1.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this DistantSpecularEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this DistantSpecularEffect.
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 Distant-specular lighting effect.

See Also