Skip to content

Struct ImageDescription

Namespace: Apogee.Graphics
Assembly: Apogee.Graphics.dll

What an image is: format, size, mip chain, layers and what it will be used for.

public readonly record struct ImageDescription : IEquatable<ImageDescription>

Implements

IEquatable<ImageDescription>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

ImageDescription(PixelFormat, uint, uint, ImageUsage, uint, uint, uint, bool, SampleCount)

What an image is: format, size, mip chain, layers and what it will be used for.

public ImageDescription(PixelFormat Format, uint Width, uint Height, ImageUsage Usage, uint MipLevels = 1, uint ArrayLayers = 1, uint Depth = 1, bool Cube = false, SampleCount Samples = SampleCount.Count1)

Parameters

Format PixelFormat

Width uint

Height uint

Usage ImageUsage

MipLevels uint

ArrayLayers uint

Depth uint

Cube bool

Samples SampleCount

Properties

ArrayLayers

public uint ArrayLayers { get; init; }

Property Value

uint

Cube

public bool Cube { get; init; }

Property Value

bool

Depth

public uint Depth { get; init; }

Property Value

uint

Format

public PixelFormat Format { get; init; }

Property Value

PixelFormat

Height

public uint Height { get; init; }

Property Value

uint

MipLevels

public uint MipLevels { get; init; }

Property Value

uint

Samples

public SampleCount Samples { get; init; }

Property Value

SampleCount

Usage

public ImageUsage Usage { get; init; }

Property Value

ImageUsage

Width

public uint Width { get; init; }

Property Value

uint

Methods

FullMipCount(uint, uint)

The number of mip levels down to 1x1 for this size.

public static uint FullMipCount(uint width, uint height)

Parameters

width uint

height uint

Returns

uint