UUSL Textures

Implementation of the API-dependent functions#

The implementation of the API-dependent functions is available in the corresponding header files for your reference:

core/materials/shaders/api/wrapper/opengl.h
core/materials/shaders/api/wrapper/directx11.h

Methods:

Name	Description View: Sort by:
INIT_TEXTURE	Initializes a sampler with the 2D texture.
INIT_TEXTURE_INT	Initializes a sampler with the 2D texture of int type.
INIT_TEXTURE_UINT	Initializes a sampler with the 2D texture of uint type.
INIT_TEXTURE_CUBE	Initializes a sampler with the cubemap texture.
INIT_TEXTURE_MSAA	Initializes a sampler with the multi-sampled texture.
INIT_TEXTURE_3D	Initializes a sampler with the texture3D.
INIT_TEXTURE_ARRAY	Initializes a sampler with the array of 2D textures.
INIT_TEXTURE_ARRAY_INT2	Initializes a sampler with the array of 2D textures of int2 type.
INIT_TEXTURE_ARRAY_UINT2	Initializes a sampler with the array of 2D textures of uint2 type.
INIT_W_TEXTURE	Initializes input 2D write texture.
INIT_W_TEXTURE_INT	Initializes input 2D write int texture.
INIT_W_TEXTURE_3D	Initializes input 3D write texture.
INIT_RW_TEXTURE_R32U	Initializes a 2D input read-write texture that has R32U format type.
INIT_RW_TEXTURE_R32F	Initializes a 2D input read-write texture that has R32F format type.
INIT_RW_TEXTURE_RGBA8	Initializes a 2D input read-write texture that has RGBA8 format type.
INIT_RW_TEXTURE_R32U_3D	Initializes a 3D input read-write texture that has R32U format type.
INIT_RW_TEXTURE_R32F_3D	Initializes a 3D input read-write texture that has R32F format type.
INIT_RW_TEXTURE_RGBA8_3D	Initializes a 3D input read-write texture that has RGBA8 format type.
INIT_RW_STRUCTURED_BUFFER	Initializes a read-write structured buffer.
INIT_STRUCTURED_BUFFER	Initializes a structure buffer.
TEXTURE_2D_MANUAL_LINEAR	Returns a linearly interpolated value of the specified 2D texture.
TEXTURE_2D_GATHER_MANUAL_LINEAR	Returns a linearly interpolated value of four samples (Red channel only) surrounding the specified UV of the 2D texture.
TEXTURE_2D_ARRAY_MANUAL_LINEAR	Returns a linearly interpolated value of the specified texture in the Texture 2D array.
texture_2d_cubic_filter	Returns calculated weights for the bicubic interpolation.
TEXTURE_2D_CUBIC	Returns the bicubically interpolated value of the specified 2D texture.
TEXTURE_2D_ARRAY_CUBIC	Returns the bicubically interpolated value of the specified 2D texture in the 2D texture array.
TEXTURE_2D_CATMULL	Returns the Catmull interpolated value of the specified 2D texture.
TEXTURE_2D_ARRAY_CATMULL	Returns the Catmull interpolated value of the specified 2D texture in the 2D texture array.
TEXTURE_3D_CUBIC	Returns the cubically interpolated value of the specified 3D texture.
TEXTURE	Samples a texture.
TEXTURE_BIAS	Samples a texture using a mipmap-level offset (performs a texture lookup with explicit level-of-detail).
TEXTURE_OFFSET_BIAS	Samples a texture using a mipmap-level offset.
TEXTURE_BIAS_ZERO	Samples a texture using a mipmap-level offset on mipmap level 0 only.
TEXTURE_OFFSET	Samples a texture using a offset on mipmap level 0 only (performs a texture lookup with offset).
TEXTURE_GRAD	Samples a texture using a gradient to influence the way the sample location is calculated.
TEXTURE_MIP_OFFSET	Samples a texture using a negative mipmap offset.
TEXTURE_FETCH	Reads texel data from the first level-of-detail without any filtering or sampling.
TEXTURE_FETCH_LOD	Reads texel data without any filtering or sampling.
TEXTURE_ARRAY	Samples a texture array using a mipmap-level.
TEXTURE_ARRAY_FETCH	Reads texel data from a texture array from the first level-of-detail without any filtering or sampling.
TEXTURE_ARRAY_FETCH_LOD	Reads texel data from a texture array without any filtering or sampling.
TEXTURE_ARRAY_LOAD	Reads texel data without any filtering or sampling with zero offset.
TEXTURE_ARRAY_LOAD_LOD	Reads texel data without any filtering or sampling.
TEXTURE_LOAD	Reads texel data without any filtering or sampling with zero offset.
TEXTURE_LOAD_LOD	Reads texel data without any filtering or sampling.
TEXTURE_3D_FETCH	Reads texel data from a texture array from the first level-of-detail without any filtering or sampling.
TEXTURE_3D_FETCH_LOD	Reads texel data from a texture array without any filtering or sampling.
TEXTURE_3D_LOAD	Reads texel data of a 3D texture without any filtering or sampling with zero offset.
TEXTURE_3D_LOAD_LOD	Reads texel data of a single level of detail of a 3D texture without any filtering or sampling.
TEXTURE_RW_LOAD_RGBA8	Reads the RW RGBA8 texture and returns a float4 value.
TEXTURE_RW_LOAD_R32U	Reads the RW R32U texture and returns a uint value.
TEXTURE_RW_LOAD_R32F	Reads the RW R32F texture and returns a float value.
TEXTURE_RW_STORE_RGBA8	Stores the value to RW RGBA8 texture.
TEXTURE_RW_STORE_R32U	Stores the value to RW R32U texture.
TEXTURE_RW_STORE_R32F	Stores the value to RW R32F texture.
TEXTURE_W_STORE	Stores the value to W texture.
TEXTURE_OUT	Allows to pass a texture to function.
TEXTURE_OUT_2	Allows to pass two textures to a function.
TEXTURE_OUT_3	Allows to pass three textures to a function.
TEXTURE_OUT_4	Allows to pass four textures to a function.
TEXTURE_IN	Specifies the 2D texture for passing to function.
TEXTURE_IN_2	Specifies two 2D textures for passing to function.
TEXTURE_IN_3	Specifies three 2D textures for passing to function.
TEXTURE_IN_4	Specifies four 2D textures for passing to function.
TEXTURE_IN_CUBE	Specifies the cube texture for passing to function.
TEXTURE_IN_3D	Specifies the 3D texture for passing to function.
TEXTURE_IN_ARRAY	Specifies the texture array for passing to function.
TEXTURE_IN_ARRAY_INT2	Specifies the int2 texture array for passing to function.
textureResolution	Returns the texture resolution.
textureIResolution	Returns 1/(texture resolution).

