Table of Contents

Class ParticleFields

Namespace
Stride.Particles
Assembly
Stride.Particles.dll
public static class ParticleFields
Inheritance
ParticleFields

Fields

Angle

public static readonly ParticleFieldDescription<float> Angle

Field Value

ParticleFieldDescription<float>

ChildOrder

Order of the particle's children, which is based on their spawn order

public static readonly ParticleFieldDescription<uint> ChildOrder

Field Value

ParticleFieldDescription<uint>

ChildrenFlags

ChildrenFlags is used to store meta-data for the dependent particles

public static readonly ParticleFieldDescription<ParticleChildrenAttribute>[] ChildrenFlags

Field Value

ParticleFieldDescription<ParticleChildrenAttribute>[]

ChildrenFlagsLength

public static readonly int ChildrenFlagsLength

Field Value

int

CollisionControl

Provides control flags for particles which have collision enabled

public static readonly ParticleFieldDescription<ParticleCollisionAttribute> CollisionControl

Field Value

ParticleFieldDescription<ParticleCollisionAttribute>

Color

public static readonly ParticleFieldDescription<Color4> Color

Field Value

ParticleFieldDescription<Color4>

Color4

public static readonly ParticleFieldDescription<Color4> Color4

Field Value

ParticleFieldDescription<Color4>

Direction

Particle direction, or offset, in 3D space, calculated from the particle's position

public static readonly ParticleFieldDescription<Vector3> Direction

Field Value

ParticleFieldDescription<Vector3>

Life

public static readonly ParticleFieldDescription<float> Life

Field Value

ParticleFieldDescription<float>

OldPosition

Particle position from the last frame in 3D space, updated every frame if the particle has a Position field

public static readonly ParticleFieldDescription<Vector3> OldPosition

Field Value

ParticleFieldDescription<Vector3>

Order

Order of the particle, which can be based on spawn order or something else

public static readonly ParticleFieldDescription<uint> Order

Field Value

ParticleFieldDescription<uint>

Position

Particle position in 3D space

public static readonly ParticleFieldDescription<Vector3> Position

Field Value

ParticleFieldDescription<Vector3>

Quaternion

Quaternion rotation, for particles which have rotation in 3D

public static readonly ParticleFieldDescription<Quaternion> Quaternion

Field Value

ParticleFieldDescription<Quaternion>

RandomSeed

Random seed, for generating fast random values in runtime.

public static readonly ParticleFieldDescription<RandomSeed> RandomSeed

Field Value

ParticleFieldDescription<RandomSeed>

RemainingLife

Particle remaining lifetime. When it reaches 0, the particle dies. Remaining life is easier to work with because it is an absolute value. Total life needs to know what the maximum life is.

public static readonly ParticleFieldDescription<float> RemainingLife

Field Value

ParticleFieldDescription<float>

Rgba

Particle color, in RGBA.

public static readonly ParticleFieldDescription<Color4> Rgba

Field Value

ParticleFieldDescription<Color4>

Rotation

Angular rotation, in RADIANS, for particles which only have 1 axis of rotation

public static readonly ParticleFieldDescription<float> Rotation

Field Value

ParticleFieldDescription<float>

Rotation1D

public static readonly ParticleFieldDescription<float> Rotation1D

Field Value

ParticleFieldDescription<float>

Rotation3D

public static readonly ParticleFieldDescription<Quaternion> Rotation3D

Field Value

ParticleFieldDescription<Quaternion>

Scale

public static readonly ParticleFieldDescription<float> Scale

Field Value

ParticleFieldDescription<float>

Size

Particle uniform size. If particles are rendered as a 2D quads or 3D meshes, these extra dimensions can be set on the material side.

public static readonly ParticleFieldDescription<float> Size

Field Value

ParticleFieldDescription<float>

Speed

public static readonly ParticleFieldDescription<Vector3> Speed

Field Value

ParticleFieldDescription<Vector3>

Velocity

Particle velocity in 3D space

public static readonly ParticleFieldDescription<Vector3> Velocity

Field Value

ParticleFieldDescription<Vector3>