Unigine.Shader Class

public class ShaderTest : Component
{
	Shader shader;
	private void Init()
	{
		// write here code to be called on component initialization
		
		// String containing the source code of the vertex shader (GLSL, HLSL, UUSL)
		String vertex_shader = @"
float4 main(float2 pos : POSITION) : SV_POSITION
{
	return float4(pos, 0.0f, 1.0f);
}
";

	// String containing the source code of the fragment shader (GLSL, HLSL, UUSL)
	String fragment_shader = @"
cbuffer vars : register(b0)
{
	float4 color;
};

float4 main(float4 fragCoord : SV_POSITION) : SV_TARGET
{
	return color;
}
";

	shader = new Shader();

	// Loading vertex and fragment shaders and compiling them
	shader.LoadVertex(vertex_shader, "");
	shader.LoadFragment(fragment_shader, "");
	shader.Compile();

	// Adding a render END_SCREEN callback to render the result as a post-effect
	Render.AddCallback(Render.CALLBACK_INDEX.END_SCREEN,
		()=>
			{
				// Getting a post RenderTarget to render to
				RenderTarget rt = Renderer.PostRenderTarget;
				rt.UnbindAll();
				rt.BindColorTexture(0, Renderer.TextureColor);
				rt.Enable();

				// Binding our shader and rendering the screen via FFP
				shader.Bind();
				// setting the fill color to magenta
				shader.SetParameterFloat4("color", new vec4(1.0f, 0.0f, 1.0f, 1.0f));
				shader.FlushParameters();
				Ffp.RenderScreen();
				
				// Unbinding the shader and disabling the target
				shader.Unbind();

				rt.Disable();
			});
	}
	
	private void Update()
	{
		// write here code to be called before updating each render frame
		
	}
}

Shader Class

Enums

WARNING_MODE#

Warning mode for the shader compiler.

Name	Description
DISABLE = 0	All shader compilation warnings are ignored. Using this mode is not recommended as it may result in driver and OS crashes, so you use it at your own risk.
SOFT = 1	All shader compilation warnings are printed to log, but ignored. You can use this mode if you have checked and you're absolutely sure that the warnings do not cause driver or OS crashes.
HARD = 2	All warnings are treated as errors. This level is used by default.

Properties

bool IEEEStrictness#

bool DisableExport#

bool DisableCompileError#

Shader.WARNING_MODE WarningMode#

int OptimizationLevel#

bool DisableCompileCache#

Members

---

Shader ( ) #

Default shader constructor.

Shader ( string name ) #

Shader constructor. Loads all existing shaders with given name.

Arguments

• string name - Shader name.

Shader ( string name, string defines ) #

Shader constructor. Loads all existing shaders with given name.

Arguments

• string name - Shader name.
• string defines - Shader defines.

Shader ( string vertex, string fragment, string defines ) #

Shader constructor. Loads only vertex and fragment shaders with given names.

Arguments

• string vertex - Vertex shader name or source.
• string fragment - Fragment shader name or source.
• string defines - Shader defines.

IntPtr GetD3D11ComputeShader ( ) #

Returns Direct3D11 compute shader.

IntPtr GetD3D11ControlShader ( ) #

Returns Direct3D11 control shader.

IntPtr GetD3D11EvaluateShader ( ) #

Returns Direct3D11 evaluate shader.

IntPtr GetD3D11FragmentShader ( ) #

Returns Direct3D11 fragment shader.

IntPtr GetD3D11GeometryShader ( ) #

Returns Direct3D11 geometry shader.

IntPtr GetD3D11VertexShader ( ) #

Returns Direct3D11 vertex shader.

int GetGLProgramID ( ) #

Returns OpenGL program identifier.

void Bind ( ) #

Binds shader.

void Clear ( ) #

Clears shader.

bool Compile ( ) #

Compiles shader.

Return value

1 if the shader compiled successfully; otherwise, 0.

void Destroy ( ) #

Destroys shader.

int FindParameter ( string name ) #

Finds shader parameter.

Arguments

• string name - Fast identifier.

Return value

Parameter identifier, if found; otherwise, -1.

void FlushParameters ( ) #

Flushes shader parameters.

bool LoadCompute ( string name, string defines ) #

Loads compute shader.

Arguments

• string name - Compute shader name or source.
• string defines - Shader defines.

Return value

1 if the compute shader was loaded successfully; otherwise, 0.

bool LoadControl ( string name, string defines ) #

Loads control shader.

Arguments

• string name - Control shader name or source.
• string defines - Shader defines.

Return value

