Interface IVideoEffectsControls

Namespace

VisioForge.Core.Types

Assembly

VisioForge.Core.dll

Defines a standard set of controls for applying basic real-time video effects. This interface provides methods to adjust common image properties such as brightness, contrast, and saturation, as well as apply simple transformations like grayscale, flip, and invert.

public interface IVideoEffectsControls

Remarks

This interface is intended to be implemented by components that handle video rendering or processing, such as media players or video capture controls. It provides a unified way to manipulate the visual appearance of the video stream in real-time. Effects are typically applied using GPU shaders or image processing filters for optimal performance. All effect values are multiplicative or boolean - brightness/contrast/saturation typically use 1.0 as the neutral value. Effects can be stacked and are generally applied in the order they are set. The VideoEffects_Clear method resets all effects to their default neutral state. These effects are applied before rendering and do not modify the source video data when recording.

Methods

VideoEffects_Clear()

Resets all video effects to their default values.

void VideoEffects_Clear()

VideoEffects_SetBrightness(double)

Sets the brightness level of the video.

void VideoEffects_SetBrightness(double value)

Parameters

value double

The brightness value. Typically, 1.0 is the default; values greater than 1.0 increase brightness, and values less than 1.0 decrease it.

VideoEffects_SetContrast(double)

Sets the contrast level of the video.

void VideoEffects_SetContrast(double value)

Parameters

value double

The contrast value. Typically, 1.0 is the default; values greater than 1.0 increase contrast, and values less than 1.0 decrease it.

VideoEffects_SetFlipX(bool)

Toggles a horizontal flip (mirror) effect on the video.

void VideoEffects_SetFlipX(bool value)

Parameters

value bool

If set to true, the video is flipped horizontally.

VideoEffects_SetFlipY(bool)

Toggles a vertical flip effect on the video.

void VideoEffects_SetFlipY(bool value)

Parameters

value bool

If set to true, the video is flipped vertically.

VideoEffects_SetGrayscale(bool)

Toggles the grayscale effect on the video.

void VideoEffects_SetGrayscale(bool value)

Parameters

value bool

If set to true, the video is rendered in grayscale; otherwise, it is rendered in color.

VideoEffects_SetInvert(bool)

Toggles the color inversion effect on the video.

void VideoEffects_SetInvert(bool value)

Parameters

value bool

If set to true, the video colors are inverted (like a photo negative).

VideoEffects_SetSaturation(double)

Sets the color saturation level of the video.

void VideoEffects_SetSaturation(double value)

Parameters

value double

The saturation value. Typically, 1.0 is the default; 0.0 results in a grayscale image, and values greater than 1.0 intensify colors.