Class VideoRendererSettingsX

Namespace

VisioForge.Core.Types.X

Assembly

VisioForge.Core.dll

Represents settings for configuring the behavior of a video renderer within the VisioForge X engine. These settings control aspects like aspect ratio preservation and video conversion.

public class VideoRendererSettingsX

Inheritance

object

VideoRendererSettingsX

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Examples

// Create new video renderer settings.
var rendererSettings = new VideoRendererSettingsX
{
    Letterbox = true, // Enable letterboxing to preserve aspect ratio
    DisableVideoConverter = false // Allow the internal video converter to operate
};

// Apply these settings to a video renderer (conceptual).
// videoRenderer.Settings = rendererSettings;

// You can also modify settings dynamically.
// videoRenderer.Settings.Letterbox = false; // Disable letterboxing to stretch video

Remarks

Proper configuration of these settings is important for optimizing video display quality and performance.

Properties

DisableVideoConverter

Gets or sets a value indicating whether the internal video converter should be disabled. Setting this to true can prevent automatic format conversions, which might be useful for specific scenarios or debugging, but could lead to compatibility issues if the source format is not directly supported by the renderer. The default value is false.

public bool DisableVideoConverter { get; set; }

Property Value

bool

Letterbox

Gets or sets a value indicating whether letterbox mode is enabled. When true, the video's aspect ratio is preserved by adding black bars if necessary. When false, the video may be stretched to fill the display area. The default value is true.

public bool Letterbox { get; set; }

Property Value

bool