babylon.quarks - v1.0.0
    Preparing search index...

    Interface ParticleSystemParameters

    Settings for a new ParticleSystem. Every one is optional: a setting left out takes the default named on it, the same default fromJSON gives a file that leaves it out.

    interface ParticleSystemParameters {
        alignToDirection?: boolean;
        alphaTest?: number;
        applyFog?: boolean;
        applyImageProcessing?: boolean;
        behaviors?: Behavior[];
        blendMode?: number;
        blendTiles?: boolean;
        cullingMode?: CullingMode;
        depthTest?: boolean;
        depthWrite?: boolean;
        duration?: number;
        emissionBursts?: BurstParameters[];
        emissionOverDistance?: ValueGenerator | FunctionValueGenerator;
        emissionOverTime?: ValueGenerator | FunctionValueGenerator;
        erosion?: ParticleErosionOptions;
        flip?: Vector2Like;
        gradientMap?: Partial<ParticleGradientMap>;
        instancingColors?: Float32Array<ArrayBufferLike>;
        instancingGeometry?: Float32Array<ArrayBufferLike>;
        instancingIndices?:
            | Uint32Array<ArrayBufferLike>
            | Uint16Array<ArrayBufferLike>;
        instancingNormals?: Float32Array<ArrayBufferLike>;
        instancingUVs?: Float32Array<ArrayBufferLike>;
        instancingUVs2?: Float32Array<ArrayBufferLike>;
        layerMask?: number;
        lighting?: MeshLighting;
        looping?: boolean;
        mapUV?: Partial<TextureUV>;
        material?: ParticleMaterialSource | null;
        materialColor?: Color4Like;
        materialColorScale?: number;
        maxParticles?: number;
        maxParticleSize?: number;
        minParticleSize?: number;
        onlyUsedByOther?: boolean;
        particleColor?: boolean;
        pivot?: Vector3Like;
        playbackSpeed?: number;
        premultipliedMap?: boolean;
        prewarm?: boolean;
        prewarmTime?: number;
        renderAlignment?: RenderAlignment;
        rendererEmitterSettings?: RendererEmitterSettings;
        renderFace?: RenderFace;
        renderingGroupId?: number;
        renderMode?: RenderMode;
        renderOrder?: number;
        rim?: Partial<MeshRim>;
        ringBufferLoopRange?: Vector2Like;
        ringBufferMode?: RingBufferMode;
        rotationAxis?: RotationAxis;
        scalingMode?: ScalingMode;
        scene?: Scene;
        seed?: number;
        shape?: EmitterShape;
        softFarFade?: number;
        softNearFade?: number;
        softParticles?: boolean;
        sortingFudge?: number;
        sortMode?: SortMode;
        startColor?: ColorGenerator | FunctionColorGenerator;
        startDelay?: ValueGenerator | FunctionValueGenerator;
        startLife?: ValueGenerator | FunctionValueGenerator;
        startRotation?: ValueGenerator | FunctionValueGenerator | RotationGenerator;
        startSize?: ValueGenerator | FunctionValueGenerator | Vector3Generator;
        startSpeed?: ValueGenerator | FunctionValueGenerator;
        startTileIndex?: ValueGenerator;
        stopAction?: StopAction;
        texture?: Texture | null;
        transparent?: boolean;
        uTileCount?: number;
        uvDistortion?: ParticleUVDistortionOptions;
        vTileCount?: number;
        worldSpace?: boolean;
    }
    Index
    alignToDirection?: boolean

    Whether particles start turned along their direction of travel, see ParticleSystem.alignToDirection. Default false.

    alphaTest?: number

    Alpha below which a fragment is discarded, 0 to 1. Default 0: nothing is.

    applyFog?: boolean

    Whether the scene's fog applies, see ParticleSystem.applyFog. Default true.

    applyImageProcessing?: boolean

    Whether the scene's image processing applies, see ParticleSystem.applyImageProcessing. Default true.

    behaviors?: Behavior[]

    See ParticleSystem.behaviors. Default none.

    blendMode?: number

    Babylon alpha mode the batch blends with, see ParticleSystem.blending. Default Constants.ALPHA_ADD.

    blendTiles?: boolean

    See ParticleSystem.blendTiles. Default false.

    cullingMode?: CullingMode

    What the system does while off screen, see CullingMode. Default 'always'.

    depthTest?: boolean

    Whether particles are hidden behind nearer geometry. false draws them over everything (Unity's ZTest Always), in every render mode. Default true.

    depthWrite?: boolean

    Whether the particles write depth. Default: as the surface, !transparent (opaque and cutout systems write depth, transparent ones do not), as Unity's particle materials do.

    duration?: number

    See ParticleSystem.duration. Default 1 second.

    emissionBursts?: BurstParameters[]

    See ParticleSystem.emissionBursts. Default none.

    emissionOverDistance?: ValueGenerator | FunctionValueGenerator

    See ParticleSystem.emissionOverTime. Default 10 per second.

    Alpha erosion, see ParticleSystem.erosion. Default none.

    Fraction of billboard particles mirrored along U (x) and V (y), see ParticleSystem.flip.

    gradientMap?: Partial<ParticleGradientMap>

    Colour ramp for the map, see ParticleSystem.gradientMap. Default none.

    instancingColors?: Float32Array<ArrayBufferLike>
    instancingGeometry?: Float32Array<ArrayBufferLike>

    Mesh particles' vertex positions, three values per vertex. Default a unit quad in XY.

    instancingIndices?: Uint32Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike>

    Triangle indices into instancingGeometry. Default the unit quad's two triangles.

    instancingNormals?: Float32Array<ArrayBufferLike>

    Mesh particles' vertex normals, three values per vertex. Default +Z for every vertex.

    instancingUVs?: Float32Array<ArrayBufferLike>

    Mesh particles' first UV set, two values per vertex. Default the quad's UVs, or zeros for another geometry.

    instancingUVs2?: Float32Array<ArrayBufferLike>

    A second UV set for the mesh (glTF TEXCOORD_1, Unity's uv2), what textures on UV channel 1 read on a mesh particle; see UVChannel. Default none: channel 1 reads the first set.

    layerMask?: number

    Camera layer mask the batch draws for, see ParticleSystem.layers. Default 0x0fffffff.

    lighting?: MeshLighting

    How mesh particles are lit, see ParticleSystem.lighting. Default 'fixed'.

    looping?: boolean

    See ParticleSystem.looping. Default true.

    mapUV?: Partial<TextureUV>

    The main map's layout, see ParticleSystem.mapUV. Default as drawn.

    material?: ParticleMaterialSource | null

    See ParticleSystem.material. Default none.

    materialColor?: Color4Like

    The material's colour, see ParticleSystem.materialColor. Default white.

    materialColorScale?: number

    What the material's colour is multiplied by in linear space, see ParticleSystem.materialColorScale. Default 1.

    maxParticles?: number

    Most particles alive at once; emission past it is dropped. Leave unset for no limit.

    maxParticleSize?: number

    Largest on-screen size, as a fraction of the viewport height, see ParticleSystem.maxParticleSize. Default unlimited.

    minParticleSize?: number

    Smallest on-screen size, as a fraction of the viewport height, see ParticleSystem.minParticleSize. Default 0.

    onlyUsedByOther?: boolean

    See ParticleSystem.onlyUsedByOther. Default false.

    particleColor?: boolean

    Whether the particle's colour is drawn, see ParticleSystem.particleColor. Default true.

    pivot?: Vector3Like

    Billboard pivot in particle-size units, see VFXBatchSettings.pivot.

    playbackSpeed?: number

    Multiplier on the time the system is advanced by, see ParticleSystem.playbackSpeed. Default 1.

    premultipliedMap?: boolean

    Whether the texture's colour is already premultiplied, see ParticleSystem.premultipliedMap. Default false.

    prewarm?: boolean

    See ParticleSystem.prewarm. Default false.

    prewarmTime?: number

    See ParticleSystem.prewarmTime. Default 0: a whole cycle; only with prewarm on a looping system.

    renderAlignment?: RenderAlignment

    The axes a mesh particle's rotation is measured in and a billboard is laid along, see ParticleSystem.renderAlignment. Default 'simulation'.

    rendererEmitterSettings?: RendererEmitterSettings

    See ParticleSystem.rendererEmitterSettings. Default the render mode's own.

    renderFace?: RenderFace

    Which faces a mesh particle draws, see ParticleSystem.renderFace. Default 'both'.

    renderingGroupId?: number

    Babylon rendering group of the batch, see ParticleSystem.renderingGroupId. Default 0.

    renderMode?: RenderMode

    See ParticleSystem.renderMode. Default RenderMode.BillBoard.

    renderOrder?: number
    rim?: Partial<MeshRim>

    Rim (Fresnel) term on mesh particles, see ParticleSystem.rim. Default none.

    ringBufferLoopRange?: Vector2Like

    See ParticleSystem.ringBufferLoopRange. Default the whole life, (0, 1).

    ringBufferMode?: RingBufferMode

    What a full system does with new particles, see RingBufferMode. Default 'disabled'.

    rotationAxis?: RotationAxis

    The axis a number rotation turns a mesh about, see RotationAxis. Default 'z'.

    scalingMode?: ScalingMode

    What the emitter's scale does to the system, see ScalingMode. Default 'local'.

    scene?: Scene

    Scene the emitter node is created in. Default Babylon's last created scene.

    seed?: number

    Seed for this system's own random generator, see ParticleSystem.seed. Default none.

    shape?: EmitterShape

    Where particles are born and which way they start, see ParticleSystem.emitterShape. Default a SphereEmitter.

    softFarFade?: number
    softNearFade?: number
    softParticles?: boolean

    Fade particles out as they near the scene behind them, like Unity's Soft Particles and Unreal's Depth Fade, between softNearFade and softFarFade world units. Needs a depth texture, see BatchedRenderer.setDepthTexture; without one particles draw hard. Applies to every render mode: billboard, stretched, mesh, beam and trail.

    sortingFudge?: number

    How far the system sorts behind or in front of others, see ParticleSystem.sortingFudge. Default 0.

    sortMode?: SortMode

    Draw order within the batch, see ParticleSystem.sortMode. Default 'none'.

    See ParticleSystem.startColor. Default opaque white.

    See ParticleSystem.startDelay. Default 0.

    See ParticleSystem.startLife. Default 5 seconds.

    See ParticleSystem.startSize. Default 1.

    See ParticleSystem.startSpeed. Default 0.

    startTileIndex?: ValueGenerator
    stopAction?: StopAction

    What the system does once it has finished, see StopAction. Default 'none'.

    texture?: Texture | null

    See ParticleSystem.texture. Unset takes the material's texture; null draws without one.

    transparent?: boolean

    Whether the batch draws in the transparent pass. Default true.

    uTileCount?: number

    See ParticleSystem.uTileCount. Default 1.

    Map UV distortion, see ParticleSystem.uvDistortion. Default none.

    vTileCount?: number

    See ParticleSystem.vTileCount. Default 1.

    worldSpace?: boolean

    See ParticleSystem.worldSpace. Default false.