Class Particles

The particles simulation service.

Particles
Assembly: FlaxEngine.dll
File: Engine/Particles/Particles.h
Syntax
public class Particles

Fields

EnableParticleBufferPooling

Enables or disables particle buffer pooling.

Declaration
public static bool EnableParticleBufferPooling
Field Value
bool

ParticleBufferRecycleTimeout

The particle buffer recycle timeout (in seconds).

Declaration
public static float ParticleBufferRecycleTimeout
Field Value
float

Methods

AcquireParticleBuffer(ParticleEmitter* emitter)

Acquires the free particle buffer for the emitter instance data.

Declaration
public static ParticleBuffer* AcquireParticleBuffer(ParticleEmitter* emitter)
Parameters
ParticleEmitter emitter

The emitter.
Returns
ParticleBuffer

The particle buffer.

DrawParticles(RenderContext& renderContext, ParticleEffect* effect)

Draws the particles.

Declaration
public static void DrawParticles(RenderContext& renderContext, ParticleEffect* effect)
Parameters
RenderContext renderContext

The rendering context.
ParticleEffect effect

The owning actor.

OnEffectDestroy(ParticleEffect* effect)

Called when effect gets removed from gameplay. All references to it should be cleared.

Declaration
public static void OnEffectDestroy(ParticleEffect* effect)
Parameters
ParticleEffect effect

The effect.

OnEmitterUnload(ParticleEmitter* emitter)

Called when emitter gets unloaded. Particle buffers using this emitter has to be cleared.

Declaration
public static void OnEmitterUnload(ParticleEmitter* emitter)
Parameters
ParticleEmitter emitter

The emitter.

RecycleParticleBuffer(ParticleBuffer* buffer)

Recycles the used particle buffer.

Declaration
public static void RecycleParticleBuffer(ParticleBuffer* buffer)
Parameters
ParticleBuffer buffer

The particle buffer.

UpdateEffect(ParticleEffect* effect)

Updates the effect during next particles simulation tick.

Declaration
public static void UpdateEffect(ParticleEffect* effect)
Parameters
ParticleEffect effect

The effect.