Table of Contents

Class SquareBlock

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

Square distortion effect block that warps the center region into a square shape. This block applies a geometric transformation that distorts a circular area in the center of the image into a square shape, creating a unique warping effect. Features include adjustable size, intensity, and center positioning for the square distortion. Essential for creative visual effects, abstract video art, kaleidoscope-like patterns, and experimental video production requiring geometric shape transformations. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class SquareBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

SquareBlock(SquareVideoEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.SquareBlock class with specified square effect settings.

public SquareBlock(SquareVideoEffect settings)

Parameters

settings SquareVideoEffect

The square effect configuration settings.

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[]

Settings

Gets or sets the square effect settings. Contains parameters for distortion size, intensity, center position, and other properties controlling the square warping transformation.

public SquareVideoEffect Settings { get; set; }

Property Value

SquareVideoEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the square filter and its associated GStreamer elements. This method creates the filter with the specified settings, establishes input and output pads, and prepares the block for applying square shape distortion 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 square distortion 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 square filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer square filter.

GetElement()

Gets the underlying GStreamer element that performs the square distortion.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the square 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 square distortion 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