Struct PluginImage

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

An image the host holds on a plugin's behalf. The handle is a number that means nothing outside the host that issued it; a plugin keeps it, draws with it and gives it back through Release(PluginImage). The size is carried so the plugin can lay the image out without asking again.

public readonly record struct PluginImage : IEquatable<PluginImage>

Implements

IEquatable<PluginImage>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginImage(int, int, int)

An image the host holds on a plugin's behalf. The handle is a number that means nothing outside the host that issued it; a plugin keeps it, draws with it and gives it back through Release(PluginImage). The size is carried so the plugin can lay the image out without asking again.

public PluginImage(int Handle, int Width, int Height)

Parameters

Handle int

The host's number for this image; 0 means no image.

Width int

The image's width in pixels.

Height int

The image's height in pixels.

Properties

Handle

The host's number for this image; 0 means no image.

public int Handle { get; init; }

Property Value

int

Height

The image's height in pixels.

public int Height { get; init; }

Property Value

int

IsValid

True when the host issued this image and it has not yet been released.

public bool IsValid { get; }

Property Value

bool

None

No image: what every refused request returns.

public static PluginImage None { get; }

Property Value

PluginImage

Width

The image's width in pixels.

public int Width { get; init; }

Property Value

int