Class DepthPeelingRenderer
Constructors
constructor
-
Instanciates the depth peeling renderer
Parameters
- scene: Scene
Scene to attach to
- passCount: number = 5
Number of depth layers to peel
Returns DepthPeelingRenderer
The depth peeling renderer
- scene: Scene
Accessors
blend
-
Sets the render target wrapper we will blend the transparent objects onto
Returns Nullable<RenderTargetWrapper>
-
Parameters
- blendOutput: Nullable<RenderTargetWrapper>
Returns void
pass
-
get passCount(): number
Number of depth peeling passes. As we are using dual depth peeling, each pass two levels of transparency are processed.
Returns number
-
set passCount(count: number): void
Parameters
- count: number
Returns void
shader
-
get shaderLanguage(): ShaderLanguage
Gets the shader language used in this renderer
Returns ShaderLanguage
use
-
get useRenderPasses(): boolean
Instructs the renderer to use render passes. It is an optimization that makes the rendering faster for some engines (like WebGPU) but that consumes more memory, so it is disabled by default.
Returns boolean
-
set useRenderPasses(usePasses: boolean): void
Parameters
- usePasses: boolean
Returns void
Methods
add
-
Add a mesh in the exclusion list to prevent it to be handled by the depth peeling renderer
Parameters
- mesh: AbstractMesh
The mesh to exclude from the depth peeling renderer
Returns void
- mesh: AbstractMesh
bind
-
Binds depth peeling textures on an effect
Parameters
- effect: Effect
The effect to bind textures on
Returns void
- effect: Effect
dispose
-
Disposes the depth peeling renderer and associated resources
Returns void
is
-
Checks if the depth peeling renderer is ready to render transparent meshes
Returns boolean
true if the depth peeling renderer is ready to render the transparent meshes
remove
-
Remove a mesh from the exclusion list of the depth peeling renderer
Parameters
- mesh: AbstractMesh
The mesh to remove
Returns void
- mesh: AbstractMesh
render
-
Renders transparent submeshes with depth peeling
Parameters
- transparentSubMeshes: SmartArray<SubMesh>
List of transparent meshes to render
Returns SmartArray<SubMesh>
The array of submeshes that could not be handled by this renderer
- transparentSubMeshes: SmartArray<SubMesh>
set
-
Links to the prepass renderer
Parameters
- prePassRenderer: PrePassRenderer
The scene PrePassRenderer
Returns void
- prePassRenderer: PrePassRenderer
The depth peeling renderer that performs Order independant transparency (OIT). This should not be instanciated directly, as it is part of a scene component