@babylonjs/core 7.22.3 → 7.22.5

package/Rendering/IBLShadows/iblShadowsRenderPipeline.d.ts

@@ -0,0 +1,340 @@
+import type { AbstractMesh } from "../../Meshes/abstractMesh";
+import type { Scene } from "../../scene";
+import type { BaseTexture } from "../../Materials/Textures/baseTexture";
+import { Texture } from "../../Materials/Textures/texture";
+import { PrePassRenderer } from "../prePassRenderer";
+import "../../Shaders/postprocess.vertex";
+import "../../Shaders/iblShadowGBufferDebug.fragment";
+import "../../Shaders/iblShadowsCombine.fragment";
+import { PostProcessRenderPipeline } from "../../PostProcesses/RenderPipeline/postProcessRenderPipeline";
+import type { Camera } from "../../Cameras/camera.js";
+interface IblShadowsSettings {
+    /**
+     * The exponent of the resolution of the voxel shadow grid. Higher resolutions will result in sharper
+     * shadows but are more expensive to compute and require more memory.
+     * The resolution is calculated as 2 to the power of this number.
+     */
+    resolutionExp: number;
+    /**
+     * The number of different directions to sample during the voxel tracing pass. Higher
+     * values will result in better quality, more stable shadows but are more expensive to compute.
+     */
+    sampleDirections: number;
+    /**
+     * How dark the shadows are. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    shadowOpacity: number;
+    /**
+     * How long the shadows remain in the scene. 0.0 is no persistence, 1.0 is full persistence.
+     */
+    shadowRemenance: number;
+    /**
+     * Render the voxel grid from 3 different axis. This will result in better quality shadows with fewer
+     * bits of missing geometry.
+     */
+    triPlanarVoxelization: boolean;
+    /**
+     * Include screen-space shadows in the IBL shadow pipeline. This adds sharp shadows to small details
+     * but only applies close to a shadow-casting object.
+     */
+    ssShadowsEnabled: boolean;
+    /**
+     * The number of samples used in the screen space shadow pass.
+     */
+    ssShadowSampleCount: number;
+    /**
+     * The stride of the screen-space shadow pass. This controls the distance between samples.
+     */
+    ssShadowStride: number;
+    /**
+     * The maximum distance a shadow can be cast in screen space. This should usually be kept small
+     * as screenspace shadows are mostly useful for small details.
+     */
+    ssShadowMaxDist: number;
+    /**
+     * Screen-space shadow thickness. This value controls the perceived thickness of the SS shadows.
+     */
+    ssShadowThickness: number;
+}
+/**
+ * Voxel-based shadow rendering for IBL's.
+ * This should not be instanciated directly, as it is part of a scene component
+ */
+export declare class IblShadowsRenderPipeline extends PostProcessRenderPipeline {
+    /**
+     * The scene that this pipeline is attached to
+     */
+    scene: Scene;
+    private _voxelizationDirty;
+    private _boundsNeedUpdate;
+    private _allowDebugPasses;
+    private _debugPasses;
+    private _shadowCompositePP;
+    private _prePassEffectConfiguration;
+    private _excludedMeshes;
+    private _voxelRenderer;
+    private _importanceSamplingRenderer;
+    private _voxelTracingPass;
+    private _spatialBlurPass;
+    private _accumulationPass;
+    private _noiseTexture;
+    private _shadowOpacity;
+    /**
+     * How dark the shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    get shadowOpacity(): number;
+    /**
+     * How dark the shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    set shadowOpacity(value: number);
+    /**
+     * How dark the voxel shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    get voxelShadowOpacity(): number;
+    /**
+     * How dark the voxel shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    set voxelShadowOpacity(value: number);
+    /**
+     * How dark the screen-space shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    get ssShadowOpacity(): number;
+    /**
+     * How dark the screen-space shadows appear. 1.0 is full opacity, 0.0 is no shadows.
+     */
+    set ssShadowOpacity(value: number);
+    /**
+     * The number of samples used in the screen space shadow pass.
+     */
+    get ssShadowSamples(): number;
+    /**
+     * The number of samples used in the screen space shadow pass.
+     */
+    set ssShadowSamples(value: number);
+    /**
+     * The stride of the screen-space shadow pass. This controls the distance between samples.
+     */
+    get ssShadowStride(): number;
+    /**
+     * The stride of the screen-space shadow pass. This controls the distance between samples.
+     */
+    set ssShadowStride(value: number);
+    /**
+     * The maximum distance a shadow can be cast in screen space. This should usually be kept small
+     * as screenspace shadows are mostly useful for small details.
+     */
+    get ssShadowMaxDist(): number;
+    /**
+     * The maximum distance a shadow can be cast in screen space. This should usually be kept small
+     * as screenspace shadows are mostly useful for small details.
+     */
+    set ssShadowMaxDist(value: number);
+    /**
+     * Screen-space shadow thickness. This value controls the perceived thickness of the SS shadows.
+     */
+    get ssShadowThickness(): number;
+    /**
+     * Screen-space shadow thickness. This value controls the perceived thickness of the SS shadows.
+     */
+    set ssShadowThickness(value: number);
+    /**
+     * Set the IBL image to be used for shadowing. It can be either a cubemap
+     * or a 2D equirectangular texture.
+     * @param iblSource The texture to use for IBL shadowing
+     */
+    setIblTexture(iblSource: BaseTexture): void;
+    /**
+     * Returns the texture containing the voxel grid data
+     * @returns The texture containing the voxel grid data
+     */
+    getVoxelGridTexture(): Texture;
+    /**
+     * Returns the texture containing the importance sampling CDF data for the IBL shadow pipeline
+     * @returns The texture containing the importance sampling CDF data for the IBL shadow pipeline
+     */
+    getIcdfyTexture(): Texture;
+    /**
+     * Returns the texture containing the importance sampling CDF data for the IBL shadow pipeline
+     * @returns The texture containing the importance sampling CDF data for the IBL shadow pipeline
+     */
+    getIcdfxTexture(): Texture;
+    private _gbufferDebugPass;
+    private _gbufferDebugEnabled;
+    private _gBufferDebugSizeParams;
+    /**
+     * Is the debug view of the G-Buffer enabled?
+     */
+    get gbufferDebugEnabled(): boolean;
+    /**
+     * Turn on or off the debug view of the G-Buffer
+     */
+    set gbufferDebugEnabled(enabled: boolean);
+    /**
+     * Turn on or off the debug view of the CDF importance sampling data
+     */
+    get importanceSamplingDebugEnabled(): boolean;
+    /**
+     * Turn on or off the debug view of the CDF importance sampling data
+     */
+    set importanceSamplingDebugEnabled(enabled: boolean);
+    /**
+     * Turn on or off the debug view of the voxel grid
+     */
+    get voxelDebugEnabled(): boolean;
+    /**
+     * Turn on or off the debug view of the voxel grid
+     */
+    set voxelDebugEnabled(enabled: boolean);
+    /**
+     * Set the axis to display for the voxel grid debug view
+     * When using tri-axis voxelization, this will display the voxel grid for the specified axis
+     */
+    get voxelDebugAxis(): number;
+    /**
+     * Set the axis to display for the voxel grid debug view
+     * When using tri-axis voxelization, this will display the voxel grid for the specified axis
+     */
+    set voxelDebugAxis(axisNum: number);
+    /**
+     * Set the mip level to display for the voxel grid debug view
+     */
+    set voxelDebugDisplayMip(mipNum: number);
+    /**
+     * Display the debug view for the voxel tracing pass
+     */
+    get voxelTracingDebugEnabled(): boolean;
+    /**
+     * Display the debug view for the voxel tracing pass
+     */
+    set voxelTracingDebugEnabled(enabled: boolean);
+    /**
+     * Display the debug view for the spatial blur pass
+     */
+    get spatialBlurPassDebugEnabled(): boolean;
+    /**
+     * Display the debug view for the spatial blur pass
+     */
+    set spatialBlurPassDebugEnabled(enabled: boolean);
+    /**
+     * Display the debug view for the accumulation pass
+     */
+    get accumulationPassDebugEnabled(): boolean;
+    /**
+     * Display the debug view for the accumulation pass
+     */
+    set accumulationPassDebugEnabled(enabled: boolean);
+    /**
+     * Add a mesh in the exclusion list to prevent it to be handled by the IBL shadow pipeline
+     * @param mesh The mesh to exclude from the IBL shadow pipeline
+     */
+    addExcludedMesh(mesh: AbstractMesh): void;
+    /**
+     * Remove a mesh from the exclusion list of the IBL shadow pipeline
+     * @param mesh The mesh to remove
+     */
+    removeExcludedMesh(mesh: AbstractMesh): void;
+    /**
+     * The exponent of the resolution of the voxel shadow grid. Higher resolutions will result in sharper
+     * shadows but are more expensive to compute and require more memory.
+     * The resolution is calculated as 2 to the power of this number.
+     */
+    get resolutionExp(): number;
+    /**
+     * The exponent of the resolution of the voxel shadow grid. Higher resolutions will result in sharper
+     * shadows but are more expensive to compute and require more memory.
+     * The resolution is calculated as 2 to the power of this number.
+     */
+    set resolutionExp(newResolution: number);
+    /**
+     * The number of different directions to sample during the voxel tracing pass
+     */
+    get sampleDirections(): number;
+    /**
+     * The number of different directions to sample during the voxel tracing pass
+     */
+    set sampleDirections(value: number);
+    /**
+     * The decree to which the shadows persist between frames. 0.0 is no persistence, 1.0 is full persistence.
+     **/
+    get shadowRemenance(): number;
+    /**
+     * The decree to which the shadows persist between frames. 0.0 is no persistence, 1.0 is full persistence.
+     **/
+    set shadowRemenance(value: number);
+    /**
+     * The global rotation of the IBL for shadows
+     */
+    get envRotation(): number;
+    /**
+     * The global rotation of the IBL for shadows
+     */
+    set envRotation(value: number);
+    /**
+     * Allow debug passes to be enabled. Default is false.
+     */
+    get allowDebugPasses(): boolean;
+    /**
+     * Allow debug passes to be enabled. Default is false.
+     */
+    set allowDebugPasses(value: boolean);
+    /**
+     *  Support test.
+     */
+    static get IsSupported(): boolean;
+    /**
+     * @param name The rendering pipeline name
+     * @param scene The scene linked to this pipeline
+     * @param options Options to configure the pipeline
+     * @param cameras Cameras to apply the pipeline to.
+     */
+    constructor(name: string, scene: Scene, options?: Partial<IblShadowsSettings>, cameras?: Camera[]);
+    /**
+     * Toggle the shadow tracing on or off
+     * @param enabled Toggle the shadow tracing on or off
+     */
+    toggleShadow(enabled: boolean): void;
+    private _handleResize;
+    private _createShadowCombinePostProcess;
+    private _createEffectPasses;
+    private _getGBufferDebugPass;
+    private _createDebugPasses;
+    private _disposeEffectPasses;
+    private _disposeDebugPasses;
+    private _updateDebugPasses;
+    /**
+     * Trigger the scene to be re-voxelized. This is useful when the scene has changed and the voxel grid needs to be updated.
+     */
+    updateVoxelization(): void;
+    /**
+     * Trigger the scene bounds of shadow-casters to be updated. This is useful when the scene has changed and the bounds need
+     * to be recalculated. This will also trigger a re-voxelization.
+     */
+    updateSceneBounds(): void;
+    private _updateBeforeRender;
+    private _listenForCameraChanges;
+    /**
+     * Links to the prepass renderer
+     * @param prePassRenderer The scene PrePassRenderer
+     * @returns true if the pre pass is setup
+     */
+    setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
+    /**
+     * Checks if the IBL shadow pipeline is ready to render shadows
+     * @returns true if the IBL shadow pipeline is ready to render the shadows
+     */
+    isReady(): boolean;
+    /**
+     * Renders accumulated shadows for IBL
+     */
+    update(): void;
+    /**
+     * Get the class name
+     * @returns "IBLShadowsRenderPipeline"
+     */
+    getClassName(): string;
+    /**
+     * Disposes the IBL shadow pipeline and associated resources
+     */
+    dispose(): void;
+}
+export {};