Table of Contents

Class SphereBlock

Namespace
VisioForge.Core.MediaBlocks.VideoProcessing
Assembly
VisioForge.Core.dll

Video sphere distortion effect block that creates curved spherical lens projection. This block applies spherical geometric distortion to video content, simulating the effect of viewing the image through a spherical lens or bubble. Features configurable refraction index, radius control, and center point positioning for realistic optical effects. Essential for creative video production, optical simulation, VR content preparation, and artistic effects requiring curved spatial transformations. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class SphereBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

SphereBlock(double)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.SphereBlock class with the specified refraction index.

public SphereBlock(double refraction = 1.5)

Parameters

refraction double

The refraction index for spherical distortion (default: 1.5).

Properties

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Refraction

Gets or sets the refraction index for the spherical distortion. Higher values create stronger spherical curvature effects, simulating different optical materials and lens characteristics.

public double Refraction { get; set; }

Property Value

double

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the sphere filter and its associated GStreamer elements. This method creates the filter with the specified refraction index, establishes input and output pads, and prepares the block for applying curved spherical lens projection to video content.

public override bool Build()

Returns

bool

true if the filter was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this sphere effect block. This method disposes of the GStreamer elements and resets the build state.

public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed 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 BaseElement wrapper that provides additional functionality around the GStreamer sphere filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer sphere filter.

GetElement()

Gets the underlying GStreamer element that performs the spherical distortion.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the sphere filter.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

public static bool IsAvailable()

Returns

bool

true if this media block is available; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this sphere effect block with a pipeline and initializes its internal context. This method is called internally when the block is added to a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also