Struct ImageDescription

Namespace

Stride.Graphics

Assembly

Stride.dll

A description for Image.

[DataContract]
public struct ImageDescription : IEquatable<ImageDescription>

Implements

IEquatable<ImageDescription>

Fields

ArraySize

Number of textures in the array. The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DArraySize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

public int ArraySize

Field Value

int

Remarks

This field is only valid for Texture1D, Texture2D and TextureCube

Depth

Texture depth (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

public int Depth

Field Value

int

Remarks

This field is only valid for Texture3D.

Dimension

The dimension of a texture.

public TextureDimension Dimension

Field Value

TextureDimension

Format

Texture format (see SharpDX.DXGI.Format).

public PixelFormat Format

Field Value

PixelFormat

Height

Texture height (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

public int Height

Field Value

int

Remarks

This field is only valid for Texture2D, Texture3D and TextureCube.

MipLevels

The maximum number of mipmap levels in the texture. See the remarks in SharpDX.Direct3D11.ShaderResourceViewDescription.Texture1DResource. Use 1 for a multisampled texture; or 0 to generate a full set of subtextures.

public int MipLevels

Field Value

int

Width

Texture width (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DSize (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

public int Width

Field Value

int

Remarks

This field is valid for all textures: Texture1D, Texture2D, Texture3D and TextureCube.

Methods

Equals(ImageDescription)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ImageDescription other)

Parameters

other ImageDescription

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(ImageDescription, ImageDescription)

public static bool operator ==(ImageDescription left, ImageDescription right)

Parameters

left ImageDescription

right ImageDescription

Returns

bool

operator !=(ImageDescription, ImageDescription)

public static bool operator !=(ImageDescription left, ImageDescription right)

Parameters

left ImageDescription

right ImageDescription

Returns

bool