1 if the control shader was loaded successfully; otherwise, 0.

bool LoadEvaluate ( string name, string defines ) #

Loads evaluate shader.

Arguments

• string name - Evaluate shader name or source.
• string defines - Shader defines.

Return value

1 if the evaluate shader was loaded successfully; otherwise, 0.

bool LoadFragment ( string name, string defines ) #

Loads fragment shader.

Arguments

• string name - Fragment shader name or source.
• string defines - Shader defines.

Return value

1 if the fragment shader was loaded successfully; otherwise, 0.

bool LoadGeometry ( string name, string defines ) #

Loads geometry shader.

Arguments

• string name - Geometry shader name or source.
• string defines - Shader defines.

Return value

1 if the geometry shader was loaded successfully; otherwise, 0.

bool LoadVertex ( string name, string defines ) #

Loads vertex shader.

Arguments

• string name - Vertex shader name or source.
• string defines - Shader defines.

Return value

1 if the vertex shader was loaded successfully; otherwise, 0.

void Unbind ( ) #

Unbinds shader.

void SetParameterFloat ( int id, float value ) #

Sets shader float parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• float value - Parameter value to be set.

void SetParameterFloat ( string name, float value ) #

Sets shader float parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• float value - Parameter value to be set.

void SetParameterFloat2 ( int id, vec2 value ) #

Sets a shader parameter value for the float2 variable.

Arguments

• int id - Parameter identifier.
• vec2 value - Parameter value to be set.

void SetParameterFloat2 ( string name, vec2 value ) #

Sets a shader parameter value for the float2 variable.

Arguments

• string name - Parameter name.
• vec2 value - Parameter value to be set.

void SetParameterFloat3 ( int id, vec3 value ) #

Sets a shader parameter value for the float3 variable.

Arguments

• int id - Parameter identifier.
• vec3 value - Parameter value to be set.

void SetParameterFloat3 ( string name, vec3 value ) #

Sets a shader parameter value for the float3 variable using the parameter name.

Arguments

• string name - Parameter name.
• vec3 value - Parameter value to be set.

void SetParameterFloat4 ( int id, vec4 value ) #

Sets a shader parameter value for the float4 variable.

Arguments

• int id - Parameter identifier.
• vec4 value - Parameter value to be set.

void SetParameterFloat4 ( string name, vec4 value ) #

Sets a shader parameter value for the float4 variable using the parameter name.

Arguments

• string name - Parameter name.
• vec4 value - Parameter value to be set.

void SetParameterFloat3x3 ( int id, mat3 value ) #

Sets a shader parameter value for the float3x3 variable.

Arguments

• int id - Parameter identifier.
• mat3 value - Parameter value to be set.

void SetParameterFloat3x3 ( string name, mat3 value ) #

Sets a shader parameter value for the float3x3 variable using the parameter name.

Arguments

• string name - Parameter name.
• mat3 value - Parameter value to be set.

void SetParameterFloat4x4 ( int id, mat4 value ) #

Sets a shader parameter value for the float4x4 variable.

Arguments

• int id - Parameter identifier.
• mat4 value - Parameter value to be set.

void SetParameterFloat4x4 ( string name, mat4 value ) #

Sets a shader parameter value for the float4x4 variable using the parameter name.

Arguments

• string name - Parameter name.
• mat4 value - Parameter value to be set.

void SetParameterInt ( int id, int value ) #

Sets a shader parameter value for the int variable.

Arguments

• int id - Parameter identifier.
• int value - Parameter value to be set.

void SetParameterInt ( string name, int value ) #

Sets a shader parameter value for the int variable using the parameter name.

Arguments

• string name - Parameter name.
• int value - Parameter value to be set.

void SetParameterInt2 ( int id, ivec2 value ) #

Sets a shader parameter value for the int2 variable.

Arguments

• int id - Parameter identifier.
• ivec2 value - Parameter value to be set.

void SetParameterInt2 ( string name, ivec2 value ) #

Sets a shader parameter value for the int2 variable using the parameter name.

Arguments

• string name - Parameter name.
• ivec2 value - Parameter value to be set.

void SetParameterInt3 ( int id, ivec3 value ) #

Sets a shader parameter value for the int3 variable.

Arguments

• int id - Parameter identifier.
• ivec3 value - Parameter value to be set.

void SetParameterInt3 ( string name, ivec3 value ) #

Sets a shader parameter value for the int3 variable using the parameter name.

Arguments

• string name - Parameter name.
• ivec3 value - Parameter value to be set.

void SetParameterInt4 ( int id, ivec4 value ) #

