Class FullscreenMaterial`Abstract`

A fullscreen shader material.

This material provides the following commonly used uniforms:

mat4 projectionMatrix
mat4 projectionMatrixInverse
mat4 viewMatrix
mat4 viewMatrixInverse
vec3 cameraParams
vec4 resolution
sampler2D inputBuffer

Uses GLSL3 by default.

See

inputBuffer for setting an input buffer.
copyCameraSettings for copying camera settings.
setSize for setting the resolution.

Hierarchy (View Summary)

ShaderMaterial
- FullscreenMaterial

Implements

Resizable

Index

Constructors

Accessors

far inputBuffer near outputPrecision

Methods

copyCameraSettings setSize

Constructors

constructor

new FullscreenMaterial(
parameters?: ShaderMaterialParameters,
): FullscreenMaterial
Constructs a new fullscreen shader material.
Parameters
- Optionalparameters: ShaderMaterialParameters
Returns FullscreenMaterial
Overrides ShaderMaterial.constructor
- Defined in src/materials/FullscreenMaterial.ts:48

Accessors

`Protected`far

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

Returns number
- 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
- Defined in src/materials/FullscreenMaterial.ts:147
set inputBuffer(value: Texture<unknown> | null): void
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/FullscreenMaterial.ts:153

`Protected`near

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

Returns number
- Defined in src/materials/FullscreenMaterial.ts:164

outputPrecision

get outputPrecision(): Precision
The precision of the output color.

Returns Precision
- Defined in src/materials/FullscreenMaterial.ts:94
set outputPrecision(value: Precision): void
Parameters
- value: Precision
Returns void
- 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
- 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
Implementation of Resizable.setSize
- Defined in src/materials/FullscreenMaterial.ts:227