EmbossEffect Class

EmbossEffect Class

[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

public sealed class EmbossEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The EmbossEffect type exposes the following members.

Constructors

	Name	Description
	EmbossEffect	Initializes a new instance of the EmbossEffect class.

Properties

	Name	Description
	Amount	Controls the strength of the embossing effect. Default value 1, range 0 to 10.
	Angle	Specifies the light direction used to create the effect. Units are specified in radians. 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.
	Name	Attaches a user-defined name string to the effect.
	Source	Gets or sets the input source for Emboss effect.

Methods

	Name	Description
	Dispose	Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	Retrieves the bounds of this EmbossEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	Retrieves the bounds of this EmbossEffect.
	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.

Remarks

Supported by Win2D but not Windows.UI.Composition.

This Windows Runtime type corresponds to the D2D Emboss effect.