Table of Contents

Class OverlayManagerBackgroundImage

Namespace
VisioForge.Core.Types.X.VideoEffects
Assembly
VisioForge.Core.dll

Represents a background image for the overlay manager that can be stretched and rendered behind other overlay elements. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

public class OverlayManagerBackgroundImage : IOverlayManagerBackground, IDisposable

Inheritance

Implements

Inherited Members

Constructors

OverlayManagerBackgroundImage(SKBitmap, double)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.OverlayManagerImage class.

public OverlayManagerBackgroundImage(SKBitmap image, double alpha = 1)

Parameters

image SKBitmap

The image.

alpha double

The alpha.

OverlayManagerBackgroundImage(string, double)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.OverlayManagerImage class.

public OverlayManagerBackgroundImage(string filename, double alpha = 1)

Parameters

filename string

The filename.

alpha double

The alpha.

Properties

Alpha

Gets the alpha.

public double Alpha { get; }

Property Value

double

Cache

Gets or sets the cache.

public object Cache { get; set; }

Property Value

object

Enabled

Gets or sets a value indicating whether this VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement is enabled.

public bool Enabled { get; set; }

Property Value

bool

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

StretchMode

Gets or sets the stretch mode.

public OverlayManagerImageStretchMode StretchMode { get; set; }

Property Value

OverlayManagerImageStretchMode

Methods

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

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

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

~OverlayManagerBackgroundImage()

Finalizes an instance of the VisioForge.Core.Types.X.VideoEffects.OverlayManagerBackgroundImage class.

protected ~OverlayManagerBackgroundImage()

GetImage()

Gets the image.

public SKBitmap GetImage()

Returns

SKBitmap

Bitmap.

Update(SKBitmap, double)

Updates the specified image.

public void Update(SKBitmap image, double alpha = 1)

Parameters

image SKBitmap

The image.

alpha double

The alpha.

Update(string, double)

Updates the specified filename.

public void Update(string filename, double alpha = 1)

Parameters

filename string

The filename.

alpha double

The alpha.

See Also