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

Partikel-Shader

Particle shaders are a special type of shader that runs before the object is drawn. They are used for calculating material properties such as color, position, and rotation. They can be drawn with any regular material for CanvasItem or Spatial, depending on whether they are 2D or 3D.

Particle shaders are unique because they are not used to draw the object itself; they are used to calculate particle properties, which are then used by a CanvasItem or Spatial shader. They contain two processor functions: start() and process().

Im Gegensatz zu anderen Shader-Typen behalten Partikel-Shader die Daten, die im vorherigen Frame ausgegeben wurden. Daher können Partikel-Shader für komplexe Effekte verwendet werden, die sich über mehrere Frames erstrecken.

Bemerkung

Partikel-Shader sind nur bei GPU-basierten Nodes (GPUParticles2D und GPUParticles3D) verfügbar.

CPU-basierte Partikel-Nodes (CPUParticles2D und CPUParticles3D) werden auf der GPU gerendert (d.h. sie können benutzerdefinierte CanvasItem- oder Spatial-Shader verwenden), aber ihre Bewegung wird auf der CPU simuliert.

Render-Modi

Rendermodus	Beschreibung
keep_data	Beim Neustart keine vorherigen Daten löschen.
disable_force	Attraktor-Kraft deaktivieren.
disable_velocity	Ignore VELOCITY value.
collision_use_scale	Skalierung der Partikelgröße für Kollisionen.

Built-ins

Values marked as in are read-only. Values marked as out can optionally be written to and will not necessarily contain sensible values. Values marked as inout provide a sensible default value, and can optionally be written to. Samplers cannot be written to so they are not marked.

Globale Built-ins

Globale Built-ins sind überall verfügbar, einschließlich benutzerdefinierter Funktionen.

Built-in	Beschreibung
in float TIME	Global time since the engine has started, in seconds. It repeats after every 3,600 seconds (which can be changed with the rollover setting). It's affected by time_scale but not by pausing. If you need a TIME variable that is not affected by time scale, add your own global shader uniform and update it each frame.
in float PI	A PI constant (3.141592). The ratio of a circle's circumference to its diameter and the number of radians in a half turn.
in float TAU	A TAU constant (6.283185). Equivalent to PI * 2 and the number of radians in a full turn.
in float E	An E constant (2.718281). Euler's number, the base of the natural logarithm.

Start- und Prozess-Built-ins

Auf diese Propertys kann sowohl von den start() als auch von den process()-Funktionen zugegriffen werden.

Funktion	Beschreibung
in float LIFETIME	Partikel-Lebensdauer.
in float DELTA	Delta-Ausführungszeit.
in uint NUMBER	Eindeutige Nummer seit Emissionsbeginn.
in uint INDEX	Partikelindex (von Gesamtpartikeln).
in mat4 EMISSION_TRANSFORM	Emitter-Transformation (wird für nicht-lokale Systeme verwendet).
in uint RANDOM_SEED	Zufälliger Seed, der als Basis für random verwendet wird.
inout bool ACTIVE	true when the particle is active, can be set to false.
inout vec4 COLOR	Particle color, can be written to and accessed in the mesh's vertex function.
inout vec3 VELOCITY	Partikelgeschwindigkeit, kann geändert werden.
inout mat4 TRANSFORM	Partikeltransformation.
inout vec4 CUSTOM	Custom particle data. Accessible from the mesh's shader as INSTANCE_CUSTOM.
inout float MASS	Particle mass, intended to be used with attractors. 1.0 by default.
in vec4 USERDATAX	Vector that enables the integration of supplementary user-defined data into the particle process shader. USERDATAX are six built-ins identified by number, X can be numbers between 1 and 6, for example USERDATA3.
in uint FLAG_EMIT_POSITION	A flag for the last argument of the emit_subparticle() function to assign a position to a new particle's transform.
in uint FLAG_EMIT_ROT_SCALE	A flag for the last argument of the emit_subparticle() function to assign a rotation and scale to a new particle's transform.
in uint FLAG_EMIT_VELOCITY	A flag for the last argument of the emit_subparticle() function to assign a velocity to a new particle.
in uint FLAG_EMIT_COLOR	A flag for the last argument of the emit_subparticle() function to assign a color to a new particle.
in uint FLAG_EMIT_CUSTOM	A flag for the last argument of the emit_subparticle() function to assign a custom data vector to a new particle.
in vec3 EMITTER_VELOCITY	Velocity of the Particles2D (3D) node.
in float INTERPOLATE_TO_END	Value of the interp_to_end (3D) property of the Particles node.
in uint AMOUNT_RATIO	Value of the amount_ratio (3D) property of the Particles node.

