Class ChromaKeySettings
- Namespace
- VisioForge.Core.Types
- Assembly
- VisioForge.Core.dll
Chroma-key settings. Configures the chroma key (green screen) effect that replaces a specific color in the video with a background image. Commonly used for video compositing and special effects.
public class ChromaKeySettings : IDisposableInheritance
Implements
Inherited Members
Constructors
ChromaKeySettings(Bitmap)
Initializes a new instance of the VisioForge.Core.Types.ChromaKeySettings class with a background image and default chroma key settings.
public ChromaKeySettings(Bitmap bitmap)Parameters
bitmapBitmap-
The background image that will replace the chroma key color in the video. This bitmap will be owned by the ChromaKeySettings instance and disposed when the instance is disposed.
Properties
BackgroundBitmap
Gets the background image that will replace the chroma key color. This image will be shown where the chroma key color is detected in the video.
public Bitmap BackgroundBitmap { get; }Property Value
Color
Gets or sets the chroma key color to be replaced. This is typically green (RGB: 0, 255, 0) or blue (RGB: 0, 0, 255). Default is a green color (RGB: 128, 218, 128).
public Color Color { get; set; }Property Value
Smoothing
Gets or sets the smoothing value for edge blending. Controls how smooth the edges are between the replaced area and the original video. Higher values create softer edges but may create a halo effect. Default is 0.08.
public float Smoothing { get; set; }Property Value
ThresholdSensitivity
Gets or sets the threshold sensitivity for color detection. Controls how closely a pixel must match the chroma key color to be replaced. Range is typically 0.0 to 1.0. Lower values require closer color matching. Default is 0.1804573.
public float ThresholdSensitivity { get; set; }Property Value
Methods
Dispose(bool)
Dispose.
protected virtual void Dispose(bool disposing)Parameters
disposingbool-
Disposing parameter.
Dispose()
Dispose.
public void Dispose()