GraphicsAPI reference
Struct TextureDescription
Namespace: MicroEngine.Graphics.Devices
Assembly: MicroEngine.Graphics.dll
Guide: The graphics device
A sampled texture. Texture data uploads go through CreateTexture and UpdateTexture.
public readonly struct TextureDescription : IEquatable<TextureDescription>Implements
IEquatable<TextureDescription>
Constructors
TextureDescription(int, int, TextureFormat, int, AlphaMode, string?)
A sampled texture. Texture data uploads go through CreateTexture and UpdateTexture.
public TextureDescription(int Width, int Height, TextureFormat Format = TextureFormat.Rgba8Unorm, int MipLevels = 1, AlphaMode Alpha = AlphaMode.Premultiplied, string? Name = null)Parameters
Width int
Width in texels, 1..MaxTextureSize.
Height int
Height in texels, 1..MaxTextureSize.
Format TextureFormat
Texel format; must support Sampled.
MipLevels int
Mip levels; more than 1 requires Mipmaps.
Alpha AlphaMode
Whether the data is premultiplied (default) or straight; informational for the device.
Name string?
Debug name.
Properties
Alpha
Whether the data is premultiplied (default) or straight; informational for the device.
public AlphaMode Alpha { get; init; }Property Value
Format
Texel format; must support Sampled.
public TextureFormat Format { get; init; }Property Value
Height
Height in texels, 1..MaxTextureSize.
public int Height { get; init; }Property Value
MipLevels
Mip levels; more than 1 requires Mipmaps.
public int MipLevels { get; init; }Property Value
Name
Debug name.
public string? Name { get; init; }Property Value
Width
Width in texels, 1..MaxTextureSize.
public int Width { get; init; }Property Value
Methods
Deconstruct(out int, out int, out TextureFormat, out int, out AlphaMode, out string?)
public void Deconstruct(out int Width, out int Height, out TextureFormat Format, out int MipLevels, out AlphaMode Alpha, out string? Name)Parameters
Width int
Height int
Format TextureFormat
MipLevels int
Alpha AlphaMode
Name string?
Equals(object)
public override bool Equals(object obj)Parameters
obj object
Returns
Equals(TextureDescription)
public bool Equals(TextureDescription other)Parameters
other TextureDescription
Returns
GetHashCode()
public override int GetHashCode()Returns
ToString()
public override string ToString()Returns
Operators
operator ==(TextureDescription, TextureDescription)
public static bool operator ==(TextureDescription left, TextureDescription right)Parameters
left TextureDescription
right TextureDescription
Returns
operator !=(TextureDescription, TextureDescription)
public static bool operator !=(TextureDescription left, TextureDescription right)Parameters
left TextureDescription
right TextureDescription