Bemerkung

Um die COLOR Variable in einem StandardMaterial3D zu benutzen, setzen Sie vertex_color_use_as_albedo auf true. In einem ShaderMaterial greifen Sie mit der Variable COLOR darauf zu.

Start-Built-ins

Built-in	Beschreibung
in bool RESTART_POSITION	true, wenn der Partikel neu gestartet wurde, oder ohne eigene Position emittiert wurde (d.h. dieser Partikel wurde mit emit_subparticle() ohne das FLAG_EMIT_POSITION Flag erzeugt).
in bool RESTART_ROT_SCALE	true, wenn der Partikel neu gestartet oder ohne eigene Rotation oder Skalierung emittiert wurde (d.h. dieser Partikel wurde mit emit_subparticle() ohne das FLAG_EMIT_ROT_SCALE Flag erzeugt).
in bool RESTART_VELOCITY	true, wenn der Partikel neu gestartet oder ohne eigene Geschwindigkeit emittiert wurde (d.h. dieser Partikel wurde mit emit_subparticle() ohne das FLAG_EMIT_VELOCITY-Flag erzeugt).
in bool RESTART_COLOR	true, wenn der Partikel neu gestartet oder ohne eigene Farbe emittiert wurde (d.h. dieser Partikel wurde mit emit_subparticle() ohne das FLAG_EMIT_COLOR-Flag erzeugt).
in bool RESTART_CUSTOM	true, wenn der Partikel neu gestartet wurde oder ohne eine eigene Property emittiert wurde (d.h. dieser Partikel wurde mit emit_subparticle() ohne das FLAG_EMIT_CUSTOM-Flag erzeugt).

Prozess-Built-ins

Built-in	Beschreibung
in bool RESTART	true if the current process frame is the first for the particle.
in bool COLLIDED	true, wenn das Partikel mit einem Partikel-Collider zusammengestoßen ist.
in vec3 COLLISION_NORMAL	A normal of the last collision. If there is no collision detected it is equal to (0.0, 0.0, 0.0).
in float COLLISION_DEPTH	A length of the normal of the last collision. If there is no collision detected it is equal to 0.0.
in vec3 ATTRACTOR_FORCE	Eine kombinierte Kraft der Attraktoren im Moment auf dieses Teilchen.

Prozess-Funktionen

emit_subparticle() is currently the only custom function supported by particle shaders. It allows users to add a new particle with specified parameters from a sub-emitter. The newly created particle will only use the properties that match the flags parameter. For example, the following code will emit a particle with a specified position, velocity, and color, but unspecified rotation, scale, and custom value:

mat4 custom_transform = mat4(1.0);
custom_transform[3].xyz = vec3(10.5, 0.0, 4.0);
emit_subparticle(custom_transform, vec3(1.0, 0.5, 1.0), vec4(1.0, 0.0, 0.0, 1.0), vec4(1.0), FLAG_EMIT_POSITION | FLAG_EMIT_VELOCITY | FLAG_EMIT_COLOR);

Funktion	Beschreibung
bool emit_subparticle (mat4 xform, vec3 velocity, vec4 color, vec4 custom, uint flags)	Sendet ein Partikel von einem Sub-Emitter aus.