UUSL关键字和类型

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.本文档文章包含有关UUSL的关键字，数据类型，预定义变量，常量和其他功能的信息。此信息可用作编写着色器的参考文档。

To start using UUSL, include the core/materials/shaders/render/common.h file.要开始使用UUSL，请包含core/materials/shaders/render/common.h文件。

#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.本文包含UUSL的不同数据类型。

UUSL	Direct3D	描述
int2	int2	A vector with two 32-bit signed integer components.具有两个32位带符号整数分量的向量。
int3	int3	A vector with three 32-bit signed integer components.具有三个32位有符号整数分量的向量。
int4	int4	A vector with four 32-bit signed integer components.具有四个32位带符号整数分量的向量。
uint2	int2	A vector with two 32-bit unsigned integer components.具有两个32位无符号整数分量的向量。
uint3	uint3	A vector with three 32-bit unsigned integer components.具有三个32位无符号整数分量的向量。
uint4	uint4	A vector with four 32-bit unsigned integer components.具有四个32位无符号整数分量的向量。
float float	float float	A 32-bit floating point value. 32位浮点值。
float2	float2	A vector with two 32-bit floating point value components.具有两个32位浮点值分量的向量。
float3	float3	A vector with three 32-bit floating point value components.具有三个32位浮点值分量的向量。
float4	float4	A vector with four 32-bit floating point value components.具有四个32位浮点值分量的向量。
float2x2	float2x2	A matrix with 2 rows, 2 columns of 32-bit floating point value components.具有2行，2列的32位浮点值分量的矩阵。
float3x3	float3x3	A matrix with 3 rows, 3 columns of 32-bit floating point value components.具有3行，3列的32位浮点值分量的矩阵。
float4x4	float4x4	A matrix with 4 rows, 4 columns of 32-bit floating point value components.具有4行，4列的32位浮点值分量的矩阵。
double2	double2	A vector with two 64-bit double-precision floating point value components.具有两个64位双精度浮点值分量的向量。
double3	double3	A vector with three 64-bit double-precision floating point value components.具有三个64位双精度浮点值分量的向量。
double4	double4	A vector with four 64-bit double-precision floating point value components.具有四个64位双精度浮点值分量的向量。
double2x2	double2x2	A matrix with 2 rows, 2 columns of 64-bit double-precision floating point value components.具有2行2列的64位双精度浮点值组成的矩阵。
double3x3	double3x3	A matrix with 3 rows, 3 columns of 64-bit double-precision floating point value components.具有3行3列的64位双精度浮点值组成的矩阵。
double4x4	double4x4	A matrix with 4 rows, 4 columns of 64-bit double-precision floating point value components.具有4行，4列的64位双精度浮点值组成的矩阵。
scalar	float / double	A scalar value, which can be either float or double depending on precision (UNIGINE_DOUBLE flag).标量值，根据精度（UNIGINE_DOUBLE标志），可以为 float 或 double 。
scalar2	float2 / double2	A vector consisting of two scalar components, which can be either float or double depending on precision (UNIGINE_DOUBLE flag).由两个标量分量组成的向量，根据精度（UNIGINE_DOUBLE标志），它们可以是 float 或 double 。
scalar3	float3 / double3	A vector consisting of three scalar components, which can be either float or double depending on precision (UNIGINE_DOUBLE flag).由三个标量分量组成的向量，根据精度（UNIGINE_DOUBLE标志），它们可以是 float 或 double 。
scalar4	float4 / double4	A vector consisting of four scalar components, which can be either double or float depending on precision (UNIGINE_DOUBLE flag).一个由四个标量分量组成的向量，根据精度（UNIGINE_DOUBLE标志），它可以是 double 或 float 。

Use these variable aliases when working with textures to make your shader's code readable:
在使用纹理时，请使用这些变量别名，以使着色器的代码可读：

UUSL	Direct3D	描述
TYPE_R	float	A 32-bit floating point value. 32位浮点值。
TYPE_RG	float2	A vector with two 32-bit floating point value components.具有两个32位浮点值分量的向量。
TYPE_RGB	float3	A vector with three 32-bit floating point value components.具有三个32位浮点值分量的向量。
TYPE_RGBA	float4	A vector with four 32-bit floating point value components.具有四个32位浮点值分量的向量。
TYPE_INT	int	A 32-bit signed integer value.一个32位带符号整数值。
TYPE_UINT	uint	A 32-bit unsigned integer value. 32位无符号整数值。

