Шейдеры частиц (particle)

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.

Шейдеры частиц уникальны тем, что они не используются для отрисовки самого объекта, а служат для расчета свойств частиц, которые затем используются шейдером CanvasItem или Spatial. Они содержат две функции процессора: start() и process().

В отличие от других типов шейдеров, шейдеры частиц сохраняют данные, которые были выведены на предыдущем кадре. Поэтому шейдеры частиц можно использовать для сложных эффектов, которые происходят в течение нескольких кадров.

Примечание

Шейдеры частиц доступны только для узлов частиц на базе GPU (GPUParticles2D и GPUParticles3D).

Узлы частиц на базе CPU (CPUParticles2D и CPUParticles3D) отрисовываются на GPU (что означает, что они могут использовать пользовательские шейдеры CanvasItem или Spatial), но их движение симулируется на CPU.

Режимы визуализации

Режим рендеринга	Описание
kеep_data	Не удаляет предыдущие данные при перезапуске.
disаble_force	Отключить силу притяжения.
disаble_velocity	Игнорировать значение `VELOCITY`.
collision_use_scale	Масштабирует размер частицы для столкновений.

Встроенные функции

Значения, отмеченные как in, доступны только для чтения. Значения, отмеченные как out, могут быть записаны и не обязательно содержат осмысленные значения. Значения, отмеченные как inout, предоставляют осмысленное значение по умолчанию и могут быть записаны. Сэмплеры не могут быть записаны, поэтому они не отмечены.

Глобальные встроенные функции

Глобальные встроенные модули доступны везде, включая пользовательские функции.

Встроенный	Описание
в плавающем 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.
в 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.
в float TAU	A `TAU` constant (`6.283185`). Equivalent to `PI * 2` and the number of radians in a full turn.
В float E	An `E` constant (`2.718281`). Euler's number, the base of the natural logarithm.

Встроенные Start и Process

Доступ к этим свойствам можно получить как из функций start(), так и из process().

Функция	Описание
in float LIFETIME	Время жизни частицы.
in float DELTA	Дельта времени процесса.
in uint NUMBER	Уникальный номер с момента начала эмиссии.
in uint INDEX	Индекс частиц (от общего количества частиц).
in mat4 EMISSION_TRANSFORM	Преобразование эмиттера (используется для нелокальных систем).
in uint RANDOM_SEED	Случайное начальное число используемое в качестве основы для случайного числа.
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	Скорость частиц, может быть изменена.
inout mat4 TRANSFORM	Преобразование частиц.
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	Вектор, который позволяет интегрировать дополнительные пользовательские данные в шейдер процесса частиц. `USERDATAX` — это шесть встроенных переменных, идентифицированных по номеру, `X` может быть числом от 1 до 6, например `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	Скорость узла Particles2D (3D).
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.

Примечание

Чтобы использовать переменную COLOR в StandardMaterial3D, установите vertex_color_use_as_albedo в true. В ShaderMaterial доступ к ней осуществляется с помощью переменной COLOR.

Встроенные константы функции Start

Встроенный	Описание
in bool RESTART_POSITION	`true`, если частица перезапущена или испущена без заданной позиции (т.е. эта частица была создана с помощью `emit_subparticle()` без флага `FLAG_EMIT_POSITION`).
in bool RESTART_ROT_SCALE	`true`, если частица перезапущена или испущена без заданного вращения или масштаба (т.е. эта частица была создана с помощью `emit_subparticle()` без флага `FLAG_EMIT_ROT_SCALE`).
in bool RESTART_VELOCITY	`true`, если частица перезапущена или испущена без заданной скорости (т.е. эта частица была создана с помощью `emit_subparticle()` без флага `FLAG_EMIT_VELOCITY`).
in bool RESTART_COLOR	`true`, если частица перезапущена или испущена без пользовательского цвета (т.е. эта частица была создана с помощью `emit_subparticle()` без флага `FLAG_EMIT_COLOR`).
in bool RESTART_CUSTOM	`true`, если частица перезапущена или испущена без пользовательского свойства (т.е. эта частица была создана с помощью `emit_subparticle()` без флага `FLAG_EMIT_CUSTOM`).

Встроенные константы функции Process

Встроенный	Описание
in bool RESTART	`true` if the current process frame is the first for the particle.
in bool COLLIDED	`true`, когда частица столкнулась с коллайдером частиц.
in vec3 COLLISION_NORMAL	Нормаль последнего столкновения. Если столкновение не обнаружено, оно равно `(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	Суммарная сила аттракторов, действующих в данный момент на эту частицу.

Функции процесса

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);

Функция	Описание
bool emit_subparticle (mat4 xform, vec3 velocity, vec4 color, vec4 custom, uint flags)	Испускает частицу из sub-emitter.