Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Shader

Hérite de : Resource < RefCounted < Object

Hérité par : VisualShader

Un shader implémenté dans le langage de shader de Godot.

Description

Un programme de shader personnalisé implémenté dans le langage de shader Godot, enregistré avec l'extension .gdshader.

Cette classe est utilisée par un ShaderMaterial et vous permet d'écrire votre propre comportement personnalisé pour rendre des objets visuels ou mettre à jour des informations de particules. Pour une explication et des utilisations détaillées, veuillez consulter les tutoriels ci-dessous.

Tutoriels

Index de la documentation sur les shaders

Propriétés

String

code

""

Méthodes

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)

Énumérations

enum Mode: 🔗

Mode MODE_SPATIAL = 0

Le mode utilise pour afficher tous les objets 3D.

Mode MODE_CANVAS_ITEM = 1

Le mode utilise pour afficher tous les objets 2D.

Mode MODE_PARTICLES = 2

Le mode utilisé pour calculer les informations pour chaque particule individuellement. N'est pas utilisé pour l'affichage.

Mode MODE_SKY = 3

Mode utilisé pour dessiner le ciel. Fonctionne seulement e avec des shaders attachés aux objets Sky.

Mode MODE_FOG = 4

Mode utilisé pour définir la couleur et la densité de l'effet de brouillard volumétrique.

Mode MODE_TEXTURE_BLIT = 5

Mode used for drawing to DrawableTexture resources via blit calls.

Descriptions des propriétés

String code = "" 🔗

void set_code(value: String)
String get_code()

Renvoie le code de shader comme l'utilisateur l'a écrit, et non le code entièrement généré utilisé en interne.

Descriptions des méthodes

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

Renvoie la texture définie par défaut pour le paramètre spécifié.

Note : name doit correspondre exactement au nom de l'uniforme dans le code.

Note : Si le tableau d''échantillonneur est utilisé, utilisez l'index index pour accéder à la texture spécifiée.

Mode get_mode() const 🔗

Renvoie le mode de shader pour le shader.

Array get_shader_uniform_list(get_groups: bool = false) 🔗

Renvoie la liste des uniforms du shader qui peuvent être affectés à un ShaderMaterial, pour utiliser avec ShaderMaterial.set_shader_parameter() et ShaderMaterial.get_shader_parameter(). Les paramètres renvoyés sont contenus dans des dictionnaires dans un format similaire à ceux renvoyés par Object.get_property_list().

Si l'argument get_groups vaut true, les indices de regroupement des paramètres sont également inclus dans la liste.

void inspect_native_shader_code() 🔗

Seulement disponible dans l'éditeur. Ouvre un popup qui visualise le code du shader généré, y compris toutes les variantes et le code interne du shader. Voir aussi Material.inspect_native_shader_code().

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

Définit la texture par défaut à utiliser avec un uniform de texture. La valeur par défaut est utilisée si une texture n'est pas définie dans le ShaderMaterial.

Note : name doit correspondre exactement au nom de l'uniform dans le code.

Note : Si le tableau d'échantillonneur est utilisé, utilisez index pour accéder à la texture spécifiée.