@babylonjs/core/Lights/Clustered/clusteredLightContainer.d.ts

Getting started? Play directly with the Babylon.js API using our [playground](https://playground.babylonjs.com/). It also contains a lot of samples to learn how to use it.

import type { Effect } from "../../Materials/effect.js";
import { RenderTargetTexture } from "../../Materials/Textures/renderTargetTexture.js";
import type { Scene } from "../../scene.js";
import { Light } from "../light.js";
import "../../Meshes/thinInstanceMesh.js";
/**
 * A special light that renders all its associated spot or point lights using a clustered or forward+ system.
 */
export declare class ClusteredLightContainer extends Light {
    private static _GetEngineBatchSize;
    /**
     * Checks if the clustered lighting system supports the given light with its current parameters.
     * This will also check if the light's associated engine supports clustered lighting.
     *
     * @param light The light to test
     * @returns true if the light and its engine is supported
     */
    static IsLightSupported(light: Light): boolean;
    /** @internal */
    static _SceneComponentInitialization: (scene: Scene) => void;
    private readonly _batchSize;
    /**
     * True if clustered lighting is supported.
     */
    get isSupported(): boolean;
    private readonly _lights;
    /**
     * Gets the current list of lights added to this clustering system.
     */
    get lights(): readonly Light[];
    private _lightDataBuffer;
    private _lightDataTexture;
    private _tileMaskBatches;
    private _tileMaskTexture;
    private _tileMaskBuffer;
    private _horizontalTiles;
    /**
     * The number of tiles in the horizontal direction to cluster lights into.
     * A lower value will reduce memory and make the clustering step faster, while a higher value increases memory and makes the rendering step faster.
     */
    get horizontalTiles(): number;
    set horizontalTiles(horizontal: number);
    private _verticalTiles;
    /**
     * The number of tiles in the vertical direction to cluster lights into.
     * A lower value will reduce memory and make the clustering step faster, while a higher value increases memory and makes the rendering step faster.
     */
    get verticalTiles(): number;
    set verticalTiles(vertical: number);
    private readonly _proxyMaterial;
    private readonly _proxyMesh;
    private _maxRange;
    private _minInverseSquaredRange;
    /**
     * This limits the range of all the added lights, so even lights with extreme ranges will still have bounds for clustering.
     */
    get maxRange(): number;
    set maxRange(range: number);
    /**
     * Creates a new clustered light system with an initial set of lights.
     *
     * @param name The name of the clustered light container
     * @param lights The initial set of lights to add
     * @param scene The scene the clustered light container belongs to
     */
    constructor(name: string, lights?: Light[], scene?: Scene);
    getClassName(): string;
    getTypeID(): number;
    /** @internal */
    _updateBatches(): RenderTargetTexture;
    private _updateLightData;
    dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
    /**
     * Adds a light to the clustering system.
     * @param light The light to add
     */
    addLight(light: Light): void;
    /**
     * Removes a light from the clustering system.
     * @param light The light to remove
     * @returns the index where the light was in the light list
     */
    removeLight(light: Light): number;
    protected _buildUniformLayout(): void;
    transferToEffect(effect: Effect, lightIndex: string): Light;
    transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
    transferToNodeMaterialEffect(): Light;
    prepareLightSpecificDefines(defines: any, lightIndex: number): void;
    _isReady(): boolean;
}