Class DepthReducer
Hierarchy
- MinMaxReducer
- DepthReducer
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a depth reducer
Parameters
camera: Camera
The camera used to render the depth texture
Returns DepthReducer
Properties
on
Observable triggered when the computation has been performed
Accessors
activated
Gets the activation status of the reducer
Returns boolean
depth
Gets the depth renderer used for the computation. Note that the result is null if you provide your own renderer when calling setDepthRenderer.
Returns Nullable<DepthRenderer>
refresh
Defines the refresh rate of the computation. Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
Returns number
Defines the refresh rate of the computation. Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
Parameters
value: number
Returns void
source
Gets the texture used to read the values from.
Returns Nullable<RenderTargetTexture>
Methods
activateSearch playground for activate
Activates the reduction computation. When activated, the observers registered in onAfterReductionPerformed are called after the computation is performed
Returns void
deactivateSearch playground for deactivate
Deactivates the reduction computation.
Returns void
disposeSearch playground for dispose
Disposes the depth reducer
Parameters
Optional disposeAll: boolean
true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
Returns void
set
Sets the depth renderer to use to generate the depth map
Parameters
Optional depthRenderer: Nullable<DepthRenderer>
The depth renderer to use. If not provided, a new one will be created automatically
Optional type: number
The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
Optional forceFullscreenViewport: boolean
Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
Returns void
This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture