ImageDescription Struct

    Namespace: Stride.Graphics
    Assembly: Stride.dll

    A description for Image.

    [DataContract]
public struct ImageDescription : IEquatable<ImageDescription>
    Name Description
    Fields
    ArraySize

    Number of textures in the array. The range is from 1 to (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.
    Depth

    Texture depth (in texels). The range is from 1 to (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.
    Dimension

    The dimension of a texture.
    Format

    Texture format (see ).
    Height

    Texture height (in texels). The range is from 1 to (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.
    MipLevels

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

    Texture width (in texels). The range is from 1 to (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.
    Methods
    Equals(ImageDescription)
    Equals(Object)
    GetHashCode()
    ToString()
    Operators
    Equality(ImageDescription, ImageDescription)
    Inequality(ImageDescription, ImageDescription)
    | Improve this Doc View Source

    Fields

    ArraySize

    Number of textures in the array. The range is from 1 to (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
    Type Description
    System.Int32
    Remarks

    This field is only valid for , and

    Depth

    Texture depth (in texels). The range is from 1 to (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
    Type Description
    System.Int32
    Remarks

    This field is only valid for .

    Dimension

    The dimension of a texture.

    public TextureDimension Dimension
    Field Value
    Type Description
    TextureDimension

    Format

    Texture format (see ).

    public PixelFormat Format
    Field Value
    Type Description
    PixelFormat

    Height

    Texture height (in texels). The range is from 1 to (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
    Type Description
    System.Int32
    Remarks

    This field is only valid for , and .

    MipLevels

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

    public int MipLevels
    Field Value
    Type Description
    System.Int32

    Width

    Texture width (in texels). The range is from 1 to (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
    Type Description
    System.Int32
    Remarks

    This field is valid for all textures: , , and .

    | Improve this Doc View Source

    Methods

    Equals(ImageDescription)

    public bool Equals(ImageDescription other)
    Parameters
    Type Name Description
    ImageDescription other
    Returns
    Type Description
    System.Boolean

    Equals(Object)

    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    GetHashCode()

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    ToString()

    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.ValueType.ToString()
    | Improve this Doc View Source

    Operators

    Equality(ImageDescription, ImageDescription)

    public static bool operator ==(ImageDescription left, ImageDescription right)
    Parameters
    Type Name Description
    ImageDescription left
    ImageDescription right
    Returns
    Type Description
    System.Boolean

    Inequality(ImageDescription, ImageDescription)

    public static bool operator !=(ImageDescription left, ImageDescription right)
    Parameters
    Type Name Description
    ImageDescription left
    ImageDescription right
    Returns
    Type Description
    System.Boolean

    Extension Methods