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

    Interface StoredBatchSettings

    A batch's copy of the VFXBatchSettings its systems share: every optional field defaulted, and every field the batch's render mode ignores at its default (an opaque batch's materialBlendMode reads ALPHA_DISABLE, a billboard batch's rim is unset). The renderer adds a system to the batch whose settings match its own.

    interface StoredBatchSettings {
        applyFog: boolean;
        applyImageProcessing: boolean;
        blendTiles: boolean;
        erosion?: ParticleErosion;
        gradientMap?: ParticleGradientMap;
        instancingColors?: Float32Array<ArrayBufferLike>;
        instancingGeometry: Float32Array;
        instancingIndices:
            | Uint32Array<ArrayBufferLike>
            | Uint16Array<ArrayBufferLike>;
        instancingNormals?: Float32Array<ArrayBufferLike>;
        instancingUVs?: Float32Array<ArrayBufferLike>;
        instancingUVs2?: Float32Array<ArrayBufferLike>;
        layerMask: number;
        lighting?: MeshLighting;
        mapUV?: TextureUV;
        materialAlphaTest: number;
        materialBlendMode: number;
        materialColor: readonly [number, number, number, number];
        materialColorScale: number;
        materialDepthTest: boolean;
        materialDepthWrite: boolean;
        materialTransparent: boolean;
        maxParticleSize: number;
        minParticleSize: number;
        particleColor: boolean;
        pivot?: Vector3Like;
        premultipliedMap: boolean;
        reflectionAtlas: BaseTexture | null;
        reflectionLevel: number;
        reflectionTexture: BaseTexture | null;
        renderAlignment: RenderAlignment;
        renderFace: RenderFace;
        renderingGroupId: number;
        renderMode: RenderMode;
        renderOrder: number;
        rim?: MeshRim;
        softFarFade: number;
        softNearFade: number;
        softParticles: boolean;
        sortingFudge: number;
        sortMode: SortMode;
        texture: BaseTexture | null;
        uTileCount: number;
        uvDistortion?: ParticleUVDistortion;
        vTileCount: number;
    }
    Index
    applyFog: boolean

    Whether the scene's fog is applied, see VFXBatchSettings.applyFog.

    applyImageProcessing: boolean

    Whether the scene's image processing is applied, see VFXBatchSettings.applyImageProcessing.

    blendTiles: boolean
    erosion?: ParticleErosion

    Alpha erosion, see VFXBatchSettings.erosion.

    gradientMap?: ParticleGradientMap

    Colour ramp for the map, see VFXBatchSettings.gradientMap.

    instancingColors?: Float32Array<ArrayBufferLike>
    instancingGeometry: Float32Array
    instancingIndices: Uint32Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike>
    instancingNormals?: Float32Array<ArrayBufferLike>
    instancingUVs?: Float32Array<ArrayBufferLike>
    instancingUVs2?: Float32Array<ArrayBufferLike>

    The mesh's second UV set, see UVChannel.

    layerMask: number
    lighting?: MeshLighting

    Mesh particle lighting, see VFXBatchSettings.lighting.

    mapUV?: TextureUV

    The main map's layout, see VFXBatchSettings.mapUV.

    materialAlphaTest: number
    materialBlendMode: number
    materialColor: readonly [number, number, number, number]
    materialColorScale: number
    materialDepthTest: boolean
    materialDepthWrite: boolean
    materialTransparent: boolean
    maxParticleSize: number

    Largest size a particle may have on screen, see VFXBatchSettings.maxParticleSize.

    minParticleSize: number

    Smallest size a particle may have on screen, see VFXBatchSettings.minParticleSize.

    particleColor: boolean
    pivot?: Vector3Like

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

    premultipliedMap: boolean

    See VFXBatchSettings.premultipliedMap; false without a texture.

    reflectionAtlas: BaseTexture | null
    reflectionLevel: number
    reflectionTexture: BaseTexture | null
    renderAlignment: RenderAlignment

    The axes a mesh particle's rotation is measured in and a billboard's quad is laid along, see RenderAlignment. 'simulation' outside the Mesh render mode and for camera-facing billboards ('view' included).

    renderFace: RenderFace

    Which faces a mesh particle draws, see RenderFace; 'both' outside the Mesh render mode.

    renderingGroupId: number

    Babylon rendering group the batch mesh draws in, see VFXBatchSettings.renderingGroupId.

    renderMode: RenderMode
    renderOrder: number
    rim?: MeshRim

    Mesh particle rim, see VFXBatchSettings.rim.

    softFarFade: number
    softNearFade: number
    softParticles: boolean
    sortingFudge: number
    sortMode: SortMode

    Draw order within the batch, see SortMode.

    texture: BaseTexture | null
    uTileCount: number
    uvDistortion?: ParticleUVDistortion

    Map UV distortion, see VFXBatchSettings.uvDistortion.

    vTileCount: number