Click or drag to resize
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
C#
public sealed class AlphaMaskEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The AlphaMaskEffect type exposes the following members.

Constructors
  NameDescription
Public methodAlphaMaskEffect
[Win10_14393] Initializes a new instance of the AlphaMaskEffect class.
Top
Properties
  NameDescription
Public propertyAlphaMask
[Win10_14393] Gets or sets the alpha mask input source.
Public propertyBufferPrecision
[Win10_14393] Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
[Win10_14393] Enables caching the output from drawing this effect.
Public propertyStatic memberIsSupported
[Win10] Checks whether AlphaMaskEffect is supported on the current operating system version.
Public propertyName
[Win10_14393] Attaches a user-defined name string to the effect.
Public propertySource
[Win10_14393] Gets or sets the color input source.
Top
Methods
  NameDescription
Public methodDispose
[Win10_14393] Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
[Win10_14393] Retrieves the bounds of this AlphaMaskEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
[Win10_14393] Retrieves the bounds of this AlphaMaskEffect.
Public methodGetInvalidRectangles
[Win10_14393] Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
[Win10_14393] Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
[Win10_14393] Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
[Win10_14393] Notifies the effect that one of its source images has changed.
Top
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.

See Also