Class CopyMaterial

A copy shader material.

Hierarchy (View Summary)

FullscreenMaterial
- CopyMaterial

Index

Constructors

constructor

new CopyMaterial(): CopyMaterial
Constructs a new copy material.

Returns CopyMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/CopyMaterial.ts:19

Accessors

channelWeights

get channelWeights(): Vector4 | null
Color channel weights that modulate texels from the input buffer.

Set to null to disable.

Returns Vector4 | null
- Defined in src/materials/CopyMaterial.ts:142
set channelWeights(value: Vector4 | null): void
Parameters
- value: Vector4 | null
Returns void
- Defined in src/materials/CopyMaterial.ts:148

colorSpaceConversion

get colorSpaceConversion(): boolean
Indicates whether output color space conversion is enabled.

Returns boolean
- Defined in src/materials/CopyMaterial.ts:110
set colorSpaceConversion(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/materials/CopyMaterial.ts:116

depthBuffer

get depthBuffer(): Texture<unknown> | null
A depth buffer that should be copied to the output buffer.

Returns Texture<unknown> | null
- Defined in src/materials/CopyMaterial.ts:74
set depthBuffer(value: Texture<unknown> | null): void
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/CopyMaterial.ts:80

`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
Overrides FullscreenMaterial.inputBuffer
- Defined in src/materials/CopyMaterial.ts:39
set inputBuffer(value: Texture<unknown> | null): void
The input buffer.

If this buffer uses high precision, the macro FRAME_BUFFER_PRECISION_HIGH will be defined.
Parameters
- value: Texture<unknown> | null
Returns void
Overrides FullscreenMaterial.inputBuffer
- Defined in src/materials/CopyMaterial.ts:45

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

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns CopyMaterial

Accessors

channelWeights

Returns Vector4 | null

Parameters

Returns void

colorSpaceConversion

Returns boolean

Parameters

Returns void

depthBuffer

Returns Texture<unknown> | null

Parameters

Returns void

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