Functions for type casting: 类型转换功能：

功能	描述
int to_int(v)	Create an integer from the value.从该值创建一个整数。
int2 to_int2(v)	Create a two-component integer vector from the value.从该值创建一个包含两个分量的整数向量。
int3 to_int3(v)	Create a three-component integer vector from the value.从该值创建一个三分量整数向量。
int4 to_int4(v)	Create a four-component integer vector from the value.从该值创建一个四分量整数向量。
uint to_uint(v)	Create an unsigned integer from the value.从该值创建一个无符号整数。
uint2 to_uint2(v)	Create a two-component unsigned integer vector from the value.从该值创建一个两部分无符号整数向量。
uint3 to_uint3(v)	Create a three-component unsigned integer vector from the value.从该值创建一个三分量无符号整数向量。
uint4 to_uint4(v)	Create a four-component unsigned integer vector from the value.从该值创建一个四分量无符号整数向量。
float to_float(v)	Create a float from the value.从该值创建一个浮点数。
float2 to_float2(v)	Create a two-component floating-point vector from the value.从该值创建一个包含两个分量的浮点向量。
float3 to_float3(v)	Create a three-component floating-point vector from the value.从该值创建一个三分量浮点向量。
float4 to_float4(v)	Create a four-component floating-point vector from the value.从该值创建一个四分量浮点向量。
float4 to_gvec4(float v)	Create a four-component floating-point vector from the value.从该值创建一个四分量浮点向量。
float4 to_gvec4(float2 v)	Create a four-component floating-point vector from the two-component floating-point vector.从两分量浮点向量创建四分量浮点向量。
float4 to_gvec4(float3 v)	Create a four-component floating-point vector from the three-component floating-point vector.从三分量浮点向量创建四分量浮点向量。
float4 to_gvec4(float4 v)	Create a four-component floating-point vector from the four-component floating-point vector.从四分量浮点向量创建四分量浮点向量。
int4 to_gvec4(int v)	Create a four-component integer vector from the integer value.从整数值创建一个四分量整数向量。
int4 to_gvec4(int2 v)	Create a four-component integer vector from the two-component integer vector.从二分量整数向量创建四分量整数向量。
int4 to_gvec4(int3 v)	Create a four-component integer vector from the three-component integer vector.从三分量整数向量创建四分量整数向量。
int4 to_gvec4(int4 v)	Create a four-component integer vector from the four-component integer vector.从四分量整数向量创建四分量整数向量。
uint4 to_gvec4(uint v)	Create a four-component unsigned integer vector from the unsigned integer value.从无符号整数值创建四分量无符号整数矢量。
uint4 to_gvec4(uint2 v)	Create a four-component unsigned integer vector from the two-component unsigned integer vector.从两分量无符号整数向量创建四分量无符号整数向量。
uint4 to_gvec4(uint3 v)	Create a four-component integer vector from the three-component unsigned integer vector.从三分量无符号整数向量创建四分量整数向量。
uint4 to_gvec4(uint4 v)	Create a four-component unsigned integer vector from the four-component unsigned integer vector.从四分量无符号整数向量创建四分量无符号整数向量。
double to_double(v)	Create a double-precision value from the value.从该值创建一个双精度值。
double2 to_double2(v)	Create a two-component double-precision vector from the value.根据该值创建一个包含两个分量的双精度向量。
double3 to_double3(v)	Create a three-component double-precision vector from the value.从该值创建一个三分量双精度向量。
double4 to_double4(v)	Create a four-component double-precision vector from the value.从该值创建一个四分量双精度向量。
scalar to_scalar(v)	Create a scalar value from the value.从该值创建标量值。
scalar2 to_scalar2(v)	Create a two-component scalar value from the value.从该值创建一个包含两个分量的标量值。
scalar3 to_scalar3(v)	Create a three-component scalar value from the value.根据该值创建一个三分量标量值。
scalar4 to_scalar4(v)	Create a four-component scalar value from the value.从该值创建一个四分量标量值。

Use the following defined values in double-precision functions.在双精度函数中使用以下定义的值。

The following defined values are reserved bits of the Material mask.以下定义的值是 Material掩码的保留位。

Void Main Function

虚空主要功能#

STRUCT_FRAG_BEGIN
STRUCT_FRAG_END

MAIN_FRAG_BEGIN(FRAGMENT_IN)
	<your code here>
MAIN_FRAG_END

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

Main Function with Return Value

具有返回值的主要功能#

