@pixi/3d
    Preparing search index...

    Interface ParticleMaterialOptionsAdvanced

    Constructor options for ParticleMaterial

    interface ParticleMaterialOptions {
        alphaCutoff?: number;
        alphaMode?: AlphaMode;
        billboard?: ParticleBillboardMode;
        blendMode?: ParticleBlendMode;
        extraBits?: readonly ShaderBit[];
        fog?: boolean;
        label?: string;
        localSpace?: boolean;
        texture?: Texture<TextureSource<any>>;
        textures?: Record<string, Texture<TextureSource<any>> | undefined>;
        useFrames?: boolean;
    }
    Index
    alphaCutoff? alphaMode? billboard? blendMode? extraBits? fog? label? localSpace? texture? textures? useFrames?
    alphaCutoff?: number

    Alpha below which a texel is cut away under alphaMode: 'mask'

    0.5
    alphaMode?: AlphaMode

    How particle transparency works; see ParticleContainer3DOptions.alphaMode

    'blend'
    billboard?: ParticleBillboardMode

    How each quad faces the camera

    'spherical'
    blendMode?: ParticleBlendMode

    How particles blend over the scene; see ParticleBlendMode

    Ignored unless alphaMode is 'blend'.

    'normal'
    extraBits?: readonly ShaderBit[]

    Extra shader bits composed after the particle bit; see ParticleContainer3DOptions.extraBits

    fog?: boolean

    Whether the view's fog reaches these particles

    Defaults to true for 'normal' blending only, since fog would show other blend modes' quads as glowing or staining rectangles.

    label?: string

    Name for debugging and for finding the material

    new ParticleMaterial({ label: 'sparks' });
    localSpace?: boolean

    Whether particle positions are relative to the mesh rather than in world space

    false
    texture?: Texture<TextureSource<any>>

    The sprite (or whole sprite sheet, for flipbooks) every particle samples

    textures?: Record<string, Texture<TextureSource<any>> | undefined>

    Textures for the extra bits' declarations, by name, as BaseMaterial3DOptions.textures

    useFrames?: boolean

    Whether the geometry carries a per-particle aParticleUVFrame flipbook window

    texture must then be the whole sheet, not one frame of it, or the constructor throws.

    false

    Settings
    Member Visibility

    On This Page
    Properties