Class DepthDownsamplingMaterial

A depth downsampling shader material.

Based on an article by Eleni Maria Stea.

See

https://eleni.mutantstargoat.com/hikiko/depth-aware-upsampling-6

Hierarchy (View Summary)

FullscreenMaterial
- DepthDownsamplingMaterial

Index

Constructors

constructor

new DepthDownsamplingMaterial(): DepthDownsamplingMaterial
Constructs a new depth downsampling material.

Returns DepthDownsamplingMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/DepthDownsamplingMaterial.ts:22

Accessors

depthBuffer

set depthBuffer(value: Texture<unknown> | null): void
The depth buffer.
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/DepthDownsamplingMaterial.ts:40

`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

normalBuffer

set normalBuffer(value: Texture<unknown> | null): void
The normal buffer.
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/DepthDownsamplingMaterial.ts:50

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 DepthDownsamplingMaterial

See

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns DepthDownsamplingMaterial

Accessors

depthBuffer

Parameters

Returns void

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

Protectednear

Returns number

normalBuffer

Parameters

Returns void

outputPrecision

Returns Precision

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near