Class ShaderMaterial

A material defined by a custom Shader program and the values of its shader parameters.

Inheritance

Material

Resource

RefCounted

Object

ShaderMaterial

Remarks

A material that uses a custom Shader program to render visual items (canvas items, meshes, skies, fog), or to process particles. Compared to other materials, ShaderMaterial gives deeper control over the generated shader code. For more information, see the shaders documentation index below.

Multiple ShaderMaterials can use the same shader and configure different values for the shader uniforms.

Note: For performance reasons, the changed signal is only emitted when the resource_name changes. Only in editor, it is also emitted for shader changes.

See Also

Shaders documentation index

Properties

shader

The Shader program used to render this material.

var shader : Shader

Property Value

Shader

Remarks

• void set_shader(Shader value)
• Shader get_shader

Methods

get_shader_parameter(StringName)

Qualifiers: const

Returns the current value set for this material of a uniform in the shader.

Variant get_shader_parameter(StringName param)

Parameters

param StringName

set_shader_parameter(StringName, Variant)

Changes the value set for this material of a uniform in the shader.

Note: param is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector).

Note: Changes to the shader uniform will be effective on all instances using this ShaderMaterial. To prevent this, use per-instance uniforms with GeometryInstance3D.set_instance_shader_parameter or duplicate the ShaderMaterial resource using Resource.duplicate. Per-instance uniforms allow for better shader reuse and are therefore faster, so they should be preferred over duplicating the ShaderMaterial when possible.

void set_shader_parameter(StringName param, Variant value)

Parameters

param StringName

value Variant