EmitterDesc

Structure representing the needed information for the creation of particle emitters.

File location: framework/cauldron/framework/inc/render/particle.h

Enumerations

Name

Description

EmitterFlags

EF_Streaks = 1 << 0 – Streak the particles based on velocity.
EF_Reactive = 1 << 1 – Particles also write to the reactive mask.

Detailed description

Structure representing the needed information for the creation of particle emitters.

Data fields

Type

Description

std::wstring

EmitterName
The emitter’s name.

Vec3

SpawnOffset
The emitter’s spawning offset (optional).

Vec3

SpawnOffsetVariance
The emitter’s spawning offset variance (vector) (optional).

Vec3

SpawnVelocity
The emitter’s spawning velocity (optional).

float

SpawnVelocityVariance
The emitter’s spawning velocity variance (magnitude) (optional)

uint32_t

ParticlesPerSecond
The emitter’s spawning rate in particles spawned per second.

float

Lifespan
The emitter’s particle’s lifetime (how long it stays active).

float

SpawnSize
The emitter’s particle’s size at creation.

float

KillSize
The emitter’s particle’s size at death.

float

Mass
The emitter’s particle’s mass.

int32_t

AtlasIndex
The emitter’s particle’s backing sub-resource in the particle spawner texture atlas.

int

Flags
The emitter’s “EmitterFlags“.