Unigine.Texture Class
Interface for handling textures.
Textures are stored on GPU.
Unigine provides different filtering modes of texture samples:
- Point filtering
- Linear filtering
- Bilinear filtering
- Trilinear filtering
- Anisotropic filtering
They are ordered from the worst visual quality to the best, thus from the least expensive performance cost to the most.
Texture has two sets of flags: sampler and format flags.
Sampler Flags#
Sampler flags can be changed dynamically at runtime for the user materials.
- SAMPLER_WRAP_CLAMP_X
- SAMPLER_WRAP_CLAMP_Y
- SAMPLER_WRAP_CLAMP_Z
- SAMPLER_WRAP_BORDER_X
- SAMPLER_WRAP_BORDER_Y
- SAMPLER_WRAP_BORDER_Z
- SAMPLER_WRAP_BORDER_ONE
- SAMPLER_WRAP_BORDER
- SAMPLER_WRAP_MASK
- SAMPLER_FILTER_POINT
- SAMPLER_FILTER_LINEAR
- SAMPLER_FILTER_BILINEAR
- SAMPLER_FILTER_TRILINEAR
- SAMPLER_FILTER_MASK
- SAMPLER_ANISOTROPY_1
- SAMPLER_ANISOTROPY_2
- SAMPLER_ANISOTROPY_4
- SAMPLER_ANISOTROPY_8
- SAMPLER_ANISOTROPY_16
- SAMPLER_ANISOTROPY_MASK
- SAMPLER_SHADOW_COMPARE
- SAMPLER_SHADOW_MASK
- SAMPLER_DEFAULT_FLAGS
- SAMPLER_FLAGS
Format Flags#
Format flags changes require texture reinitialization to take effect. The format flags are read-only (editable only for the base materials).
- FORMAT_SRGB
- FORMAT_SIGNED
- FORMAT_INTEGER
- FORMAT_MIPMAPS
- FORMAT_MASK
- FORMAT_MULTISAMPLE_2
- FORMAT_MULTISAMPLE_4
- FORMAT_MULTISAMPLE_8
- FORMAT_MULTISAMPLE_16
- FORMAT_MULTISAMPLE_MASK
- FORMAT_USAGE_UNORDERED_ACCESS
- FORMAT_USAGE_RENDER
- FORMAT_USAGE_IMMUTABLE
- FORMAT_USAGE_DYNAMIC
- FORMAT_USAGE_STAGING
- FORMAT_USAGE_SHARED
- FORMAT_USAGE_MASK
- FORMAT_FLAGS
Data Storage (Levels, Layers, Faces)#
A texture's storage contains one or more images with certain dimensions. Each type of texture has a specific arrangement of images in its storage. Textures can have mipmaps - smaller versions of the same image used to help in texture sampling and filtering. Each mipmap level has a separate set of images.
Since a texture stores multiple images, it is important to be able to identify a specific image in a texture. Each image in a texture can be uniquely identified by the following numbers, depending on the texture type:
- For textures that can have mipmaps, the mipmap level that contains the image.
- For Array Textures, the array layer that contains the image.
-
For Cubemap Textures, the face within that array layer and mipmap level.
NoticeFor Cubemap Array Textures, the layer and face are combined into layer-faces.
Therefore, a texture can be thought of as a three-dimensional array of images. The first index is the mipmap level, the second is the array layer, and the third is the cube map face. Another way to think of it is that a texture has a number of mipmap levels. Each mipmap can have a number of array layers. And each array layer has a number of faces. Every image of a texture can therefore be uniquely referenced by the face, layer, and level indices.
Texture Class
Properties
int AllFlags#
int FormatFlags#
The texture format flags.
int SamplerFlags#
The texture sampler flags.
int NumFaces#
The number of faces in the texture.
int NumLayers#
The number of layers in the texture.
int NumMipmaps#
The texture mipmap count.
int NumChannels#
The number of channels.
bool IsDepthFormat#
The value indicating if the texture is depth texture.
bool IsColorFormat#
The value indicating if the texture is color texture.
bool IsCompressedFormat#
The value indicating if the texture is stored in a compressed format (DXT1, DXT3, DXT5, ATI1, ATI2, ZLC1 or ZLC2).
bool IsCombinedFormat#
The value indicating if the texture is stored in a combined format (RGB565, RGBA4, RGB5A1, R24B8, or RGB10A2).
bool IsIntegerFormat#
The value indicating if the texture is stored in an integer format (unsigned char, unsigned short, or unsigned int).
bool IsFloatFormat#
The value indicating if the texture is stored in a float format (R32F, RG32F, RGB32F or RGBA32F).
bool IsHalfFormat#
The value indicating if the texture is stored in a half-float format (R16F, RG16F, RGB16F or RGBA16F).
bool IsUShortFormat#
The value indicating if the texture is stored in an unsigned short format (R16, RG16, RGB16 or RGBA16).
bool IsUCharFormat#
The value indicating if the texture is stored in an unsigned char format (R8, RG8, RGB8, RGBA8, DXT1, DXT3, DXT5, ATI1 or ATI2).
bool IsUIntFormat#
The value indicating if the texture is stored in an unsigned integer format (R32U, RG32U, RGB32U or RGBA32U).
bool IsRawFormat#
The value indicating if the texture is uncompressed (stored in R8, RG8, RGB8, RGBA8, R16, RG16, RGB16, RGBA16, R16F, RG16F, RGB16F, RGBA16F, R32F, RG32F, RGB32F, RGBA32F, RGB565, RGBA4, RGB5A1, RGB10A2, R24B8, D16, D24, D24S8, D32F, or D32FS8 format).
int ImageFormat#
The image format corresponding to the current texture format.
string FormatName#
The texture format name.
int Format#
The texture format.
bool IsArrayType#
The value indicating if the texture is array texture.
bool IsCubeType#
The value indicating if the texture is cube texture.
bool Is3DType#
The value indicating if the texture is a 3D texture.
bool Is2DType#
The value indicating if the texture is a 2D texture.
string TypeName#
The texture type name.
int Type#
The texture type.
string DebugName#
The friendly name for GPU debugging (RenderDoc, NVIDIA Nsight). It can be used to help you determine if the corresponding object interface pointer caused the leak. Memory leaks are reported by the debug software layer by outputting a list of object interface pointers along with their friendly names.
bool Ownership#
The ownership flag that defines if the texture is to be automatically managed by the Engine. If the flag is set the Engine takes care of the texture as if it was created by the Engine, otherwise the user should manage the texture manually (destroy the object, do all necessary memory cleanup).
bool IsUsageShared#
The value indicating if the texture has the FORMAT_USAGE_SHARED flag enabled.
bool IsUsageStaging#
The value indicating if the texture has the FORMAT_USAGE_STAGING flag enabled.
bool IsUsageDynamic#
The value indicating if the texture has the FORMAT_USAGE_DYNAMIC flag enabled.
bool IsUsageImmutable#
The value indicating if the texture has the FORMAT_USAGE_IMMUTABLE flag enabled.
bool IsUsageRender#
The value indicating if the texture has the FORMAT_USAGE_RENDER flag enabled.
bool IsUsageUnorderedAccess#
The value indicating if the texture has the FORMAT_USAGE_UNORDERED_ACCESS flag enabled.
uint VideoMemoryUsage#
The amount of memory occupied by the texture.
Members
bool IsAnisotropy ( ) #
Checks texture anisotropy.Return value
1 if the texture filter is anisotropy, otherwise, 0.bool IsValid ( ) #
Returns a value indicating if the texture is valid (null-pointer check).Return value
true if the texture is valid; otherwise, false.IntPtr GetD3D11DepthStencilView ( ) #
Returns Direct3D11 depth stencil view.IntPtr GetD3D11DepthStencilView ( int index ) #
Returns Direct3D11 depth stencil view.Arguments
- int index - Index.
IntPtr GetD3D11RenderTargetView ( int index ) #
Returns Direct3D11 render target view.Arguments
- int index - Index.
IntPtr GetD3D11RenderTargetView ( ) #
Returns Direct3D11 render target view.IntPtr GetD3D11ShaderResourceView ( ) #
Returns Direct3D11 render target view.IntPtr GetD3D11Texture ( ) #
Returns Direct3D11 texture.IntPtr GetD3D11UnorderedAccessView ( int r32_typeless ) #
Returns Direct3D11 render target view.Arguments
- int r32_typeless
int GetDepth ( int level = 0 ) #
Returns the depth for the given texture mipmap level.Arguments
- int level - Mipmap level number in the range from 0 to the total number of mipmaps.
Return value
Texture mipmap level depth.int GetHeight ( int level = 0 ) #
Returns the height for the specified texture mipmap level.Arguments
- int level - Mipmap level number in the range from 0 to the total number of mipmaps.
Return value
Texture mipmap level height.bool SetImage ( Image image ) #
Sets texture data using the data of the specified source image.Notice
In DX11, when setting the image, the source formats listed below are converted as follows:
- RGB565 -> RGBA8
- RGBA4 -> RGBA8
- RGB5A1 -> RGBA8
- RGB8 -> RGBA8
- RGB16 -> RGBA16
- RGB16U -> RGBA16U
- RGB16F -> RGBA16F
- RGB32F -> RGBA32F
Arguments
- Image image - Source image to be used for setting texture data.
Return value
1 if the data was set successfully; otherwise, 0.bool SetImage2D ( Image image, int offset_x, int offset_y, int texture_format = -1 ) #
Sets texture data using the data of the specified 2D or 2D array image.Notice
The following conditions must be satisfied:
- Both texture and image types must be either 2D or 2D_ARRAY.
- Texture resolution must be greater or equal to the image resolution.
- Image and texture mipmap counts must be equal (the same is for layer counts of 2D arrays).
Arguments
- Image image - Source image to be used for setting texture data.
- int offset_x - Offset along the X axis (in pixels) starting from which the data of the specified image is to be taken. The following condition must be satisfied: offset_x < texture_width - image_width.
- int offset_y - Offset along the Y axis (in pixels) starting from which the data of the specified image is to be taken. The following condition must be satisfied: offset_y < texture_height - image_height.
- int texture_format - Texture format identifier (see the FORMAT_* variables), or -1 - auto-detect.
Return value
1 if the data was set successfully; otherwise, 0.bool SetImageLayer ( Image image, int layer, int texture_format = -1 ) #
Sets the data of the specified layer of the 2D texture array using the data of the specified 2D image.Notice
The following conditions must be satisfied:
- Texture and image must have the same resolution.
- Image and texture mipmap counts must be equal (the same is for layer counts of 2D arrays).
Arguments
- Image image - Source image to be used for setting the data of the 2D texture array layer.
- int layer - Number of the 2D texture array layer, for which the data is to be set.
- int texture_format - Texture format identifier (see the FORMAT_* variables), or -1 - auto-detect.
Return value
1 if the data was set successfully; otherwise, 0.bool GetMultisample ( ) #
Returns the multisample count.Return value
Multisample count.int GetWidth ( int level = 0 ) #
Returns the width for the specified texture mipmap level.Arguments
- int level - Mipmap level number in the range from 0 to the total number of mipmaps.
Return value
Texture mipmap level width.void Clear ( ) #
Clears texture.bool Copy2D ( int dest_x = 0, int dest_y = 0, int src_x = 0, int src_y = 0, int w = -1, int h = -1 ) #
Copies 2D texture.Arguments
- int dest_x - The offset of the source texture along the X-axis.
- int dest_y - The offset of the source texture along the Y-axis.
- int src_x - The offset of the destination texture along the X-axis.
- int src_y - The offset of the destination texture along the Y-axis.
- int w - The width of the destination texture.
- int h - The height of the destination texture.
Return value
1 if the texture was copied; otherwise, 0.bool CopyCube ( int face, int dest_x = 0, int dest_y = 0, int src_x = 0, int src_y = 0, int w = -1, int h = -1 ) #
Copies Cube texture.Arguments
- int face - The face of the cube.
- int dest_x - The offset of the source texture along the X-axis.
- int dest_y - The offset of the source texture along the Y-axis.
- int src_x - The offset of the destination texture along the X-axis.
- int src_y - The offset of the destination texture along the Y-axis.
- int w - The width of the destination texture.
- int h - The height of the destination texture.
Return value
1 if the texture was copied; otherwise, 0.Texture Texture ( ) #
Texture constructor.Return value
Pointer to the created texture.bool Create ( Image image, int flags = SAMPLER_FILTER_LINEAR ) #
Texture constructor.Arguments
- Image image - Image pointer.
- int flags - Texture flags.
Return value
1 if the texture was created successfully; otherwise, 0.bool Create2D ( int width, int height, int format, int flags = SAMPLER_FILTER_LINEAR ) #
Creates 2D texture.Arguments
- int width - Texture width.
- int height - Texture height.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the texture was created successfully; otherwise, 0.bool Create2DArray ( int width, int height, int num_layers, int format, int flags = SAMPLER_FILTER_LINEAR ) #
Creates 2D Array texture.Arguments
- int width - Texture width.
- int height - Texture height.
- int num_layers - Texture layers.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the 2D array texture was created; otherwise, 0.bool Create3D ( int width, int height, int depth, int format, int flags = SAMPLER_FILTER_LINEAR ) #
Creates 3D texture.Arguments
- int width - Texture width.
- int height - Texture height.
- int depth - Texture depth.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the 3D texture was created; otherwise, 0.bool CreateCube ( int width, int height, int format, int flags = SAMPLER_FILTER_LINEAR ) #
Creates Cube texture.Arguments
- int width - Texture width.
- int height - Texture height.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the cubemap texture was created; otherwise, 0.bool CreateCubeArray ( int width, int height, int num_layers, int format, int flags = SAMPLER_FILTER_LINEAR ) #
Creates Cube Array texture.Arguments
- int width - Texture width.
- int height - Texture height.
- int num_layers - Texture layers.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the cubemap texture array was created; otherwise, 0.bool CreateMipmaps ( ) #
Creates mipmaps stack.Return value
1 if the mipmaps stack was created; otherwise, 0.void Destroy ( ) #
Destroys texture.int FromD3D11Texture2D ( IntPtr ptr, int width, int height, int format, int internal_format, int flags ) #
Creates 2D texture from external D3D11Texture pointer.Arguments
- IntPtr ptr - Pointer to the D3D11 texture.
- int width - Texture width.
- int height - Texture height.
- int format - Texture format.
- int internal_format - Internal texture format.
- int flags - Texture flags.
Return value
1 if the 2D texture from D3D11 was created; otherwise, 0.int FromD3D11Texture2D ( IntPtr ptr, int width, int height, int format, int flags ) #
Creates 2D texture from external D3D11Texture pointer.Arguments
- IntPtr ptr - Pointer to the D3D11 texture.
- int width - Texture width.
- int height - Texture height.
- int format - Texture format.
- int flags - Texture flags.
Return value
1 if the 2D texture from D3D11 was created; otherwise, 0.bool Load ( string name, int flags = SAMPLER_FILTER_LINEAR ) #
Loads texture from file.Arguments
- string name - File name.
- int flags - Texture flags.
Return value
1 if the texture was loaded; otherwise, 0.void Render2D ( float x0 = -1.0f, float y0 = -1.0f, float x1 = 1.0f, float y1 = 1.0f ) #
Renders 2D texture. This function creates 4 vertices (2 polygons) by using 2 X-coordinates and 2 Y-coordinates and sends it to be rendered.Arguments
- float x0 - The first X-coordinate.
- float y0 - The first Y-coordinate.
- float x1 - The second X-coordinate.
- float y1 - The second Y-coordinate.
void Render2DArray ( int layer, float x0 = -1.0f, float y0 = -1.0f, float x1 = 1.0f, float y1 = 1.0f ) #
Renders 2D Array texture. This function creates 4 vertices (2 polygons) of the texture layer by using 2 X-coordinates and 2 Y-coordinates and sends it to be rendered.Arguments
- int layer - The number of layer.
- float x0 - The first X-coordinate.
- float y0 - The first Y-coordinate.
- float x1 - The second X-coordinate.
- float y1 - The second Y-coordinate.
void Render2DScreen ( float x0 = -1.0f, float y0 = -1.0f, float x1 = 1.0f, float y1 = 1.0f ) #
Renders 2D Screen texture. This function creates 3 vertices (1 polygon) and and sends texture to be rendered inside the polygon to avoid artifacts on the edge of 2 polygons if the anti-aliasing is used.Arguments
- float x0 - The first X-coordinate.
- float y0 - The first Y-coordinate.
- float x1 - The second X-coordinate.
- float y1 - The second Y-coordinate.
void RenderCube ( int face, float x0 = -1.0f, float y0 = -1.0f, float x1 = 1.0f, float y1 = 1.0f ) #
Renders Cube texture. This function creates 4 vertices (2 polygons) of the given face of the cube texture by using 2 X-coordinates and 2 Y-coordinates and sends it to be rendered.Arguments
- int face - The face of the cube.
- float x0 - The first X-coordinate.
- float y0 - The first Y-coordinate.
- float x1 - The second X-coordinate.
- float y1 - The second Y-coordinate.
void RenderCubeArray ( int face, int layer, float x0 = -1.0f, float y0 = -1.0f, float x1 = 1.0f, float y1 = 1.0f ) #
Renders Cube Array texture. This function creates 4 vertices (2 polygons) of the given face of the cube texture layer by using 2 X-coordinates and 2 Y-coordinates and sends it to be rendered.Arguments
- int face - The face of the cube.
- int layer - The layer number.
- float x0 - The first X-coordinate.
- float y0 - The first Y-coordinate.
- float x1 - The second X-coordinate.
- float y1 - The second Y-coordinate.
int FormatImageToTexture ( int image_format, int flags ) #
Returns the texture format corresponding to the specified image format.Arguments
- int image_format - Image format identifier (see the FORMAT_* variables) or 0 if the specified texture format is unknown.
- int flags - Unsigned format flag. 1 to interpret integer image format as unsigned, 0 - as signed.
Return value
Texture format identifier (see the FORMAT_* variables) or 0 if the specified image format is unknown.int FormatTextureToImage ( int texture_format ) #
Returns the image format corresponding to the specified texture format.Arguments
- int texture_format - Texture format identifier (see the FORMAT_* variables).
Return value
Image format identifier (see the FORMAT_* variables) or 0 if the specified texture format is unknown.int TypeTextureToImage ( int texture_type ) #
Returns the image type corresponding to the specified texture type.Arguments
- int texture_type - Texture type identifier (see the TEXTURE_* variables).
Return value
Image type identifier (see the IMAGE_* variables) or 0 if the specified texture type is unknown.void ClearBuffer ( ) #
Clears all levels of the texture image (fills all its elements with 0-values).void ClearBuffer ( vec4 color ) #
Clears all levels of the texture image (fills all its elements with the clecified color values).Arguments
- vec4 color - Color to be used to fill the buffer.
void Swap ( Texture texture ) #
Swaps the data of the current texture with the source texture.Arguments
- Texture texture - Source texture.
bool Copy ( Texture src ) #
Copies the data of the source texture to the texture.Arguments
- Texture src - Source texture.
Return value
1 if the data of the source texture is copied successfully; otherwise, 0.uint GetVideoMemoryUsage ( int width, int height, int format, int num_mipmaps, int flags, int num_faces, int num_layers, int depth ) #
Returns the amount of memory occupied by a texture with the specified parameters.Arguments
- int width - Texture width, in pixels.
- int height - Texture height, in pixels.
- int format - Texture format.
- int num_mipmaps - Number of mipmaps in the texture.
- int flags - Texture flags.
- int num_faces - Number of faces in the texture.
- int num_layers - Number of layers in the texture.
- int depth - Texture depth.
Return value
Texture size, in bytes.bool CopyRegion ( Texture src, ivec3 src_coords, int src_level, ivec3 dest_coords, int dest_level, int width, int height, int depth ) #
Copies the specified region from the source texture.Arguments
- Texture src - Source texture from which the data is to be copied.
- ivec3 src_coords - Coordinates in the source texture starting from which the region's data is to be taken.
- int src_level - Source texture mipmap level number in the range from 0 to the total number of mipmaps.
- ivec3 dest_coords - Coordinates in the texture starting from which the data from the source texture is to be pasted.
- int dest_level - Target mipmap level number in the range from 0 to the total number of mipmaps.
- int width - Width of the region to be copied, in pixels.
- int height - Height of the region to be copied, in pixels.
- int depth - Depth of the region to be copied, in pixels.
Return value
true if the specified region was successfully copied from the source to the destination; otherwise, false.bool SetBlob ( Blob blob ) #
Sets texture data from the specified source blob.Arguments
- Blob blob - Source blob containing texture data.
Return value
true if the data was set successfully; otherwise, false.string GetTypeName ( int type ) #
Returns the texture type name by its type index.Arguments
- int type - Texture type index.
Return value
Texture type name.ResourceExternalMemory GetResourceExternalMemory ( ) #
Returns the resource in video memory. If the FORMAT_USAGE_SHARED flag is not enabled for the resource, this method returns NULL.Return value
The resource in video memory. If the FORMAT_USAGE_SHARED flag is not enabled for the resource, this method returns NULL.Last update:
2024-07-12
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)