Class CircleOfConfusionMaterial

A circle of confusion shader material.

Hierarchy (View Summary)

FullscreenMaterial
- CircleOfConfusionMaterial

Index

Constructors

constructor

new CircleOfConfusionMaterial(): CircleOfConfusionMaterial
Constructs a new circle of confusion material.

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

Accessors

depthBuffer

set depthBuffer(value: Texture): void
The depth buffer.
Parameters
- value: Texture
Returns void
- Defined in src/materials/CircleOfConfusionMaterial.ts:38

`Protected`far

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

Returns number
Inherited from FullscreenMaterial.far
- Defined in src/materials/FullscreenMaterial.ts:175

focusDistance

get focusDistance(): number
The focus distance in world units.

Returns number
- Defined in src/materials/CircleOfConfusionMaterial.ts:48
set focusDistance(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/CircleOfConfusionMaterial.ts:54

focusRange

get focusRange(): number
The focus range in world units.

Returns number
- Defined in src/materials/CircleOfConfusionMaterial.ts:64
set focusRange(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/CircleOfConfusionMaterial.ts:70

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 CircleOfConfusionMaterial

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns CircleOfConfusionMaterial

Accessors

depthBuffer

Parameters

Returns void

Protectedfar

Returns number

focusDistance

Returns number

Parameters

Returns void

focusRange

Returns number

Parameters

Returns void

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