Texture Initialization Functions#

Notice

The implementation of the SAMPLER(NUM) function in Direct3D is the following:

Direct3D

SamplerState s_sampler_ ## NAME : register(s ## NUM);
SamplerComparisonState s_sampler_compare_ ## NAME : register(s ## NUM);

INIT_TEXTURE ( value NUM, value NAME ) #

Initializes a sampler with the 2D texture.

Equivalents

OpenGL

layout(binding=NUM) uniform sampler2D s_texture_ ## NAME;

Direct3D

Texture2D s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_INT ( value NUM, value NAME ) #

Initializes a sampler with the 2D texture of int type.

Equivalents

OpenGL

layout(binding=NUM) uniform usampler2D s_texture_ ## NAME;

Direct3D

Texture2D<int> s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_UINT ( value NUM, value NAME ) #

Initializes a sampler with the 2D texture of uint type.

Equivalents

OpenGL

layout(binding=NUM) uniform isampler2D s_texture_ ## NAME;

Direct3D

Texture2D<uint> s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_CUBE ( value NUM, value NAME ) #

Initializes a sampler with the cubemap texture.

Equivalents

OpenGL

layout(binding=NUM) uniform samplerCube s_texture_ ## NAME;

Direct3D

TextureCube s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_MSAA ( value NUM, value NAME ) #

Initializes a sampler with the multi-sampled texture.

Equivalents

OpenGL

layout(binding=NUM) uniform sampler2DMS s_texture_ ## NAME;

Direct3D

Texture2DMS<float4> s_texture_ ## NAME : register(t ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_3D ( value NUM, value NAME ) #

Initializes a sampler with the texture3D.

Equivalents

OpenGL

layout(binding=NUM) uniform sampler3D s_texture_ ## NAME;

Direct3D

Texture3D s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_ARRAY ( value NUM, value NAME ) #

Initializes a sampler with the array of 2D textures.

Equivalents

OpenGL

layout(binding=NUM) uniform sampler2DArray s_texture_ ## NAME;

Direct3D