Sets a shader parameter value for the int4 variable.

Arguments

• int id - Parameter identifier.
• ivec4 value - Parameter value to be set.

void SetParameterInt4 ( string name, ivec4 value ) #

Sets a shader parameter value for the int4 variable using the parameter name.

Arguments

• string name - Parameter name.
• ivec4 value - Parameter value to be set.

void SetParameterDouble ( int id, double value ) #

Sets a shader parameter value for the double variable.

Arguments

• int id - Parameter identifier.
• double value - Parameter value to be set.

void SetParameterDouble ( string name, double value ) #

Sets a shader parameter value for the double variable using the parameter name.

Arguments

• string name - Parameter name.
• double value - Parameter value to be set.

void SetParameterDouble2 ( int id, dvec2 value ) #

Sets a shader parameter value for the double2 variable.

Arguments

• int id - Parameter identifier.
• dvec2 value - Parameter value to be set.

void SetParameterDouble2 ( string name, dvec2 value ) #

Sets a shader parameter value for the double2 variable using the parameter name.

Arguments

• string name - Parameter name.
• dvec2 value - Parameter value to be set.

void SetParameterDouble3 ( int id, dvec3 value ) #

Sets a shader parameter value for the double3 variable.

Arguments

• int id - Parameter identifier.
• dvec3 value - Parameter value to be set.

void SetParameterDouble3 ( string name, dvec3 value ) #

Sets a shader parameter value for the double3 variable using the parameter name.

Arguments

• string name - Parameter name.
• dvec3 value - Parameter value to be set.

void SetParameterDouble4 ( int id, dvec4 value ) #

Sets a shader parameter value for the double4 variable.

Arguments

• int id - Parameter identifier.
• dvec4 value - Parameter value to be set.

void SetParameterDouble4 ( string name, dvec4 value ) #

Sets a shader parameter value for the double4 variable using the parameter name.

Arguments

• string name - Parameter name.
• dvec4 value - Parameter value to be set.

void SetParameterDouble4x4 ( int id, dmat4 value ) #

Sets a shader parameter value for the double4x4 variable.

Arguments

• int id - Parameter identifier.
• dmat4 value - Parameter value to be set.

void SetParameterDouble4x4 ( string name, dmat4 value ) #

Sets a shader parameter value for the double4x4 variable using the parameter name.

Arguments

• string name - Parameter name.
• dmat4 value - Parameter value to be set.

void SetParameterScalar ( int id, Scalar value ) #

Sets a shader parameter value for the scalar variable using the parameter id.

Arguments

• int id - Parameter identifier.
• Scalar value - Parameter value to be set.

void SetParameterScalar ( string name, Scalar value ) #

Sets a shader parameter value for the scalar variable using the parameter name.

Arguments

• string name - Parameter name.
• Scalar value - Parameter value to be set.

void SetParameterScalar2 ( int id, vec2 value ) #

Sets a shader parameter value for the scalar2 variable using the parameter id.

Arguments

• int id - Parameter identifier.
• vec2 value - Parameter value to be set.

void SetParameterScalar2 ( string name, vec2 value ) #

Sets a shader parameter value for the scalar2 variable using the parameter name.

Arguments

• string name - Parameter name.
• vec2 value - Parameter value to be set.

void SetParameterScalar3 ( int id, vec3 value ) #

Sets a shader parameter value for the scalar3 variable using the parameter id.

Arguments

• int id - Parameter identifier.
• vec3 value - Parameter value to be set.

void SetParameterScalar3 ( string name, vec3 value ) #

Sets a shader parameter value for the scalar3 variable using the parameter name.

Arguments

• string name - Parameter name.
• vec3 value - Parameter value to be set.

void SetParameterScalar4 ( int id, vec4 value ) #

Sets a shader parameter value for the scalar4 variable using the parameter id.

Arguments

• int id - Parameter identifier.
• vec4 value - Parameter value to be set.

void SetParameterScalar4 ( string name, vec4 value ) #

Sets a shader parameter value for the scalar4 variable using the parameter name.

Arguments

• string name - Parameter name.
• vec4 value - Parameter value to be set.

void SetParameterArrayFloat ( int id, float[] value, int num_elements ) #

