ITextureCube

Description

interface Tinman.Engine.Rendering.ITextureCube

Derived from

ITexture

Extended by

TextureCube abstract

Base interface for cubemap texture resources for rendering.

The following table shows the orientation of the cubemap faces:

Face |  U |  V |
-----+----+----+
NegX | +z | -y |
PosX | -z | -y |
NegY | +x | -z |
PosY | +x | +z |
NegZ | -x | -y |
PosZ | +x | -y |

The U and V columns depict the direction of the U- and V-axis of the respective cubemap face texture (see ITexture2D), in 3D texture coordinate space.

Public / Methods

Set​Texels

public method SetTexels → (4)

source in : TexelBuffer

[not-null]
The source buffer that holds the texel data.

targetFace in : CubemapFace

The target cubemap face.

targetX opt : int32 = 0

[0..ITextureCube.Size-source.Width]
X-coordinate of top-left target texel.

targetY opt : int32 = 0

[0..ITextureCube.Size-source.Height]
Y-coordinate of top-left target texel.

Updates a rectangular region of this texture with GpuUpdateFlag.Discard semantic.

The given target coordinates must be a multiple of the block size of the texture format (see TextureFormat.BlockSize).

Public / Attributes

Size

[Constant]
public attribute Size → (get)

value : int32

The cubemap size, in texels.

The texture cubemap size, in texels.

Extensions

Set​Texels

public static method SetTexels → (5)

source in : ColorBuffer

[not-null]
The source buffer that holds the texel data.

targetFace in : CubemapFace

The target cubemap face, CubemapFace.All for all faces, or CubemapFace.None for no faces.

targetX opt : int32 = 0

[>=0]
X-coordinate of top-left target texel.

targetY opt : int32 = 0

[>=0]
Y-coordinate of top-left target texel.

srgb opt : bool = true

The sRGB flag, see ISrgb.Srgb.

Copies a region of pixels from the given buffer to this texture data object, encoding them as necessary.

This method encodes the pixels and then sets the texel data by calling ITextureCube.SetTexels.