Class MaskMaterial

A mask shader material.

Hierarchy (View Summary)

FullscreenMaterial
- MaskMaterial

Index

Constructors

constructor

new MaskMaterial(maskTexture?: Texture<unknown> | null): MaskMaterial
Constructs a new mask material.
Parameters
- maskTexture: Texture<unknown> | null = null
  A mask texture.
Returns MaskMaterial
Overrides FullscreenMaterial.constructor
- Defined in src/materials/MaskMaterial.ts:23

Accessors

colorChannel

get colorChannel(): ColorChannel
The color channel to use for masking.

Returns ColorChannel
Default Value
```
ColorChannel.RED
```
- Defined in src/materials/MaskMaterial.ts:66
set colorChannel(value: ColorChannel): void
Parameters
- value: ColorChannel
Returns void
- Defined in src/materials/MaskMaterial.ts:72

`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

inverted

get inverted(): boolean
Indicates whether the masking is inverted.

Returns boolean
- Defined in src/materials/MaskMaterial.ts:102
set inverted(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/materials/MaskMaterial.ts:108

maskFunction

get maskFunction(): MaskFunction
The masking technique.

Returns MaskFunction
Default Value
```
MaskFunction.DISCARD
```
- Defined in src/materials/MaskMaterial.ts:85
set maskFunction(value: MaskFunction): void
Parameters
- value: MaskFunction
Returns void
- Defined in src/materials/MaskMaterial.ts:91

maskTexture

set maskTexture(value: Texture<unknown> | null): void
The mask texture.
Parameters
- value: Texture<unknown> | null
Returns void
- Defined in src/materials/MaskMaterial.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

strength

get strength(): number
The current mask strength.

Individual mask values will be clamped to [0.0, 1.0]. Has no effect when the mask function is set to DISCARD.

Returns number
- Defined in src/materials/MaskMaterial.ts:132
set strength(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/MaskMaterial.ts:138

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 MaskMaterial

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MaskMaterial

Accessors

colorChannel

Returns ColorChannel

Default Value

Parameters

Returns void

Protectedfar

Returns number

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

inverted

Returns boolean

Parameters

Returns void

maskFunction

Returns MaskFunction

Default Value

Parameters

Returns void

maskTexture

Parameters

Returns void

Protectednear

Returns number

outputPrecision

Returns Precision

Parameters

Returns void

strength

Returns number

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near