Class DownsamplingMaterial

A downsampling material.

Based on an article by Fabrice Piquet.

See

https://www.froyok.fr/blog/2021-12-ue4-custom-bloom/

Hierarchy (View Summary)

FullscreenMaterial
- DownsamplingMaterial

Implements

DownsamplingMaterialOptions

Index

Constructors

constructor

new DownsamplingMaterial(
__namedParameters?: DownsamplingMaterialOptions,
): DownsamplingMaterial
Constructs a new downsampling material.
Parameters
- __namedParameters: DownsamplingMaterialOptions = {}
Returns DownsamplingMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/DownsamplingMaterial.ts:39

Accessors

clampToBorder

get clampToBorder(): boolean
Controls whether the sampling coordinates should be clamped to a black border.

Returns boolean
Default Value
```
true
```
Implementation of DownsamplingMaterialOptions.clampToBorder
- Defined in src/materials/DownsamplingMaterial.ts:54
set clampToBorder(value: boolean): void
Controls whether the sampling coordinates should be clamped to a black border.
Parameters
- value: boolean
Returns void
Default Value
```
true
```
Implementation of DownsamplingMaterialOptions.clampToBorder
- Defined in src/materials/DownsamplingMaterial.ts:60

`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

`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

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 DownsamplingMaterial

See

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DownsamplingMaterial

Accessors

clampToBorder

Returns boolean

Default Value

Parameters

Returns void

Default Value

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

Protectednear

Returns number

outputPrecision

Returns Precision

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near