Class ParticleSystemInstance

The particle system simulation graph instance data storage. Required to update the particles.

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

Constructors

~ParticleSystemInstance()

Finalizes an instance of the ParticleSystemInstance class.

Declaration
public ~ParticleSystemInstance()

Fields

Emitters

The particle system emitters data (one per emitter instance).

Declaration
public Array<ParticleEmitterInstance> Emitters
Field Value
Array<ParticleEmitterInstance>

GPUParticlesCountReadback

The GPU staging readback buffer used to copy the GPU particles count from the GPU buffers and read them on a CPU.

Declaration
public GPUBuffer* GPUParticlesCountReadback = nullptr
Field Value
GPUBuffer

LastUpdateTime

The last game time when particle system was updated. Value -1 indicates no previous updates.

Declaration
public float LastUpdateTime = -1
Field Value
float

ParametersVersion

The parameters version number. Incremented every time the instance data gets synchronized with system or emitter when it ahs been modified.

Declaration
public uint32 ParametersVersion = 0
Field Value
uint32

Time

The total system playback time.

Declaration
public float Time
Field Value
float

Version

The instance data version number. Used to sync the Particle System data with the instance state. Handles Particle System reloads to enure data is valid.

Declaration
public uint32 Version = 0
Field Value
uint32

Methods

ClearState()

Clears this container state data.

Declaration
public void ClearState()

ContainsEmitter(ParticleEmitter* emitter)

Determines whether the specified emitter is used by this instance.

Declaration
public bool ContainsEmitter(ParticleEmitter* emitter) const
Parameters
ParticleEmitter emitter

The emitter.
Returns
bool

true if the specified emitter is used; otherwise, false.

GetParticlesCount()

Gets the particles count (total). GPU particles count is read with one frame delay (due to GPU execution).

Declaration
public int32 GetParticlesCount() const
Returns
int32

The particles amount.

Sync(ParticleSystem* system)

Synchronizes the instance data with the specified system.

Declaration
public void Sync(ParticleSystem* system)
Parameters
ParticleSystem system

The system.