Class GaussianBlurMaterial

An optimized Gaussian blur material.

Based on "An investigation of fast real-time GPU-based image blur algorithms" by Filip Strugar, Intel, 2014.

See

https://www.intel.com/content/www/us/en/developer/articles/technical/an-investigation-of-fast-real-time-gpu-based-image-blur-algorithms.html)

Hierarchy (View Summary)

FullscreenMaterial
- GaussianBlurMaterial

Implements

GaussianBlurMaterialOptions

Index

Constructors

constructor

new GaussianBlurMaterial(
options?: GaussianBlurMaterialOptions,
): GaussianBlurMaterial
Constructs a new blur material.
Parameters
- options: GaussianBlurMaterialOptions = {}
  The options.
Returns GaussianBlurMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/GaussianBlurMaterial.ts:48

Accessors

direction

get direction(): Vector2
The blur direction.

Returns Vector2
- Defined in src/materials/GaussianBlurMaterial.ts:86

`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.

Returns number
Default Value
```
35
```
Implementation of GaussianBlurMaterialOptions.kernelSize
- Defined in src/materials/GaussianBlurMaterial.ts:69
set kernelSize(value: number): void
The kernel size. Must be an odd number.
Parameters
- value: number
Returns void
Default Value
```
35
```
Implementation of GaussianBlurMaterialOptions.kernelSize
- Defined in src/materials/GaussianBlurMaterial.ts:75

`Protected`near

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

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

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 kernel scale. Values greater than 1.0 may introduce artifacts.

Returns number
- Defined in src/materials/GaussianBlurMaterial.ts:96
set scale(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/GaussianBlurMaterial.ts:102

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 GaussianBlurMaterial

See

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GaussianBlurMaterial

Accessors

direction

Returns Vector2

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

kernelSize

Returns number

Default Value

Parameters

Returns void

Default Value

Protectednear

Returns number

outputPrecision

Returns Precision

Parameters

Returns void

scale

Returns number

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near