| ChromaKeyEffect Class |
Inheritance HierarchyMicrosoft.Graphics.Canvas.EffectsChromaKeyEffect
Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntaxpublic sealed class ChromaKeyEffect : ICanvasEffect, IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable
The ChromaKeyEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ChromaKeyEffect | Initializes a new instance of the ChromaKeyEffect class. |
Properties| Name | Description | |
|---|---|---|
 | BufferPrecision | Specifies what precision to use for intermediate buffers when drawing this effect. |
| CacheOutput | Enables caching the output from drawing this effect. |
| Color | Specifies the color to be replaced with transparency. Default value black. |
| ColorHdr | Specifies the high-dynamic-range color to be replaced with transparency. Default value black. |
| Feather | Indicates whether the edges of the output should be softened. Default value false. |
| InvertAlpha | Indicates whether the output alpha values should be inverted. Default value false. |
| Name | Attaches a user-defined name string to the effect. |
| Source | Gets or sets the input source for ChromaKey effect. |
| Tolerance | Tolerance for matching the chroma key color. Default value 0.1, range 0 to 1. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the effect. |
| GetBounds(ICanvasResourceCreator) | Retrieves the bounds of this ChromaKeyEffect. |
| GetBounds(ICanvasResourceCreator, Matrix3x2) | Retrieves the bounds of this ChromaKeyEffect. |
| 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. |
RemarksSupported by Win2D but not Windows.UI.Composition.
Chroma keying is a more general purpose version of the green screen technique that is frequently used to remove unwanted backgrounds from photographs or film. If an image is captured over a green background, chroma key can be used to replace the green with transparency, after which the image can be composited over the top of any other background.
Effect inputs and outputs are assumed to be in premultiplied alpha format, but this effect operates internally on straight alpha data, so its input values will be unpremultiplied, then chroma keying applied, and finally the result converted back to premultiplied format.
This Windows Runtime type corresponds to the D2D Chroma key effect.
See Also