Class BoxBlurMaterial

A fast box blur material that supports depth-based bilateral filtering.

Hierarchy (View Summary)

FullscreenMaterial
- BoxBlurMaterial

Implements

BoxBlurMaterialOptions

Index

Constructors

constructor

new BoxBlurMaterial(options?: BoxBlurMaterialOptions): BoxBlurMaterial
Constructs a new box blur material.
Parameters
- options: BoxBlurMaterialOptions = {}
  The options.
Returns BoxBlurMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/BoxBlurMaterial.ts:49

Accessors

bilateral

get bilateral(): boolean
Indicates whether bilateral filtering is enabled.

Returns boolean
Implementation of BoxBlurMaterialOptions.bilateral
- Defined in src/materials/BoxBlurMaterial.ts:156
set bilateral(value: boolean): void
Indicates whether bilateral filtering is enabled.
Parameters
- value: boolean
Returns void
Implementation of BoxBlurMaterialOptions.bilateral
- Defined in src/materials/BoxBlurMaterial.ts:162

depthBuffer

set depthBuffer(value: Texture): void
The depth buffer.
Parameters
- value: Texture
Returns void
- Defined in src/materials/BoxBlurMaterial.ts:128

`Protected`far

get far(): number
The current camera far plane value.

Returns number
Inherited from FullscreenMaterial.far
- Defined in src/materials/FullscreenMaterial.ts:175

inputBuffer

get inputBuffer(): Texture<unknown> | null
The input buffer.

If this buffer uses high precision, the macro FRAME_BUFFER_PRECISION_HIGH will be defined.

Returns Texture<unknown> | null
Inherited from FullscreenMaterial.inputBuffer
- Defined in src/materials/FullscreenMaterial.ts:147
set inputBuffer(value: Texture<unknown> | null): void
Parameters
- value: Texture<unknown> | null
Returns void
Inherited from FullscreenMaterial.inputBuffer
- Defined in src/materials/FullscreenMaterial.ts:153

kernelSize

get kernelSize(): number
The kernel size.
- Must be an odd number
- Kernel size 3 and 5 use optimized code paths
Returns number
Default Value
```
5
```
Implementation of BoxBlurMaterialOptions.kernelSize
- Defined in src/materials/BoxBlurMaterial.ts:85
set kernelSize(value: number): void
The kernel size.
- Must be an odd number
- Kernel size 3 and 5 use optimized code paths
Parameters
- value: number
Returns void
Default Value
```
5
```
Implementation of BoxBlurMaterialOptions.kernelSize
- Defined in src/materials/BoxBlurMaterial.ts:91

maxVaryingVectors

set maxVaryingVectors(value: number): void
The maximum amount of varying vectors.

Should be synced with renderer.capabilities.maxVaryings.
Parameters
- value: number
Returns void
Default Value
```
8
```
- Defined in src/materials/BoxBlurMaterial.ts:79

`Protected`near

get near(): number
The current camera near plane value.

Returns number
Inherited from FullscreenMaterial.near
- Defined in src/materials/FullscreenMaterial.ts:164

normalDepthBuffer

set normalDepthBuffer(value: Texture): void
A combined normal-depth buffer. Overrides depthBuffer if set.
Parameters
- value: Texture
Returns void
- Defined in src/materials/BoxBlurMaterial.ts:138

outputPrecision

get outputPrecision(): Precision
The precision of the output color.

Returns Precision
Inherited from FullscreenMaterial.outputPrecision
- Defined in src/materials/FullscreenMaterial.ts:94
set outputPrecision(value: Precision): void
Parameters
- value: Precision
Returns void
Inherited from FullscreenMaterial.outputPrecision
- Defined in src/materials/FullscreenMaterial.ts:100

scale

get scale(): number
The blur scale.

Returns number
- Defined in src/materials/BoxBlurMaterial.ts:112
set scale(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/BoxBlurMaterial.ts:118

worldDistanceThreshold

get worldDistanceThreshold(): number
The bilateral filter distance threshold in world units.

Returns number
- Defined in src/materials/BoxBlurMaterial.ts:182
set worldDistanceThreshold(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/BoxBlurMaterial.ts:188

Methods

copyCameraSettings

copyCameraSettings(camera: OrthographicCamera | PerspectiveCamera): void
Copies the settings of the given camera.

Updates the camera-related uniforms and macros.
Parameters
- camera: OrthographicCamera | PerspectiveCamera
  A camera.
Returns void
Inherited from FullscreenMaterial.copyCameraSettings
- Defined in src/materials/FullscreenMaterial.ts:190

setSize

setSize(width: number, height: number): void
Updates the resolution uniform (XY = resolution, ZW = texelSize).
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Inherited from FullscreenMaterial.setSize
- Defined in src/materials/FullscreenMaterial.ts:227

Class BoxBlurMaterial

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns BoxBlurMaterial

Accessors

bilateral

Returns boolean

Parameters

Returns void

depthBuffer

Parameters

Returns void

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

kernelSize

Returns number

Default Value

Parameters

Returns void

Default Value

maxVaryingVectors

Parameters

Returns void

Default Value

Protectednear

Returns number

normalDepthBuffer

Parameters

Returns void

outputPrecision

Returns Precision

Parameters

Returns void

scale

Returns number

Parameters

Returns void

worldDistanceThreshold

Returns number

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near