Texture2DArray s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_ARRAY_INT2 ( value NUM, value NAME ) #

Initializes a sampler with the array of 2D textures of int2 type.

Equivalents

OpenGL

layout(binding=NUM) uniform isampler2DArray s_texture_ ## NAME;

Direct3D

Texture2DArray<int2> s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_TEXTURE_ARRAY_UINT2 ( value NUM, value NAME ) #

Initializes a sampler with the array of 2D textures of uint2 type.

Equivalents

OpenGL

layout(binding=NUM) uniform usampler2DArray s_texture_ ## NAME;

Direct3D

Texture2DArray<uint2> s_texture_ ## NAME : register(t ## NUM); SAMPLER(NUM,NAME)

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_W_TEXTURE ( value NUM, value NAME, value TYPE, value FORMAT ) #

Initializes input 2D write texture.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(FORMAT) image2D s_rw_texture_ ## NAME;

Direct3D

RWTexture2D<FORMAT> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.
value TYPE - Type of the texture (RGBA8, RGBA32F, etc.).
value FORMAT - Format of the texture (float, float2, float3, float4, int).

INIT_W_TEXTURE_INT ( value NUM, value NAME, value TYPE, value FORMAT ) #

Initializes input 2D write int texture.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(FORMAT) uimage2D s_rw_texture_ ## NAME;

Direct3D

RWTexture2D<FORMAT> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.
value TYPE - Type of the texture (RGBA8, RGBA32F, etc.).
value FORMAT - Format of the texture (float, float2, float3, float4, int).

INIT_W_TEXTURE_3D ( value NUM, value NAME, value TYPE, value FORMAT ) #

Initializes input 3D write texture.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(FORMAT) image3D s_rw_texture_ ## NAME;

Direct3D

RWTexture3D<FORMAT> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.
value TYPE - A type of the texture (rgba8,rgba32f,etc.).
value FORMAT - A format of the texture (float,float2,float3,float4,int).

INIT_RW_TEXTURE_R32U ( value NUM, value NAME ) #

Initializes a 2D input read-write texture that has R32U format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(r32ui) image2D s_rw_texture_ ## NAME;

Direct3D

RWTexture2D<uint> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_TEXTURE_R32F ( value NUM, value NAME ) #

Initializes a 2D input read-write texture that has R32F format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(r32f) image2D s_rw_texture_ ## NAME;

Direct3D

RWTexture2D<float> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_TEXTURE_RGBA8 ( value NUM, value NAME ) #

Initializes a 2D input read-write texture that has RGBA8 format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(rgba8) image2D s_rw_texture_ ## NAME;

Direct3D

RWTexture2D<rgba8> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_TEXTURE_R32U_3D ( value NUM, value NAME ) #

Initializes a 3D input read-write texture that has R32U format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(r32ui) image3D s_rw_texture_ ## NAME;

Direct3D

RWTexture3D<uint> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_TEXTURE_R32F_3D ( value NUM, value NAME ) #

Initializes a 3D input read-write texture that has R32F format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(r32f) image3D s_rw_texture_ ## NAME;

Direct3D

RWTexture3D<float> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_TEXTURE_RGBA8_3D ( value NUM, value NAME ) #

Initializes a 3D input read-write texture that has RGBA8 format type.

Equivalents

OpenGL

layout(binding=NUM) coherent uniform layout(rgba8) image3D s_rw_texture_ ## NAME;

Direct3D

RWTexture3D<rgba8> s_rw_texture_ ## NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value NAME - Name of the texture slot.

INIT_RW_STRUCTURED_BUFFER ( value NUM, value STRUCTURE, value NAME ) #

Initializes a read-write structured buffer.

Equivalents

OpenGL

layout(std430, binding=NUM) buffer storage_buffer_ ## NUM {	STRUCTURE NAME[]; };

Direct3D

