Shader

String code = ""

Returns the shader's code as the user has written it, not the full generated code used internally.

Texture get_default_texture_parameter(StringName name, int index = 0) const

Returns the texture that is set as default for the specified parameter. Note: name must match the name of the uniform in the code exactly. Note: If the sampler array is used use index to access the specified texture.

int get_mode() const

Returns the shader mode for the shader.

Array get_shader_uniform_list(bool get_groups = false)

Returns the list of shader uniforms that can be assigned to a ShaderMaterial, for use with ShaderMaterial.set_shader_parameter() and ShaderMaterial.get_shader_parameter(). The parameters returned are contained in dictionaries in a similar format to the ones returned by Object.get_property_list(). If argument get_groups is true, parameter grouping hints are also included in the list.

void inspect_native_shader_code()

Only available when running in the editor. Opens a popup that visualizes the generated shader code, including all variants and internal shader code. See also Material.inspect_native_shader_code().

void set_default_texture_parameter(StringName name, Texture texture, int index = 0)

Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the ShaderMaterial. Note: name must match the name of the uniform in the code exactly. Note: If the sampler array is used use index to access the specified texture.

MODE_SPATIAL = 0

Enum: Mode

Mode used to draw all 3D objects.

MODE_CANVAS_ITEM = 1

Enum: Mode

Mode used to draw all 2D objects.

MODE_PARTICLES = 2

Enum: Mode

Mode used to calculate particle information on a per-particle basis. Not used for drawing.

MODE_SKY = 3

Enum: Mode

Mode used for drawing skies. Only works with shaders attached to Sky objects.

MODE_FOG = 4

Enum: Mode

Mode used for setting the color and density of volumetric fog effect.