STRUCT_FRAG_BEGIN
    INIT_COLOR(float4)
STRUCT_FRAG_END

MAIN_FRAG_BEGIN(FRAGMENT_IN)
	<your code here>
MAIN_FRAG_END

FRAGMENT_OUT main(FRAGMENT_IN IN) { 
	FRAGMENT_OUT OUT;
	<your code here>
return OUT; }

Geometry Shader Main Function

几何着色器主要功能#

STRUCT(GEOMETRY_IN)
	INIT_POSITION
	<input members>
END

STRUCT(GEOMETRY_OUT)
	INIT_POSITION
	<output members>
END

MAIN_GEOM_BEGIN(GEOMETRY_OUT, GEOMETRY_IN)
	<your code here>
MAIN_GEOM_END

[maxvertexcount(MAX_VERTICES_GEOM)]
void main(TYPE_GEOM_IN GEOMETRY_IN IN[COUNT_GEOM_IN],inout TYPE_GEOM_OUT<GEOMETRY_OUT> stream) {
	GEOMETRY_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:这等于以下GLSL和HLSL命令：

uniform <your var>

Static Variables

静态变量#

STATICVAR <your var>

static const <your var>

Static Arrays

静态数组#

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

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: UUSL包含混合预设。当您指定材质中的混合类型时，USSL包装器会自动定义一个新定义，您可以在着色器中使用它。

HLSL Flow Control Attributes

HLSL流控制属性#

UUSL	Direct3D	描述
branch	[branch]	Performs branching using control flow instructions.使用控制流指令执行分支。
call	[call]	Prevents inlining of a function.防止函数内联。
flatten	[flatten]	Performs branching using conditional move instructions.使用条件移动指令执行分支。
ifAll	[ifAll]	Executes the conditional part of an if statement when the condition is true for all threads on which the current shader is running.当运行当前着色器的所有线程的条件为true时，执行 if 语句的条件部分。
ifAny	[ifAny]	Executes the conditional part of an if statement when the condition is true for any thread on which the current shader is running.当运行当前着色器的任何线程的条件为true时，执行 if 语句的条件部分。
isolate	[isolate]	Optimizes the specified HLSL code independently of the surrounding code.独立于周围的代码优化指定的HLSL代码。
loop	[loop]	Gives preference to flow control constructs.优先考虑流控制构造。
maxexports	[maxexports]	Specifies the maximum number of export instructions that will execute along any path from the entry point to an exit.指定将在从入口点到出口的任何路径上执行的导出指令的最大数量。
maxInstructionCount	[maxInstructionCount]	Sets the maximum number of instructions available to a shader.设置着色器可用的最大指令数。
maxtempreg	[maxtempreg]	Restricts temporary register usage to the number of registers specified. Generates a compiler error if unsuccessful.将临时寄存器的使用限制为指定的寄存器数。如果失败，将生成编译器错误。
noExpressionOptimizations	[noExpressionOptimizations]	Avoids optimization of expressions.避免表达式的优化。
predicate	[predicate]	Performs branching by using predication.使用谓词执行分支。
predicateBlock	[predicateBlock]	Performs branching by using predicated exec blocks.通过使用谓词 exec 块执行分支。
reduceTempRegUsage	[reduceTempRegUsage]	Restricts temporary register usage to the number of registers specified. Generates a compiler warning if unsuccessful.将临时寄存器的使用限制为指定的寄存器数。如果失败，则生成编译器警告。
removeUnusedInputs	[removeUnusedInputs]	Removes unused interpolator inputs from pixel shaders.从像素着色器中删除未使用的插值器输入。
sampreg	[sampreg]	Sets the ranges of pixel sampler and vertex sampler registers used by the compiler.设置编译器使用的像素采样器和顶点采样器寄存器的范围。
unroll	[unroll]	Avoids flow control constructs.避免使用流控制构造。
unused	[unused]	Suppresses warnings about unused shader parameters.禁止显示有关未使用的着色器参数的警告。
xps	[xps]	Specifies that all vertex fetch operations are done after the last vfetch instruction. This instruction is used to reduce the latency back to the command processor to free the vertex buffer.指定在最后一条vfetch指令之后完成所有顶点提取操作。该指令用于减少返回到命令处理器以释放顶点缓冲区的等待时间。
earlydepthstencil	[earlydepthstencil]	Forces depth-stencil testing before a shader executes. Doesn't work with custom depth. 在着色器执行之前强制深度模板测试。 不适用于自定义深度。