Click or drag to resize
ChromaKeyEffect Class
[Win10] [NoComposition] Replaces a specified color with transparency.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsChromaKeyEffect

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

The ChromaKeyEffect type exposes the following members.

Constructors
  NameDescription
Public methodChromaKeyEffect
Initializes a new instance of the ChromaKeyEffect class.
Top
Properties
  NameDescription
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 propertyColor
Specifies the color to be replaced with transparency. Default value black.
Public propertyColorHdr
Specifies the high-dynamic-range color to be replaced with transparency. Default value black.
Public propertyFeather
Indicates whether the edges of the output should be softened. Default value false.
Public propertyInvertAlpha
Indicates whether the output alpha values should be inverted. Default value false.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertySource
Gets or sets the input source for ChromaKey effect.
Public propertyTolerance
Tolerance for matching the chroma key color. Default value 0.1, range 0 to 1.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this ChromaKeyEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this ChromaKeyEffect.
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.

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