Class EffectMaterial

An effect material.

Hierarchy (View Summary)

FullscreenMaterial
- EffectMaterial

Index

Constructors

constructor

new EffectMaterial(): EffectMaterial
Constructs a new effect material.

Returns EffectMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/EffectMaterial.ts:28

Accessors

colorSpaceConversion

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

Returns boolean
- Defined in src/materials/EffectMaterial.ts:68
set colorSpaceConversion(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/materials/EffectMaterial.ts:74

`Protected`far

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

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

gBuffer

get gBuffer(): Record<string, Texture<unknown> | null> | null
The current gBuffer struct.

Returns Record<string, Texture<unknown> | null> | null
- Defined in src/materials/EffectMaterial.ts:52
set gBuffer(value: Record<string, Texture | null>): void
Parameters
- value: Record<string, Texture | null>
Returns void
- Defined in src/materials/EffectMaterial.ts:58

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

time

get time(): number
The current animation time in seconds.

Returns number
- Defined in src/materials/EffectMaterial.ts:98
set time(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/EffectMaterial.ts:104

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

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Returns void
Fires
Material#dispose
Overrides FullscreenMaterial.dispose
- Defined in src/materials/EffectMaterial.ts:174

setDefines

setDefines(defines: Map<string, string | number | boolean>): this
Sets the shader macros.

Macros that have previously been set will be removed before the new ones are added.
Parameters
- defines: Map<string, string | number | boolean>
  A collection of preprocessor macro definitions.
Returns this
This material.
- Defined in src/materials/EffectMaterial.ts:145

setShaderParts

setShaderParts(shaderParts: Map<EffectShaderSection, string | null>): this
Sets the shader parts.
Parameters
- shaderParts: Map<EffectShaderSection, string | null>
  A collection of shader code snippets. See EffectShaderSection.
Returns this
This material.
- Defined in src/materials/EffectMaterial.ts:117

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

setUniforms

setUniforms(uniforms: Map<string, IUniform<any>>): this
Sets the shader uniforms.

Uniforms that have previously been set will be removed before the new ones are added.
Parameters
- uniforms: Map<string, IUniform<any>>
  A collection of uniforms.
Returns this
This material.
- Defined in src/materials/EffectMaterial.ts:164

Class EffectMaterial

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns EffectMaterial

Accessors

colorSpaceConversion

Returns boolean

Parameters

Returns void

Protectedfar

Returns number

gBuffer

Returns Record<string, Texture<unknown> | null> | null

Parameters

Returns void

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

Protectednear

Returns number

outputPrecision

Returns Precision

Parameters

Returns void

time

Returns number

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

dispose

Returns void

Fires

setDefines

Parameters

Returns this

setShaderParts

Parameters

Returns this

setSize

Parameters

Returns void

setUniforms

Parameters

Returns this

Settings

On This Page

`Protected`far

`Protected`near