Class MinMaxReducer
Hierarchy (View Summary)
- MinMaxReducer
Constructors
constructor
-
Creates a min/max reducer
Parameters
- camera: Camera
The camera to use for the post processes
Returns MinMaxReducer
- camera: Camera
Accessors
activated
-
get activated(): boolean
Gets the activation status of the reducer
Returns boolean
on
-
Observable triggered when the computation has been performed
Returns Observable<{ max: number; min: number }>
refresh
-
get refreshRate(): 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...
Returns number
-
set refreshRate(value: number): void
Parameters
- value: number
Returns void
source
-
Gets the texture used to read the values from.
Returns Nullable<RenderTargetTexture>
wait
-
get waitForReadback(): boolean
Wait for WebGPU texture readback before notifying observers (default: false). This delays the notification; it does not block the render loop.
Returns boolean
-
set waitForReadback(value: boolean): void
Parameters
- value: boolean
Returns void
Methods
activate
-
Activates the reduction computation. When activated, the observers registered in onAfterReductionPerformed are called after the computation is performed
Returns void
deactivate
-
Deactivates the reduction computation.
Returns void
dispose
-
Disposes the min/max reducer
Parameters
- disposeAll: boolean = true
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
- disposeAll: boolean = true
set
-
setSourceTexture(
sourceTexture: RenderTargetTexture,
depthRedux: boolean,
type?: number,
forceFullscreenViewport?: boolean,
): voidSets the source texture to read the values from. One must indicate if the texture is a depth texture or not through the depthRedux parameter because in such textures '1' value must not be taken into account to compute the maximum as this value is used to clear the texture. Note that the computation is not activated by calling this function, you must call activate() for that!
Parameters
- sourceTexture: RenderTargetTexture
The texture to read the values from. The values should be in the red channel.
- depthRedux: boolean
Indicates if the texture is a depth texture or not
- type: number = Constants.TEXTURETYPE_HALF_FLOAT
The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
- forceFullscreenViewport: boolean = true
Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
Returns void
- sourceTexture: RenderTargetTexture
This class computes a min/max reduction from a texture: it means it computes the minimum and maximum values from all values of the texture. It is performed on the GPU for better performances, thanks to a succession of post processes. The source values are read from the red channel of the texture.