Sets shader float array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• float[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat ( string name, float[] value, int num_elements ) #

Sets shader float array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• float[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat ( int id, float[] value ) #

Sets shader float array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• float[] value - Parameter value to be set.

void SetParameterArrayFloat ( string name, float[] value ) #

Sets shader float array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• float[] value - Parameter value to be set.

void SetParameterArrayFloat2 ( int id, vec2[] value, int num_elements ) #

Sets shader float2 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• vec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat2 ( string name, vec2[] value, int num_elements ) #

Sets shader float2 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• vec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat2 ( int id, vec2[] value ) #

Sets shader float2 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• vec2[] value - Parameter value to be set.

void SetParameterArrayFloat2 ( string name, vec2[] value ) #

Sets shader float2 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• vec2[] value - Parameter value to be set.

void SetParameterArrayFloat4 ( int id, vec4[] value, int num_elements ) #

Sets shader float4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• vec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat4 ( string name, vec4[] value, int num_elements ) #

Sets shader float4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• vec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat4 ( int id, vec4[] value ) #

Sets shader float4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• vec4[] value - Parameter value to be set.

void SetParameterArrayFloat4 ( string name, vec4[] value ) #

Sets shader float4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• vec4[] value - Parameter value to be set.

void SetParameterArrayFloat4x4 ( int id, mat4[] value, int num_elements ) #

Sets shader float4x4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• mat4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat4x4 ( string name, mat4[] value, int num_elements ) #

Sets shader float4x4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• mat4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayFloat4x4 ( int id, mat4[] value ) #

Sets shader float4x4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• mat4[] value - Parameter value to be set.

void SetParameterArrayFloat4x4 ( string name, mat4[] value ) #

Sets shader float4x4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• mat4[] value - Parameter value to be set.

void SetParameterArrayInt ( int id, int[] value, int num_elements ) #

Sets shader integer array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• int[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt ( string name, int[] value, int num_elements ) #

Sets shader integer array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• int[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt ( int id, int[] value ) #

Sets shader integer array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• int[] value - Parameter value to be set.

void SetParameterArrayInt ( string name, int[] value ) #

Sets shader integer array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• int[] value - Parameter value to be set.

void SetParameterArrayInt2 ( int id, ivec2[] value, int num_elements ) #

Sets shader int2 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• ivec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt2 ( string name, ivec2[] value, int num_elements ) #

Sets shader int2 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• ivec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt2 ( int id, ivec2[] value ) #

Sets shader int2 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• ivec2[] value - Parameter value to be set.

void SetParameterArrayInt2 ( string name, ivec2[] value ) #

Sets shader int2 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• ivec2[] value - Parameter value to be set.

void SetParameterArrayInt4 ( int id, ivec4[] value, int num_elements ) #

Sets shader int4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• ivec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt4 ( string name, ivec4[] value, int num_elements ) #

Sets shader int4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• ivec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayInt4 ( int id, ivec4[] value ) #

Sets shader int4 array parameter values by using given parameter id.

Arguments

• int id - Parameter identifier.
• ivec4[] value - Parameter value to be set.

void SetParameterArrayInt4 ( string name, ivec4[] value ) #

Sets shader int4 array parameter values by using given parameter name.

Arguments

• string name - Parameter name.
• ivec4[] value - Parameter value to be set.

void SetParameterArrayDouble ( int id, double[] value, int num_elements ) #

Sets shader double parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• double[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble ( string name, double[] value, int num_elements ) #

Sets shader double parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• double[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble ( int id, double[] value ) #

Sets shader double parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• double[] value - Parameter value to be set.

void SetParameterArrayDouble ( string name, double[] value ) #

Sets shader double parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• double[] value - Parameter value to be set.

void SetParameterArrayDouble2 ( int id, dvec2[] value, int num_elements ) #

Sets shader double2 parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• dvec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble2 ( string name, dvec2[] value, int num_elements ) #

Sets shader double2 parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• dvec2[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble2 ( int id, dvec2[] value ) #

Sets shader double2 parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• dvec2[] value - Parameter value to be set.

void SetParameterArrayDouble2 ( string name, dvec2[] value ) #

Sets shader double2 parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• dvec2[] value - Parameter value to be set.

void SetParameterArrayDouble4 ( int id, dvec4[] value, int num_elements ) #

Sets shader double4 parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• dvec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble4 ( string name, dvec4[] value, int num_elements ) #

Sets shader double4 parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• dvec4[] value - Parameter value to be set.
• int num_elements - The number of array elements.

void SetParameterArrayDouble4 ( int id, dvec4[] value ) #

Sets shader double4 parameter value by using given parameter id.

Arguments

• int id - Parameter identifier.
• dvec4[] value - Parameter value to be set.

void SetParameterArrayDouble4 ( string name, dvec4[] value ) #

Sets shader double4 parameter value by using given parameter name.

Arguments

• string name - Parameter name.
• dvec4[] value - Parameter value to be set.