RWStructuredBuffer<STRUCTURE> NAME : register(u ## NUM);

Arguments

value NUM - Number of the texture slot.
value STRUCTURE - A structure to be stored in buffer.
value NAME - Name of the texture slot.

INIT_STRUCTURED_BUFFER ( value NUM, value STRUCTURE, value NAME ) #

Initializes a structure buffer.

Equivalents

OpenGL

layout(std430, binding=NUM) readonly buffer storage_buffer_ ## NUM { STRUCTURE NAME[]; };

Direct3D

StructuredBuffer<STRUCTURE> NAME : register(t[NUM_TEXTURES+NUM]);

Arguments

value NUM - Number of the texture slot.
value STRUCTURE - A structure to be stored in buffer.
value NAME - Name of the texture slot.

Reading and Sampling a Texture#

float4 TEXTURE_2D_MANUAL_LINEAR ( Texture2D TEX_VALUE, float2 uv ) #

Returns a linearly interpolated value of the specified 2D texture.

Arguments

Texture2D TEX_VALUE - 2D Texture.
float2 uv - Texture coordinates.

Return value

Linearly interpolated value.

float TEXTURE_2D_GATHER_MANUAL_LINEAR ( Texture2D TEX_VALUE, float2 uv ) #

Returns a linearly interpolated value of four samples (Red channel only) surrounding the specified UV of the 2D texture.

Arguments

Texture2D TEX_VALUE - 2D Texture.
float2 uv - Texture coordinates.

Return value

Linearly interpolated value of four samples (Red channel only).

float4 TEXTURE_2D_ARRAY_MANUAL_LINEAR ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Returns a linearly interpolated value of the specified texture in the Texture 2D array.

Arguments

Texture2DArray TEX_VALUE - 2D Texture array.
float2 uv - Texture coordinates.
float index - Index of the texture in the array.

Return value

Linearly interpolated value.

float3 texture_2d_cubic_filter ( float x ) #

Returns calculated weights for the bicubic interpolation.

Arguments

float x - Value to be filtered.

Return value

Vector containing weights for the bicubic interpolation.

float4 TEXTURE_2D_CUBIC ( Texture2D TEX_VALUE, float2 uv ) #

Returns the bicubically interpolated value of the specified 2D texture.

Arguments

Texture2D TEX_VALUE - 2D texture.
float2 uv - Texture coordinates.

Return value

Bicubically interpolated value of the specified 2D texture.

float4 TEXTURE_2D_ARRAY_CUBIC ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Returns the bicubically interpolated value of the specified 2D texture in the 2D texture array.

Arguments

Texture2DArray TEX_VALUE - 2D texture array.
float2 uv - Texture coordinates.
float index - Index of the texture in the array.

Return value

Bicubically interpolated value of the specified 2D texture.

float4 TEXTURE_2D_CATMULL ( Texture2D TEX_VALUE, float2 uv ) #

Returns the Catmull interpolated value of the specified 2D texture.

Arguments

Texture2D TEX_VALUE - 2D texture.
float2 uv - Texture coordinates.

Return value

Catmull interpolated value of the specified 2D texture.

float4 TEXTURE_2D_ARRAY_CATMULL ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Returns the Catmull interpolated value of the specified 2D texture in the 2D texture array.

Arguments

Texture2DArray TEX_VALUE - 2D texture array.
float2 uv - Texture coordinates.
float index - Index of the texture in the array.

Return value

Catmull interpolated value of the specified 2D texture.

float4 TEXTURE_3D_CUBIC ( Texture3D TEX_VALUE, float3 uv ) #

Returns the cubically interpolated value of the specified 3D texture.

Arguments

Texture3D TEX_VALUE - 3D texture.
float3 uv - 3D texture coordinates (UVW).

Return value

Cubically interpolated value of 3D texture.

TEXTURE ( value NAME, value COORD ) #

Samples a texture.

Equivalents

OpenGL

texture(s_texture_ ## NAME,COORD)

Direct3D

s_texture_ ## NAME.Sample(s_sampler_ ## NAME ,COORD)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.

TEXTURE_BIAS ( value NAME, value COORD, value BIAS ) #

Samples a texture using a mipmap-level offset (performs a texture lookup with explicit level-of-detail).

Equivalents

OpenGL

textureLod(s_texture_ ## NAME,COORD,BIAS)

Direct3D

s_texture_ ## NAME.SampleLevel(s_sampler_ ## NAME,COORD,BIAS)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value BIAS - Mipmap level.

TEXTURE_OFFSET_BIAS ( value NAME, value COORD, value OFFSET, value BIAS ) #

Samples a texture using a mipmap-level offset.

Equivalents

OpenGL

textureOffset(s_texture_ ## NAME,COORD,OFFSET,BIAS)

Direct3D

s_texture_ ## NAME.SampleLevel(s_sampler_ ## NAME,COORD,BIAS,OFFSET)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value OFFSET - Offset.
value BIAS - Mipmap level.

TEXTURE_BIAS_ZERO ( value NAME, value COORDS ) #

Samples a texture using a mipmap-level offset on mipmap level 0 only.

Equivalents

OpenGL

textureLod(s_texture_ ## NAME,COORDS,0.0f)

Direct3D

s_texture_ ## NAME.SampleLevel(s_sampler_ ## NAME,COORDS,0.0f)

Arguments

value NAME - Name of the texture slot.
value COORDS - UV coordinates.

TEXTURE_OFFSET ( value NAME, value COORD, value OFFSET ) #

Samples a texture using a offset on mipmap level 0 only (performs a texture lookup with offset).

Equivalents

OpenGL

textureOffset(s_texture_ ## NAME,COORD,OFFSET,0)

Direct3D

s_texture_ ## NAME.SampleLevel(s_sampler_ ## NAME,COORD,0,OFFSET)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value OFFSET - Offset.

TEXTURE_GRAD ( value NAME, value COORD, value DDX, value DDY ) #

Samples a texture using a gradient to influence the way the sample location is calculated.

Equivalents

OpenGL

textureGrad(s_texture_ ## NAME,COORD,DDX,DDY)

Direct3D

s_texture_ ## NAME.SampleGrad(s_sampler_ ## NAME,COORD,DDX,DDY)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value DDX - The rate of change of the surface geometry in the x direction.
value DDY - The rate of change of the surface geometry in the y direction.

TEXTURE_MIP_OFFSET ( value NAME, value COORD, value OFFSET ) #

Samples a texture using a negative mipmap offset.

Equivalents

OpenGL

texture(s_texture_ ## NAME, COORD, -OFFSET)

Direct3D

s_texture_ ## NAME.SampleBias(s_sampler_ ## NAME, COORD, -OFFSET)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value OFFSET - Offset.

TEXTURE_FETCH ( value NAME, value COORD ) #

Reads texel data from the first level-of-detail without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int2(COORD), 0)

Direct3D

s_texture_ ## NAME.Load(uint3(COORD, 0))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.

TEXTURE_FETCH_LOD ( value NAME, value COORD, value LOD ) #

Reads texel data without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int2(COORD), LOD)

Direct3D

s_texture_ ## NAME.Load(uint3(COORD, LOD))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_ARRAY ( value NAME, value COORDS, value LAYER, value LOD ) #

Samples a texture array using a mipmap-level.

Equivalents

OpenGL

textureLod(s_texture_ ## NAME,float3(COORDS,LAYER),LOD)

Direct3D

s_texture_ ## NAME.SampleLevel(s_sampler_ ## NAME,float3(COORDS,LAYER),LOD)

Arguments

value NAME - Name of the texture slot.
value COORDS - UV coordinates.
value LAYER - Layer value.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_ARRAY_FETCH ( value NAME, value COORD, value INDEX ) #

Reads texel data from a texture array from the first level-of-detail without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int3(COORD, INDEX), 0)

Direct3D

s_texture_ ## NAME.Load(uint4(COORD, INDEX, 0))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.

TEXTURE_ARRAY_FETCH_LOD ( value NAME, value COORD, value INDEX, value LOD ) #

Reads texel data from a texture array without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int3(COORD, INDEX), LOD)

Direct3D

s_texture_ ## NAME.Load(uint4(COORD, INDEX, LOD))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_ARRAY_LOAD ( value NAME, value COORD, value INDEX ) #

Reads texel data without any filtering or sampling with zero offset.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME,COORD,0)

Direct3D

s_texture_ ## NAME.Load(uint3(COORD,0))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.

TEXTURE_ARRAY_LOAD_LOD ( value NAME, value COORD, value INDEX, value LOD ) #

Reads texel data without any filtering or sampling.

Equivalents

Source code (Shader)

TEXTURE_ARRAY_FETCH_LOD(NAME, (COORD) * textureResolution(NAME).xy * (1.0f / pow(2, LOD)), INDEX, LOD)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_LOAD ( value NAME, value COORD ) #

Reads texel data without any filtering or sampling with zero offset.

Equivalents

OpenGL

ttexelFetch(s_texture_ ## NAME,COORD,0)

Direct3D

s_texture_ ## NAME.Load(uint3(COORD,0))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.

TEXTURE_LOAD_LOD ( value NAME, value COORD, value LOD ) #

Reads texel data without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME,COORD,LOD)

Direct3D

s_texture_ ## NAME.Load(uint3(COORD,LOD))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_3D_FETCH ( value NAME, value COORD, value INDEX ) #

Reads texel data from a texture array from the first level-of-detail without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int3(COORD, INDEX), 0)

Direct3D

s_texture_ ## NAME.Load(uint4(COORD, INDEX, 0))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.

TEXTURE_3D_FETCH_LOD ( value NAME, value COORD, value INDEX, value LOD ) #

Reads texel data from a texture array without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int3(COORD, INDEX), LOD)

Direct3D

s_texture_ ## NAME.Load(uint4(COORD, INDEX, LOD))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value INDEX - Texture index.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

TEXTURE_3D_LOAD ( value NAME, value COORD ) #

Reads texel data of a 3D texture without any filtering or sampling with zero offset.

Equivalents

Source code (Shader)

TEXTURE_3D_LOAD_LOD(NAME, COORD, 0)

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.

TEXTURE_3D_LOAD_LOD ( value NAME, value COORD, value LOD ) #

Reads texel data of a single level of detail of a 3D texture without any filtering or sampling.

Equivalents

OpenGL

texelFetch(s_texture_ ## NAME, int3((COORD) * textureResolution(NAME).xyz * (1.0f / pow(2, LOD))), LOD)

Direct3D

s_texture_ ## NAME.Load(uint4((COORD) * textureResolution(NAME).xyz * (1.0f / pow(2, LOD)), LOD))

Arguments

value NAME - Name of the texture slot.
value COORD - UV coordinates.
value LOD - Level-of-detail within the texture from which the texel will be fetched.

float4 TEXTURE_RW_LOAD_RGBA8 ( value NAME, value COORD ) #

Reads the RW RGBA8 texture and returns a float4 value.

Equivalents

OpenGL

imageLoad(s_rw_texture_ ## NAME, COORD)

Direct3D

pack32To8888(s_rw_texture_ ## NAME[ ## COORD ## ])

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.

Return value

Texture value.

uint TEXTURE_RW_LOAD_R32U ( value NAME, value COORD ) #

Reads the RW R32U texture and returns a uint value.

Equivalents

OpenGL

imageLoad(s_rw_texture_ ## NAME, COORD).x

Direct3D

s_rw_texture_ ## NAME[ ## COORD ## ]

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.

Return value

Texture value.

float TEXTURE_RW_LOAD_R32F ( value NAME, value COORD ) #

Reads the RW R32F texture and returns a float value.

Equivalents

OpenGL

imageLoad(s_rw_texture_ ## NAME, COORD).x

Direct3D

s_rw_texture_ ## NAME[ ## COORD ## ]

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.

Return value

Texture value.

Writing to UAV Texture#

TEXTURE_RW_STORE_RGBA8 ( value NAME, value COORD, value VALUE ) #

Stores the value to RW RGBA8 texture.

Equivalents

OpenGL

imageStore(s_rw_texture_ ## NAME, uintToInt(COORD), toGVec4(VALUE))

Direct3D

s_rw_texture_ ## NAME[COORD] = pack8888To32(VALUE)

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.
value VALUE - A value to store.

TEXTURE_RW_STORE_R32U ( value NAME, value COORD, value VALUE ) #

Stores the value to RW R32U texture.

Equivalents

OpenGL

imageStore(s_rw_texture_ ## NAME, uintToInt(COORD), toGVec4(VALUE))

Direct3D

s_rw_texture_ ## NAME[COORD] = VALUE

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.
value VALUE - A value to store.

TEXTURE_RW_STORE_R32F ( value NAME, value COORD, value VALUE ) #

Stores the value to RW R32F texture.

Equivalents

OpenGL

imageStore(s_rw_texture_ ## NAME, uintToInt(COORD), toGVec4(VALUE))

Direct3D

s_rw_texture_ ## NAME[COORD] = VALUE

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.
value VALUE - A value to store.

TEXTURE_W_STORE ( value NAME, value COORD, value VALUE ) #

Stores the value to W texture.

Equivalents

OpenGL

imageStore(s_rw_texture_ ## NAME, uintToInt(COORD), VALUE)

Direct3D

s_rw_texture_ ## NAME[uint2(COORD)] = VALUE

Arguments

value NAME - Name of the texture slot.
value COORD - Unnormalized pixel coordinates.
value VALUE - A value to store.

Passing Textures to Functions#

UUSL allows you to pass textures to functions as arguments.

Here is a usage example:

UUSL

float4 func_name(float4 color,float2 uv,TEXTURE_IN_2(texture_0,texture_1)) {
	return TEXTURE(texture_0,uv) * TEXTURE_BIAS(texture_1,uv,5.0f) * color;
}

float4 new_color = func_name(color,uv,TEXTURE_OUT_2(TEX_COLOR_0,TEX_COLOR_1));

TEXTURE_OUT ( value NAME ) #

Allows to pass a texture to function.

Equivalents

OpenGL

s_texture_ ## NAME

Direct3D

s_texture_ ## NAME,s_sampler_ ## NAME

Arguments

value NAME - Name of the texture slot.

TEXTURE_OUT_2 ( value NAME0, value NAME1 ) #

Allows to pass two textures to a function.

Equivalents

OpenGL

TEXTURE_OUT(NAME0),TEXTURE_OUT(NAME1)

Direct3D

TEXTURE_OUT(NAME0),TEXTURE_OUT(NAME1)

Arguments

value NAME0 - Name of the texture slot (for the first texture).
value NAME1 - Name of the texture slot (for the second texture).

TEXTURE_OUT_3 ( value NAME0, value NAME1, value NAME2 ) #

Allows to pass three textures to a function.

Equivalents

OpenGL

TEXTURE_OUT_2(NAME0,NAME1),TEXTURE_OUT(NAME2)

Direct3D

TEXTURE_OUT_2(NAME0,NAME1),TEXTURE_OUT(NAME2)

Arguments

value NAME0 - Name of the texture slot (for the first texture).
value NAME1 - Name of the texture slot (for the second texture).
value NAME2 - Name of the texture slot (for the third texture).

TEXTURE_OUT_4 ( value NAME0, value NAME1, value NAME2, value NAME3 ) #

Allows to pass four textures to a function.

Equivalents

OpenGL

TEXTURE_OUT_3(NAME0,NAME1,NAME2),TEXTURE_OUT(NAME3)

Direct3D

TEXTURE_OUT_3(NAME0,NAME1,NAME2),TEXTURE_OUT(NAME3)

Arguments

value NAME0 - Name of the texture slot (for the first texture).
value NAME1 - Name of the texture slot (for the second texture).
value NAME2 - Name of the texture slot (for the third texture).
value NAME3 - Name of the texture slot (for the fourth texture).

TEXTURE_IN ( value NAME ) #

Specifies the 2D texture for passing to function.

Equivalents

OpenGL

sampler2D s_texture_ ## NAME

Direct3D

Texture2D s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

value NAME - Name of the texture.

TEXTURE_IN_2 ( value NAME0, value NAME1 ) #

Specifies two 2D textures for passing to function.

Equivalents

OpenGL

TEXTURE_IN(NAME0),TEXTURE_IN(NAME1)

Direct3D

TEXTURE_IN(NAME0),TEXTURE_IN(NAME1)

Arguments

value NAME0 - Name of the first texture.
value NAME1 - Name of the second texture.

TEXTURE_IN_3 ( value NAME0, value NAME1, value NAME2 ) #

Specifies three 2D textures for passing to function.

Equivalents

OpenGL

TEXTURE_IN_2(NAME0,NAME1),TEXTURE_IN(NAME2)

Direct3D

TEXTURE_IN_2(NAME0,NAME1),TEXTURE_IN(NAME2)

Arguments

value NAME0 - Name of the first texture.
value NAME1 - Name of the second texture.
value NAME2 - Name of the third texture.

TEXTURE_IN_4 ( value NAME0, value NAME1, value NAME2, value NAME3 ) #

Specifies four 2D textures for passing to function.

Equivalents

OpenGL

TEXTURE_IN_3(NAME0,NAME1,NAME2),TEXTURE_IN(NAME3)

Direct3D

TEXTURE_IN_3(NAME0,NAME1,NAME2),TEXTURE_IN(NAME3)

Arguments

value NAME0 - Name of the first texture.
value NAME1 - Name of the second texture.
value NAME2 - Name of the third texture.
value NAME3 - Name of the fourth texture.

TEXTURE_IN_CUBE ( value NAME ) #

Specifies the cube texture for passing to function.

Equivalents

OpenGL

samplerCube s_texture_ ## NAME

Direct3D

TextureCube s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

value NAME - Name of the texture.

TEXTURE_IN_3D ( value NAME ) #

Specifies the 3D texture for passing to function.

Equivalents

OpenGL

sampler3D s_texture_ ## NAME

Direct3D

Texture3D s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

value NAME - Name of the texture.

TEXTURE_IN_ARRAY ( value NAME ) #

Specifies the texture array for passing to function.

Equivalents

OpenGL

sampler2DArray s_texture_ ## NAME

Direct3D

Texture2DArray s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

value NAME - Name of the texture.

TEXTURE_IN_ARRAY_INT2 ( value NAME ) #

Specifies the int2 texture array for passing to function.

Equivalents

OpenGL

sampler2DArray s_texture_ ## NAME

Direct3D

Texture2DArray s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

value NAME - Name of the texture.

Texture Resolution#

int2 textureResolution ( value TEXTURE ) #

Returns the texture resolution.

This function is API-dependent.

Arguments

value TEXTURE - Texture.

Return value

Texture width and height.

int3 textureResolution ( value TEXTURE ) #

Returns the texture resolution.

This function is API-dependent.

Arguments

value TEXTURE - Texture.

Return value

Texture width, height, and depth.

float2 textureIResolution ( value TEXTURE ) #

Returns 1/(texture resolution).

This function is API-dependent.

Arguments

value TEXTURE - Texture.

Return value

1/(texture resolution).

float3 textureIResolution ( value TEXTURE ) #

Returns 1/(texture resolution).

This function is API-dependent.

Arguments

value TEXTURE - Texture.

Return value

1/(texture resolution).

Last update: 11.04.2022

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

UUSL Textures

In This Article:

Implementation of the API-dependent functions#

Methods:

Texture Initialization Functions#

INIT_TEXTURE ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_INT ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_UINT ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_CUBE ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_MSAA ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_3D ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_ARRAY ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_ARRAY_INT2 ( value NUM, value NAME ) #

Arguments

INIT_TEXTURE_ARRAY_UINT2 ( value NUM, value NAME ) #

Arguments

INIT_W_TEXTURE ( value NUM, value NAME, value TYPE, value FORMAT ) #

Arguments

INIT_W_TEXTURE_INT ( value NUM, value NAME, value TYPE, value FORMAT ) #

Arguments

INIT_W_TEXTURE_3D ( value NUM, value NAME, value TYPE, value FORMAT ) #

Arguments

INIT_RW_TEXTURE_R32U ( value NUM, value NAME ) #

Arguments

INIT_RW_TEXTURE_R32F ( value NUM, value NAME ) #

Arguments

INIT_RW_TEXTURE_RGBA8 ( value NUM, value NAME ) #

Arguments

INIT_RW_TEXTURE_R32U_3D ( value NUM, value NAME ) #

Arguments

INIT_RW_TEXTURE_R32F_3D ( value NUM, value NAME ) #

Arguments

INIT_RW_TEXTURE_RGBA8_3D ( value NUM, value NAME ) #

Arguments

INIT_RW_STRUCTURED_BUFFER ( value NUM, value STRUCTURE, value NAME ) #

Arguments

INIT_STRUCTURED_BUFFER ( value NUM, value STRUCTURE, value NAME ) #

Arguments

Reading and Sampling a Texture#

float4 TEXTURE_2D_MANUAL_LINEAR ( Texture2D TEX_VALUE, float2 uv ) #

Arguments

Return value

float TEXTURE_2D_GATHER_MANUAL_LINEAR ( Texture2D TEX_VALUE, float2 uv ) #

Arguments

Return value

float4 TEXTURE_2D_ARRAY_MANUAL_LINEAR ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Arguments

Return value

float3 texture_2d_cubic_filter ( float x ) #

Arguments

Return value

float4 TEXTURE_2D_CUBIC ( Texture2D TEX_VALUE, float2 uv ) #

Arguments

Return value

float4 TEXTURE_2D_ARRAY_CUBIC ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Arguments

Return value

float4 TEXTURE_2D_CATMULL ( Texture2D TEX_VALUE, float2 uv ) #

Arguments

Return value

float4 TEXTURE_2D_ARRAY_CATMULL ( Texture2DArray TEX_VALUE, float2 uv, float index ) #

Arguments

Return value

float4 TEXTURE_3D_CUBIC ( Texture3D TEX_VALUE, float3 uv ) #

Arguments

Return value

TEXTURE ( value NAME, value COORD ) #

Arguments

TEXTURE_BIAS ( value NAME, value COORD, value BIAS ) #

Arguments

TEXTURE_OFFSET_BIAS ( value NAME, value COORD, value OFFSET, value BIAS ) #

Arguments

TEXTURE_BIAS_ZERO ( value NAME, value COORDS ) #