Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    ParticleFields Class

    Namespace: Stride.Particles
    Assembly: Stride.Particles.dll
    System.Object → ParticleFields
    Derived from ParticleFields:

    public static class ParticleFields
    Name Description
    Fields
    Angle
    ChildOrder

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

    ChildrenFlags

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

    ChildrenFlagsLength
    CollisionControl

    Provides control flags for particles which have collision enabled

    Color
    Color4
    Direction

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

    Life
    OldPosition

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

    Order

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

    Position

    Particle position in 3D space

    Quaternion

    Quaternion rotation, for particles which have rotation in 3D

    RandomSeed

    Random seed, for generating fast random values in runtime.

    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.

    Rgba

    Particle color, in RGBA.

    Rotation

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

    Rotation1D
    Rotation3D
    Scale
    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.

    Speed
    Velocity

    Particle velocity in 3D space

    | Improve this Doc View Source

    Fields


    Angle

    public static readonly ParticleFieldDescription<float> Angle
    Field Value
    Type Description
    ParticleFieldDescription<System.Single>

    ChildOrder

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

    public static readonly ParticleFieldDescription<uint> ChildOrder
    Field Value
    Type Description
    ParticleFieldDescription<System.UInt32>

    ChildrenFlags

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

    public static readonly ParticleFieldDescription<ParticleChildrenAttribute>[] ChildrenFlags
    Field Value
    Type Description
    ParticleFieldDescription<ParticleChildrenAttribute>[]

    ChildrenFlagsLength

    public static readonly int ChildrenFlagsLength
    Field Value
    Type Description
    System.Int32

    CollisionControl

    Provides control flags for particles which have collision enabled

    public static readonly ParticleFieldDescription<ParticleCollisionAttribute> CollisionControl
    Field Value
    Type Description
    ParticleFieldDescription<ParticleCollisionAttribute>

    Color

    public static readonly ParticleFieldDescription<Color4> Color
    Field Value
    Type Description
    ParticleFieldDescription<Color4>

    Color4

    public static readonly ParticleFieldDescription<Color4> Color4
    Field Value
    Type Description
    ParticleFieldDescription<Color4>

    Direction

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

    public static readonly ParticleFieldDescription<Vector3> Direction
    Field Value
    Type Description
    ParticleFieldDescription<Vector3>

    Life

    public static readonly ParticleFieldDescription<float> Life
    Field Value
    Type Description
    ParticleFieldDescription<System.Single>

    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
    Type Description
    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
    Type Description
    ParticleFieldDescription<System.UInt32>

    Position

    Particle position in 3D space

    public static readonly ParticleFieldDescription<Vector3> Position
    Field Value
    Type Description
    ParticleFieldDescription<Vector3>

    Quaternion

    Quaternion rotation, for particles which have rotation in 3D

    public static readonly ParticleFieldDescription<Quaternion> Quaternion
    Field Value
    Type Description
    ParticleFieldDescription<Quaternion>

    RandomSeed

    Random seed, for generating fast random values in runtime.

    public static readonly ParticleFieldDescription<RandomSeed> RandomSeed
    Field Value
    Type Description
    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
    Type Description
    ParticleFieldDescription<System.Single>

    Rgba

    Particle color, in RGBA.

    public static readonly ParticleFieldDescription<Color4> Rgba
    Field Value
    Type Description
    ParticleFieldDescription<Color4>

    Rotation

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

    public static readonly ParticleFieldDescription<float> Rotation
    Field Value
    Type Description
    ParticleFieldDescription<System.Single>

    Rotation1D

    public static readonly ParticleFieldDescription<float> Rotation1D
    Field Value
    Type Description
    ParticleFieldDescription<System.Single>

    Rotation3D

    public static readonly ParticleFieldDescription<Quaternion> Rotation3D
    Field Value
    Type Description
    ParticleFieldDescription<Quaternion>

    Scale

    public static readonly ParticleFieldDescription<float> Scale
    Field Value
    Type Description
    ParticleFieldDescription<System.Single>

    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
    Type Description
    ParticleFieldDescription<System.Single>

    Speed

    public static readonly ParticleFieldDescription<Vector3> Speed
    Field Value
    Type Description
    ParticleFieldDescription<Vector3>

    Velocity

    Particle velocity in 3D space

    public static readonly ParticleFieldDescription<Vector3> Velocity
    Field Value
    Type Description
    ParticleFieldDescription<Vector3>

    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation