UUSL Textures

The Unified UNIGINE shader language (UUSL) unifies the way of using textures in shaders. You need to define the texture slot in the material, initialize the texture in the shader's code and then use it.

Here is an example of using texture in the fragment shader's code:

// Include the UUSL header file
#include <core/shaders/common/fragment.h>

// Initialize a textures.
// You don't need to define texture slot
// by using define directive
INIT_TEXTURE(0,TEX_DEPTH)
INIT_TEXTURE(1,TEX_NORMAL)
INIT_TEXTURE(2,TEX_ALBEDO)
INIT_TEXTURE(3,TEX_SHADING)

/* Input and output structures */

MAIN_BEGIN(FRAGMENT_OUT,FRAGMENT_IN)

	/* some code */

	GBuffer gbuffer = GBufferDefault();
	
	loadGBufferAlbedo(gbuffer, TEXTURE_OUT(TEX_ALBEDO),uv);
	loadGBufferShading(gbuffer, TEXTURE_OUT(TEX_SHADING),uv);
	loadGBufferNormal(gbuffer, TEXTURE_OUT(TEX_NORMAL),uv);

	/* some code */
MAIN_END

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

INIT_TEXTURE(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_CUBE(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_3D(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_ARRAY(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_SHADOW(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_ARRAY_SHADOW(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_TEXTURE_CUBE_SHADOW(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

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

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A 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(value NUM, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value NAME - A name of the texture slot.

INIT_RW_STRUCTURE_BUFFER(value NUM, value STRUCTURE, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value STRUCTURE - A structure to be stored in buffer.
• value NAME - A name of the texture slot.

INIT_STRUCTURED_BUFFER(value NUM, value STRUCTURE, value NAME)

Equivalents

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

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

Arguments

• value NUM - A number of the texture slot.
• value STRUCTURE - A structure to be stored in buffer.
• value NAME - A name of the texture slot.

TEXTURE(value NAME, value COORD)

Equivalents

texture(s_texture_ ## NAME,COORD)

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

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.

TEXTURE_BIAS(value NAME, value COORD, value BIAS)

Equivalents

textureLod(s_texture_ ## NAME,COORD,BIAS)

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

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.
• value BIAS - Mipmap level.

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

Equivalents

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

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

Arguments

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

TEXTURE_OFFSET(value NAME, value COORD, value OFFSET)

Equivalents

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

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

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.
• value OFFSET - Offset.

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

Equivalents

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

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

Arguments

• value NAME - A 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_LOAD_LOD(value NAME, value COORD, value LOD)

Equivalents

texelFetch(s_texture_ ## NAME,COORD,LOD)

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

Arguments

• value NAME - A 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_LOAD(value NAME, value COORD)

Equivalents

ttexelFetch(s_texture_ ## NAME,COORD,0)

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

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.

TEXTURE_SHADOW(value NAME, value COORD)

Equivalents

texture(s_texture_ ## NAME,COORD)

s_texture_ ## NAME.SampleCmpLevelZero(s_sampler_compare_ ## NAME,(COORD).xy,(COORD).z)

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.

TEXTURE_SHADOW_PROJ(value NAME, value COORD)

Equivalents

textureProj(s_texture_ ## NAME,COORD)

s_texture_ ## NAME.SampleCmpLevelZero(s_sampler_compare_ ## NAME,(COORD).xy,(COORD).z)

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.

TEXTURE_CUBE_SHADOW(value NAME, value DIRECTION, value DEPTH)

Equivalents

texture(s_texture_ ## NAME,float4(DIRECTION,DEPTH)))

s_texture_ ## NAME.SampleCmpLevelZero(s_sampler_compare_ ## NAME,DIRECTION,DEPTH)

Arguments

• value NAME - A name of the texture slot.
• value DIRECTION - Direction value.
• value DEPTH - Depth value.

TEXTURE_2D_CUBIC(value NAME, value COORD, value TEXSIZE)

Equivalents

texture2DCubic(s_texture_ ## NAME,COORD,TEXSIZE)

texture2DCubic(s_texture_ ## NAME,s_sampler_ ## NAME,COORD,TEXSIZE)

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.
• value TEXSIZE - Texture size.

TEXTURE_RW_LOAD(value NAME, value COORD)

Equivalents

imageLoad(s_rw_texture_ ## NAME,COORD)

unpack_uint32_to_rgba8(s_rw_texture_ ## NAME[uint2(COORD)])

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.

TEXTURE_RW_STORE(value NAME, value COORD, value VALUE)

Equivalents

imageStore(s_rw_texture_ ## NAME,COORD,VALUE)

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

Arguments

• value NAME - A name of the texture slot.
• value COORD - UV coordinates.
• value VALUE - A value to store.

TEXTURE_BIAS_ZERO(value NAME, value COORDS)

Equivalents

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

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

Arguments

• value NAME - A name of the texture slot.
• value COORDS - UV coordinates.

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

Equivalents

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

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

Arguments

• value NAME - A 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_TRIPLANAR(value TEXTURE_ID, value TEXCOORD, value WEIGHT)

Implementation

(TEXTURE(TEXTURE_ID,TEXCOORD.zw) * WEIGHT.x + 
 TEXTURE(TEXTURE_ID,TEXCOORD.xw) * WEIGHT.y + 
 TEXTURE(TEXTURE_ID,TEXCOORD.xy) * WEIGHT.z )

Arguments

• value TEXTURE_ID - Texture ID.
• value TEXCOORD - UV coordinates.
• value WEIGHT - Texture's weight in triplanar mapping.

UUSL allows you to pass textures to functions as arguments.

Here is a usage example:

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)

Equivalents

s_texture_ ## NAME

s_texture_ ## NAME,s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture slot.

TEXTURE_OUT_2(value NAME0, value NAME1)

Equivalents

TEXTURE_OUT(NAME0),TEXTURE_OUT(NAME1)

TEXTURE_OUT(NAME0),TEXTURE_OUT(NAME1)

Arguments

• value NAME0 - A name of the texture slot (for the first texture).
• value NAME1 - A name of the texture slot (for the second texture).

TEXTURE_OUT_3(value NAME0, value NAME1, value NAME2)

Equivalents

TEXTURE_OUT_2(NAME0,NAME1),TEXTURE_OUT(NAME2)

TEXTURE_OUT_2(NAME0,NAME1),TEXTURE_OUT(NAME2)

Arguments

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

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

Equivalents

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

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

Arguments

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

TEXTURE_IN(value NAME)

Equivalents

sampler2D s_texture_ ## NAME

Texture2D s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_2(value NAME0, value NAME1)

Equivalents

TEXTURE_IN(NAME0),TEXTURE_IN(NAME1)

TEXTURE_IN(NAME0),TEXTURE_IN(NAME1)

Arguments

• value NAME0 - A name of the first texture.
• value NAME1 - A name of the second texture.

TEXTURE_IN_3(value NAME0, value NAME1, value NAME2)

Equivalents

TEXTURE_IN_2(NAME0,NAME1),TEXTURE_IN(NAME2)

TEXTURE_IN_2(NAME0,NAME1),TEXTURE_IN(NAME2)

Arguments

• value NAME0 - A name of the first texture.
• value NAME1 - A name of the second texture.
• value NAME2 - A name of the third texture.

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

Equivalents

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

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

Arguments

• value NAME0 - A name of the first texture.
• value NAME1 - A name of the second texture.
• value NAME2 - A name of the third texture.
• value NAME3 - A name of the fourth texture.

TEXTURE_IN_CUBE(value NAME)

Equivalents

samplerCube s_texture_ ## NAME

TextureCube s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_3D(value NAME)

Equivalents

sampler3D s_texture_ ## NAME

Texture3D s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_ARRAY(value NAME)

Equivalents

sampler2DArray s_texture_ ## NAME

Texture2DArray s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_SHADOW(value NAME)

Equivalents

sampler2DShadow s_texture_ ## NAME

Texture2D s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_ARRAY_SHADOW(value NAME)

Equivalents

sampler2DArrayShadow s_texture_ ## NAME

Texture2DArray s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.

TEXTURE_IN_CUBE_SHADOW(value NAME)

Equivalents

samplerCubeShadow s_texture_ ## NAME

TextureCube s_texture_ ## NAME,SamplerState s_sampler_ ## NAME

Arguments

• value NAME - A name of the texture.