Class GLOverlayBlock

Namespace

VisioForge.Core.MediaBlocks.OpenGL

Assembly

VisioForge.Core.dll

OpenGL-accelerated image overlay block for compositing static images and graphics onto video streams. Provides GPU-accelerated overlay capabilities with alpha blending, positioning, scaling, and rotation support for watermarks, logos, graphics overlays, and picture-in-picture compositions with real-time performance. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class GLOverlayBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

GLOverlayBlock

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

MediaBlock._isBuilt

MediaBlock._pipeline

MediaBlock._pipelineCtx

MediaBlock.GetPipelineContext()

MediaBlock.SetPipelineContext(BlockPipelineContext)

MediaBlock.SetPipeline(MediaBlocksPipeline)

MediaBlock.Context

MediaBlock.Name

MediaBlock.IsBuilt

MediaBlock.Owner

MediaBlock.Type

MediaBlock.ID

MediaBlock.Input

MediaBlock.Inputs

MediaBlock.Output

MediaBlock.Outputs

MediaBlock.HasInputs

MediaBlock.HasOutputs

MediaBlock.Build()

MediaBlock.CreateElements()

MediaBlock.AddElementsToPipeline()

MediaBlock.RemoveElementsFromPipeline()

MediaBlock.DeepCopy(string)

MediaBlock.Reset()

MediaBlock.ToYAMLBlock()

MediaBlock.ClearPads()

MediaBlock.Dispose(bool)

MediaBlock.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Extension Methods

MediaBlockExtensions.GetInputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockExtensions.GetOutputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockHelper.SendEndOfStream(MediaBlock)

MediaBlockHelper.SendEvent(MediaBlock, Event)

MediaBlockHelper.SetState(MediaBlock, State)

Constructors

GLOverlayBlock(GLOverlaySettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.OpenGL.GLOverlayBlock class with the specified overlay settings. Creates the necessary input and output pads for video processing with image overlay composition.

public GLOverlayBlock(GLOverlaySettings settings)

Parameters

settings GLOverlaySettings

The overlay settings that define the image source, positioning, and blending parameters.

Properties

Input

Gets the primary input pad for receiving base video frames for overlay composition.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads available on this block (single input for video processing).

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary output pad for providing overlay-composited video frames.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads available on this block (single output for processed video).

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the overlay settings that control image positioning, scaling, alpha blending, and transformation parameters.

public GLOverlaySettings Settings { get; set; }

Property Value

GLOverlaySettings

Type

Gets the media block type identifier for OpenGL overlay operations.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the OpenGL overlay block within the pipeline context. Creates the GStreamer overlay element, configures the overlay settings, and establishes the necessary pad connections for processing video frames with image composition.

public override bool Build()

Returns

bool

true if the overlay block was successfully built and configured; otherwise, false.

CleanUp()

Cleans up all resources associated with the OpenGL overlay operation, including GStreamer elements and GPU compositing resources.

public void CleanUp()

Dispose(bool)

Releases unmanaged and managed resources used by the OpenGL overlay block. Properly disposes of GStreamer elements and GPU compositing resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core GStreamer element wrapper for advanced configuration and monitoring.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper providing access to the underlying GStreamer overlay element.

GetElement()

Gets the native GStreamer element for direct GStreamer pipeline integration.

public Element GetElement()

Returns

Element

The native Gst.Element representing the image overlay compositor.

IsAvailable()

Determines whether OpenGL overlay functionality is available on the current system. Requires OpenGL support and appropriate GStreamer OpenGL compositing plugins to be installed.

public static bool IsAvailable()

Returns

bool

true if overlay composition operations are supported; otherwise, false.

UpdateSettings()

Updates the overlay settings in real-time, allowing dynamic changes to image position, scale, rotation, and alpha blending.

public void UpdateSettings()

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Sets the pipeline context for this OpenGL overlay block, providing access to the parent pipeline and logging context.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The parent MediaBlocks pipeline containing this overlay block.

See Also

MediaBlock

IMediaBlockInternals

IDisposable