Class DepthCopyMaterial

A depth copy shader material.

Hierarchy (View Summary)

FullscreenMaterial
- DepthCopyMaterial

Index

Constructors

constructor

new DepthCopyMaterial(): DepthCopyMaterial
Constructs a new depth copy material.

Returns DepthCopyMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/DepthCopyMaterial.ts:20

Accessors

depthBuffer

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

Returns Texture<unknown> | null
- Defined in src/materials/DepthCopyMaterial.ts:41
set depthBuffer(value: Texture<unknown> | null): void
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/DepthCopyMaterial.ts:47

`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

mode

get mode(): DepthCopyMode
The current depth copy mode.

Returns DepthCopyMode
- Defined in src/materials/DepthCopyMaterial.ts:67
set mode(value: DepthCopyMode): void
Parameters
- value: DepthCopyMode
Returns void
- Defined in src/materials/DepthCopyMaterial.ts:73

`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

texelPosition

get texelPosition(): Vector2
The screen space position used for single-texel copy operations.

Returns Vector2
- Defined in src/materials/DepthCopyMaterial.ts:57

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 DepthCopyMaterial

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns DepthCopyMaterial

Accessors

depthBuffer

Returns Texture<unknown> | null

Parameters

Returns void

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

mode

Returns DepthCopyMode

Parameters

Returns void

Protectednear

Returns number

outputPrecision

Returns Precision

Parameters

Returns void

texelPosition

Returns Vector2

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near