Struct RawImageSpecification

Describes a raw image.

Assembly: Dalamud.dll

Declaration

public struct RawImageSpecification : IEquatable<RawImageSpecification>

Implements:
System.IEquatable<Dalamud.Interface.Textures.RawImageSpecification>

Properties

Width

Gets or sets the width of the raw image.

Declaration

public int Width { readonly get; set; }

Height

Gets or sets the height of the raw image.

Declaration

public int Height { readonly get; set; }

Pitch

Gets or sets the pitch of the raw image in bytes.

Declaration

public int Pitch { readonly get; set; }

Remarks

The value may not always exactly match [Dalamud.Interface.Textures.RawImageSpecification.Width](../../Dalamud.Interface.Textures/Structs/RawImageSpecification.md#width) * bytesPerPixelFromDxgiFormat.

DxgiFormat

Gets or sets the format of the raw image.

Declaration

public int DxgiFormat { readonly get; set; }

Remarks

See <a href="https://learn.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format"> DXGI_FORMAT</a>.

BitsPerPixel

Gets the number of bits per pixel.

Declaration

public int BitsPerPixel { get; }

Methods

Bgra32(int, int)

Creates a new instance of Dalamud.Interface.Textures.RawImageSpecification record using the given resolution, in B8G8R8A8(BGRA32) UNorm pixel format.

Declaration

public static RawImageSpecification Bgra32(int width, int height)

Returns

Dalamud.Interface.Textures.RawImageSpecification: The new instance.

Parameters

Type	Name	Description
System.Int32	width	The width.
System.Int32	height	The height.

Rgba32(int, int)

Creates a new instance of Dalamud.Interface.Textures.RawImageSpecification record using the given resolution, in R8G8B8A8(RGBA32) UNorm pixel format.

Declaration

public static RawImageSpecification Rgba32(int width, int height)

Returns

Dalamud.Interface.Textures.RawImageSpecification: The new instance.

Parameters

Type	Name	Description
System.Int32	width	The width.
System.Int32	height	The height.

A8(int, int)

Creates a new instance of Dalamud.Interface.Textures.RawImageSpecification record using the given resolution, in A8 UNorm pixel format.

Declaration

public static RawImageSpecification A8(int width, int height)

Returns

Dalamud.Interface.Textures.RawImageSpecification: The new instance.

Parameters

Type	Name	Description
System.Int32	width	The width.
System.Int32	height	The height.

ToString()

Declaration

public override string ToString()

Returns

System.String

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

System.Int32

Equals(object)

Declaration

public override readonly bool Equals(object obj)

Returns

System.Boolean

Parameters

Type	Name
System.Object	obj

Equals(RawImageSpecification)

Declaration

public readonly bool Equals(RawImageSpecification other)

Returns

System.Boolean

Parameters

Type	Name
Dalamud.Interface.Textures.RawImageSpecification	other

Implements

• System.IEquatable<Dalamud.Interface.Textures.RawImageSpecification>