Struct TextureDescription

Namespace

Pie

Assembly

Pie.dll

Used to describe how a new Texture should be stored and sampled from.

public struct TextureDescription

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TextureDescription(TextureType, int, int, int, Format, int, int, TextureUsage)

Create a new TextureDescription.

public TextureDescription(TextureType textureType, int width, int height, int depth, Format format, int mipLevels, int arraySize, TextureUsage usage)

Parameters

textureType TextureType

The type of this texture.

width int

The width of this texture.

height int

The height of this texture.

depth int

The depth of this texture.

format Format

The Format of this texture.

mipLevels int

The number of mipmaps this texture will hold.

arraySize int

The size of the texture array in elements.

usage TextureUsage

The TextureUsage of this texture.

Fields

ArraySize

The size of the texture array in elements.

public int ArraySize

Field Value

int

Used to describe how a new should be stored and sampled from.

Depth

The depth of this texture.

public int Depth

Field Value

int

Used to describe how a new should be stored and sampled from.

Format

The Format of this texture.

public Format Format

Field Value

Format

Used to describe how a new should be stored and sampled from.

Height

The height of this texture.

public int Height

Field Value

int

Used to describe how a new should be stored and sampled from.

MipLevels

The number of mipmaps this texture will hold.

public int MipLevels

Field Value

int

Used to describe how a new should be stored and sampled from.

TextureType

The type of this texture.

public TextureType TextureType

Field Value

TextureType

Used to describe how a new should be stored and sampled from.

Usage

The TextureUsage of this texture.

public TextureUsage Usage

Field Value

TextureUsage

Used to describe how a new should be stored and sampled from.

Width

The width of this texture.

public int Width

Field Value

int

Used to describe how a new should be stored and sampled from.

Properties

Validity

Check if this TextureDescription is valid.

public Validity Validity { get; }

Property Value

Validity

Used to describe how a new should be stored and sampled from.

Methods

Cubemap(int, int, Format, int, TextureUsage)

Create a new Cubemap TextureDescription.

public static TextureDescription Cubemap(int width, int height, Format format, int mipLevels, TextureUsage usage)

Parameters

width int

The width of this texture.

height int

The height of this texture.

format Format

The Format of this texture.

mipLevels int

The number of mipmaps this texture will hold.

usage TextureUsage

The TextureUsage of this texture.

Returns

TextureDescription

Used to describe how a new should be stored and sampled from.

Texture1D(int, Format, int, int, TextureUsage)

Create a new 1D TextureDescription.

public static TextureDescription Texture1D(int width, Format format, int mipLevels, int arraySize, TextureUsage usage)

Parameters

width int

The width of this texture.

format Format

The Format of this texture.

mipLevels int

The number of mipmaps this texture will hold.

arraySize int

The size of the texture array in elements.

usage TextureUsage

The TextureUsage of this texture.

Returns

TextureDescription

Used to describe how a new should be stored and sampled from.

Texture2D(int, int, Format, int, int, TextureUsage)

Create a new 2D TextureDescription.

public static TextureDescription Texture2D(int width, int height, Format format, int mipLevels, int arraySize, TextureUsage usage)

Parameters

width int

The width of this texture.

height int

The height of this texture.

format Format

The Format of this texture.

mipLevels int

The number of mipmaps this texture will hold.

arraySize int

The size of the texture array in elements.

usage TextureUsage

The TextureUsage of this texture.

Returns

TextureDescription

Used to describe how a new should be stored and sampled from.

Texture3D(int, int, int, Format, int, TextureUsage)

Create a new 3D TextureDescription.

public static TextureDescription Texture3D(int width, int height, int depth, Format format, int mipLevels, TextureUsage usage)

Parameters

width int

The width of this texture.

height int

The height of this texture.

depth int

The depth of this texture.

format Format

The Format of this texture.

mipLevels int

The number of mipmaps this texture will hold.

usage TextureUsage

The TextureUsage of this texture.

Returns

TextureDescription

Used to describe how a new should be stored and sampled from.