AlphaMaskEffect Class

[Win10_14393] Changes the opacity of an image by applying an alpha mask from a second image.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsAlphaMaskEffect

Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0

Syntax

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

The AlphaMaskEffect type exposes the following members.

Constructors

	Name	Description
	AlphaMaskEffect	[Win10_14393] Initializes a new instance of the AlphaMaskEffect class.

Properties

	Name	Description
	AlphaMask	[Win10_14393] Gets or sets the alpha mask input source.
	BufferPrecision	[Win10_14393] Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	[Win10_14393] Enables caching the output from drawing this effect.
	IsSupported	Checks whether AlphaMaskEffect is supported on the current operating system version.
	Name	[Win10_14393] Attaches a user-defined name string to the effect.
	Source	[Win10_14393] Gets or sets the color input source.

Methods

	Name	Description
	Dispose	[Win10_14393] Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	[Win10_14393] Retrieves the bounds of this AlphaMaskEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	[Win10_14393] Retrieves the bounds of this AlphaMaskEffect.
	GetInvalidRectangles	[Win10_14393] Queries what regions of the effect output have changed since it was last drawn.
	GetRequiredSourceRectangle	[Win10_14393] Queries what part of an effect source image is needed to draw an output region.
	GetRequiredSourceRectangles	[Win10_14393] Queries what parts of the effect source images are needed to draw an output region.
	InvalidateSourceRectangle	[Win10_14393] Notifies the effect that one of its source images has changed.

Remarks

This API is only available when running on Windows 10 build 14393 (Anniversary Update) or greater.

This effect combines the alpha channel of its AlphaMask input image with the specified Source image. RGB values of the AlphaMask are ignored.

This Windows Runtime type corresponds to the D2D Alpha mask effect.