Click or drag to resize
EmbossEffect Class
[Win10] [NoComposition] Creates a grayscale version of an image that appears as though it has been stamped into paper.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsEmbossEffect

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

The EmbossEffect type exposes the following members.

Constructors
  NameDescription
Public methodEmbossEffect
Initializes a new instance of the EmbossEffect class.
Top
Properties
  NameDescription
Public propertyAmount
Controls the strength of the embossing effect. Default value 1, range 0 to 10.
Public propertyAngle
Specifies the light direction used to create the effect. Units are specified in radians. 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 propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for Emboss effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this EmbossEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this EmbossEffect.
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 API is available on Windows 10 (Universal Windows Platform) only. It is not supported on Windows 8.1 or Phone 8.1.

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D Emboss effect.

See Also