struct render::PooledRenderTextureCreateInformation

Structure used for creating a new pooled render texture.

Public

Constructors

PooledRenderTextureCreateInformation

PooledRenderTextureCreateInformation()

Methods

staticCreate2D

static PooledRenderTextureCreateInformation Create2D(PixelFormat format, u32 width, u32 height, TextureUsageFlags usage = TextureUsageFlag::Default, u32 samples = 0, bool hwGamma = false, u32 arraySize = 1, u32 mipCount = 0)

Creates a descriptor for a two dimensional render texture.

format
Pixel format used by the texture surface.
width
Width of the render texture, in pixels.
height
Height of the render texture, in pixels.
usage
Usage flags that control in which way is the texture going to be used.
samples
If higher than 1, texture containing multiple samples per pixel is created.
hwGamma
Should the written pixels be gamma corrected.
arraySize
Number of textures in a texture array. Specify 1 for no array.
mipCount
Number of mip levels, excluding the root mip level.

Returns: Descriptor that is accepted by RenderTexturePool.

staticCreate3D

static PooledRenderTextureCreateInformation Create3D(PixelFormat format, u32 width, u32 height, u32 depth, TextureUsageFlags usage = TextureUsageFlag::Default)

Creates a descriptor for a three dimensional render texture.

format
Pixel format used by the texture surface.
width
Width of the render texture, in pixels.
height
Height of the render texture, in pixels.
depth
Depth of the render texture, in pixels.
usage
Usage flags that control in which way is the texture going to be used.

Returns: Descriptor that is accepted by RenderTexturePool.

staticCreateCube

static PooledRenderTextureCreateInformation CreateCube(PixelFormat format, u32 width, u32 height, TextureUsageFlags usage = TextureUsageFlag::Default, u32 arraySize = 1)

Creates a descriptor for a cube render texture.

format
Pixel format used by the texture surface.
width
Width of the render texture, in pixels.
height
Height of the render texture, in pixels.
usage
Usage flags that control in which way is the texture going to be used.
arraySize
Number of textures in a texture array. Specify 1 for no array.

Returns: Descriptor that is accepted by RenderTexturePool.

Private

Fields

width

u32 width

height

u32 height

depth

u32 depth

numSamples

u32 numSamples

format

flag

TextureUsageFlags flag

type

hwGamma

bool hwGamma

arraySize

u32 arraySize

numMipLevels

u32 numMipLevels