Shader

Inherits: Resource < RefCounted < Object

Inherited By: VisualShader

A custom shader program.

Description

This class allows you to define a custom shader program that can be used by a ShaderMaterial. Shaders allow you to write your own custom behavior for rendering objects or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.

Properties

String

code

""

Methods

Texture2D

get_default_texture_param ( StringName param, int index=0 ) const

Mode

get_mode ( ) const

bool

has_param ( StringName name ) const

void

set_default_texture_param ( StringName param, Texture2D texture, int index=0 )

Enumerations

enum Mode:

  • MODE_SPATIAL = 0 --- Mode used to draw all 3D objects.

  • MODE_CANVAS_ITEM = 1 --- Mode used to draw all 2D objects.

  • MODE_PARTICLES = 2 --- Mode used to calculate particle information on a per-particle basis. Not used for drawing.

  • MODE_SKY = 3 --- Mode used for drawing skies. Only works with shaders attached to Sky objects.

  • MODE_FOG = 4 --- Mode used for setting the color and density of volumetric fog effect.

Property Descriptions

Default

""

Setter

set_code(value)

Getter

get_code()

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

Method Descriptions

Returns the texture that is set as default for the specified parameter.

Note: param 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 get_mode ( ) const

Returns the shader mode for the shader, either MODE_CANVAS_ITEM, MODE_SPATIAL or MODE_PARTICLES.


Returns true if the shader has this param defined as a uniform in its code.

Note: param must match the name of the uniform in the code exactly.


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: param 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.