Class DepthRenderer
Hierarchy
- DepthRenderer
Index
Constructors
constructor
Instantiates a depth renderer
Parameters
scene: Scene
The scene the renderer belongs to
Optional type: number
The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
Optional camera: Nullable<Camera>
The camera to be used to render the depth map (default: scene's active camera)
Optional storeNonLinearDepth: boolean
Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
Optional samplingMode: number
The sampling mode to be used with the render target (Linear, Nearest...) (default: TRILINEAR_SAMPLINGMODE)
Optional storeCameraSpaceZ: boolean
Defines whether the depth stored is the Z coordinate in camera space. If true, storeNonLinearDepth has no effect. (Default: false)
Optional name: string
Name of the render target (default: DepthRenderer)
Returns DepthRenderer
Properties
clear
Color used to clear the depth texture. Default: (1,0,0,1)
enabledSearch playground for enabled
Enable or disable the depth renderer. When disabled, the depth texture is not updated
force
Force writing the transparent objects into the depth map
Readonly is
Get if the depth renderer is using packed depth or not
reverse
If true, reverse the culling of materials before writing to the depth texture. So, basically, when "true", back facing instead of front facing faces are rasterized into the texture
use
Specifies that the depth renderer will only be used within the camera it is created for. This can help forcing its rendering during the camera processing.
Methods
disposeSearch playground for dispose
Disposes of the depth renderer.
Returns void
get
Gets the texture which the depth map will be written to.
Returns RenderTargetTexture
The depth map texture
is
Creates the depth rendering effect and checks if the effect is ready.
Parameters
subMesh: SubMesh
The submesh to be used to render the depth map of
useInstances: boolean
If multiple world instances should be used
Returns boolean
if the depth renderer is ready to render the depth map
set
Sets a specific material to be used to render a mesh/a list of meshes by the depth renderer
Parameters
mesh: AbstractMesh | AbstractMesh[]
mesh or array of meshes
Optional material: Material
material to use by the depth render when rendering the mesh(es). If undefined is passed, the specific material created by the depth renderer will be used.
Returns void
This represents a depth renderer in Babylon. A depth renderer will render to it's depth map every frame which can be displayed or used in post processing