TextureSurface Class
Where an entry of a ImageCollectionKind.TextureSurfaces collection is in its texture: the element of the array, the face of the cube map, the mipmap level and the depth slice.
public sealed class TextureSurfaceRemarks
Instances are immutable; this type is thread-safe.
Constructors
| Name | Description |
|---|---|
| TextureSurface(int, CubeMapFace?, int) | Initializes a new instance of the TextureSurface class, for an entry added to a collection of texture surfaces. |
TextureSurface(int, CubeMapFace?, int)
TextureSurface.csInitializes a new instance of the TextureSurface class, for an entry added to a collection of texture surfaces.
public TextureSurface(int arrayIndex = 0, CubeMapFace? face = null, int mipLevel = 0)Parameters
arrayIndexint- The element of the texture array (of the cube map of a cube map array), 0 for a texture that is not an array.
faceCubeMapFace?- The face of a cube map, or
nullwhen the texture is not a cube map. mipLevelint- The mipmap level: 0 is the full-size surface.
Exceptions
ArgumentOutOfRangeException- An index is negative, or
faceis not a definedCubeMapFace.
Properties
| Name | Description |
|---|---|
| ArrayIndex | Gets the index of the element of the texture array (of the cube map of a cube map array), 0 for a texture that is not an array. |
| DepthSlice | Gets the depth slice of a level of a volume texture, 0 for the other textures. |
| Face | Gets the face of a cube map, or null when the texture is not a cube map. |
| MipLevel | Gets the mipmap level: 0 is the full-size surface, and each level halves the dimensions (rounded down, at least 1). |
ArrayIndex
TextureSurface.csDepthSlice
TextureSurface.csGets the face of a cube map, or null when the texture is not a cube map.
public CubeMapFace? Face { get; }Property value
MipLevel
TextureSurface.csMethods
| Name | Description |
|---|---|
| ToString() | Returns a description of the surface, such as array 0, face PositiveX, mip 2, slice 0. |