Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

ShaderMaterial

Inherits: Material < Resource < RefCounted < Object

A material that uses a custom Shader program.

Description

A material that uses a custom Shader program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader.

Tutorials

• Shaders documentation index

Properties

Methods

Property Descriptions

Shader shader

• void set_shader ( Shader value )

• Shader get_shader ( )

The Shader program used to render this material.

Method Descriptions

Variant get_shader_parameter ( StringName param ) const

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

void set_shader_parameter ( StringName param, Variant value )

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.