UUSL Keywords and Types

This documentation article contains information about keywords, data types, pre-defined variables, constants and other features of the UUSL. This information can be used as the reference document for writing shaders.

To start using UUSL, include the core/materials/shaders/render/common.h file.

#include <core/materials/shaders/render/common.h>

This header file is also used for fragment shader functions and scalar and double types and functions.

This articles contains different data types of UUSL.

Use these variable aliases when working with textures to make your shader's code readable:

Functions for type casting are the same for both DirectX and OpenGL:

Use the following defined values in double-precision functions.

The following defined values are reserved bits of the Material mask.

Void Main Function#

STRUCT_FRAG_BEGIN
STRUCT_FRAG_END

MAIN_FRAG_BEGIN(STRUCT_IN)
	<your code here>
MAIN_FRAG_END

void main() {
	<your code here>
}

void main(STRUCT_IN IN) {
	<your code here>
}

Main Function with Return Value#

STRUCT_FRAG_BEGIN
    INIT_COLOR(float4)
STRUCT_FRAG_END

MAIN_FRAG_BEGIN(STRUCT_IN)
	<your code here>
MAIN_FRAG_END

void main() {
	<your code here>
}

STRUCT_OUT main(STRUCT_IN IN) { 
	STRUCT_OUT OUT;
	<your code here>
return OUT; }

Geometry Shader Main Function#

MAIN_GEOM_BEGIN(STRUCT_OUT,STRUCT_IN)
	<your code here>
MAIN_GEOM_END

layout(TYPE_GEOM_IN) in;
layout(TYPE_GEOM_OUT,max_vertices = MAX_VERTICES_GEOM) out;
void main() {
	<your code here>
}

[maxvertexcount(MAX_VERTICES_GEOM)]
void main(TYPE_GEOM_IN STRUCT_IN IN[COUNT_GEOM_IN],inout TYPE_GEOM_OUT<STRUCT_OUT> stream) {
	STRUCT_OUT OUT;
	<your code here>
}

To define a global variable, use the following syntax:

GLOBAL <your var>

This is equal to the following GLSL and HLSL commands:

uniform <your var>

uniform <your var>

Static Variables#

STATICVAR <your var>

const <your var>

static const <your var>

Static Arrays#

STATICARRAY(TYPE,NAME,SIZE)
	<your array members>
ENDARRAY

TYPE NAME [SIZE] = TYPE[](<your array members>);

static const TYPE NAME [SIZE] = {<your array members>};

UUSL contains blending presets. When you specify the type of blending in material, the USSL wrapper automatically defines a new definition, that you can use in your shader:

HLSL Flow Control Attributes#

Interpolation Modifiers#

Structs#

STRUCT(NAME)
	<your data>
END

// Input vertex data
STRUCT(VERTEX_IN)
	INIT_ATTRIBUTE(float4,0,POSITION)	// Vertex position
	INIT_ATTRIBUTE(float4,1,TEXCOORD0)	// Vertex texcoord (uv)
	INIT_ATTRIBUTE(float4,2,TEXCOORD1)	// Vertex basis tangent
	INIT_ATTRIBUTE(float4,3,TEXCOORD2)	// Vertex color
END

Constants#

CBUFFER(NAME)
	<your data>
END

CBUFFER(parameters)
	UNIFORM float grayscale_power;
END

See Also#

There is a for loop implemented in UUSL:

forloop(NAME,BEGIN,END)

for(int NAME = (BEGIN); NAME < (END); NAME++)

The keyword for is used to describe a loop that is controlled by a counter (NAME). The parentheses enclose three expressions that initialize, check and update the variable used as counter. The body defined by curly braces encloses the statements that are executed at each pass of the loop.

Here is an example of a for loop:

forloop(i, 0, 99)
{
	aFunction();
}

To export shader, use the following command:

EXPORT_SHADER(FILE)

• FILE - The name of the file.

This command exports the shader program into a file: for Direct3D the file will have an .hlsl extension, for OpenGL the file will have an .glsl extension.

The command expands all of the predefined UUSL syntax and creates shader files in native languages for both graphic APIs.