Shader

Hereda: Resource < RefCounted < Object

Heredado por: VisualShader

Un shader implementado en el lenguaje de sombreado Godot.

Descripción

A custom shader program implemented in the Godot shading language, saved with the .gdshader extension.

This class is used by a ShaderMaterial and allows you to write your own custom behavior for rendering visual items or updating particle information. For a detailed explanation and usage, please see the tutorials linked below.

Tutoriales

Índice de documentación de shaders

Propiedades

String

code

""

Métodos

Texture	get_default_texture_parameter(name: StringName, index: int = 0) const
Mode	get_mode() const
Array	get_shader_uniform_list(get_groups: bool = false)
void	inspect_native_shader_code()
void	set_default_texture_parameter(name: StringName, texture: Texture, index: int = 0)

Enumeraciones

enum Mode: 🔗

Mode MODE_SPATIAL = 0

Modo utilizado para dibujar todos los objetos 3D.

Mode MODE_CANVAS_ITEM = 1

El modo utilizado para dibujar todos los objetos 2D.

Mode MODE_PARTICLES = 2

Modo utilizado para calcular la información de las partículas en base a cada una de ellas. No se usa para dibujar.

Mode MODE_SKY = 3

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

Mode MODE_FOG = 4

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

Descripciones de Propiedades

String code = "" 🔗

void set_code(value: String)
String get_code()

Devuelve el código del shader tal y como lo ha escrito el usuario, no el código generado completo usado internamente.

Descripciones de Métodos

Texture get_default_texture_parameter(name: StringName, index: int = 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.

Mode get_mode() const 🔗

Returns the shader mode for the shader.

Array get_shader_uniform_list(get_groups: bool = 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(name: StringName, texture: Texture, index: int = 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.