ParticleBufferBuilder

Description

sealed class Tinman.Engine.Particles.ParticleBufferBuilder

A builder for ParticleBuffer objects.

[OwnerReturn]
public method Build → ()

Builds a ParticleBuffer object using the current builder options.

public method Capacity → (1)

value ⁱⁿ : int32: The particle buffer capacity. Will be clamped to [256..1048576].
returns → ParticleBufferBuilder: this

Specifies the capacity of the particle buffer.

Defaults to 65536 particles.

public method Data → (1)

semantic ⁱⁿ : Semantic: [not-null]
The vertex array semantic that represents the particle data to add.
returns → ParticleBufferBuilder: this

Specifies additional particle data.

The following particle data is created by the ParticleBuffer class is is thus always available:

The used IParticleUpdater object will create required particle data automatically. Additional optional particle data may be added with this method.

public method Rate → (1)

value ⁱⁿ : int32: The desired update rate, in Hz. Will be clamped to [1..100].
returns → ParticleBufferBuilder: this

Specifies the update rate of the particle simulation.

Defaults to 12 Hz.

public method Updater → (1)

Specifies the particle updater to use for background particle simulation.

Defaults to a dummy particle updater that does not update any particle data.