Class TiltShiftBlurMaterial

A tilt shift material.

Hierarchy (View Summary)

KawaseBlurMaterial
- TiltShiftBlurMaterial

Implements

TiltShiftBlurMaterialOptions

Index

Constructors

constructor

new TiltShiftBlurMaterial(
options?: TiltShiftBlurMaterialOptions,
): TiltShiftBlurMaterial
Constructs a new tilt shift material.
Parameters
- options: TiltShiftBlurMaterialOptions = {}
  The options.
Returns TiltShiftBlurMaterial
Overrides KawaseBlurMaterial.constructor
- Defined in src/materials/TiltShiftBlurMaterial.ts:80

Properties

kernelSize

kernelSize: KernelSize

The kernel size.

Accessors

`Protected`far

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

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

feather

get feather(): number
The softness of the focus area edges.

Returns number
Implementation of TiltShiftBlurMaterialOptions.feather
- Defined in src/materials/TiltShiftBlurMaterial.ts:164
set feather(value: number): void
The softness of the focus area edges.
Parameters
- value: number
Returns void
Implementation of TiltShiftBlurMaterialOptions.feather
- Defined in src/materials/TiltShiftBlurMaterial.ts:170

focusArea

get focusArea(): number
The relative size of the focus area.

Returns number
Implementation of TiltShiftBlurMaterialOptions.focusArea
- Defined in src/materials/TiltShiftBlurMaterial.ts:151
set focusArea(value: number): void
The relative size of the focus area.
Parameters
- value: number
Returns void
Implementation of TiltShiftBlurMaterialOptions.focusArea
- Defined in src/materials/TiltShiftBlurMaterial.ts:157

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

kernel

get kernel(): number
The current kernel. Can be configured using the kernelSequence.

Returns number
Inherited from KawaseBlurMaterial.kernel
- Defined in src/materials/KawaseBlurMaterial.ts:86
set kernel(value: number): void
Parameters
- value: number
Returns void
Inherited from KawaseBlurMaterial.kernel
- Defined in src/materials/KawaseBlurMaterial.ts:92

kernelSequence

get kernelSequence(): Float32Array
The kernel sequence for the current kernel size. Can be used to configure the kernel.

Returns Float32Array
Inherited from KawaseBlurMaterial.kernelSequence
- Defined in src/materials/KawaseBlurMaterial.ts:60

`Protected`near

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

Returns number
Inherited from KawaseBlurMaterial.near
- Defined in src/materials/FullscreenMaterial.ts:164

offset

get offset(): number
The relative offset of the focus area.

Returns number
Implementation of TiltShiftBlurMaterialOptions.offset
- Defined in src/materials/TiltShiftBlurMaterial.ts:138
set offset(value: number): void
The relative offset of the focus area.
Parameters
- value: number
Returns void
Implementation of TiltShiftBlurMaterialOptions.offset
- Defined in src/materials/TiltShiftBlurMaterial.ts:144

outputPrecision

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

Returns Precision
Inherited from KawaseBlurMaterial.outputPrecision
- Defined in src/materials/FullscreenMaterial.ts:94
set outputPrecision(value: Precision): void
Parameters
- value: Precision
Returns void
Inherited from KawaseBlurMaterial.outputPrecision
- Defined in src/materials/FullscreenMaterial.ts:100

rotation

get rotation(): number
The rotation of the focus area in radians.

Returns number
Implementation of TiltShiftBlurMaterialOptions.rotation
- Defined in src/materials/TiltShiftBlurMaterial.ts:124
set rotation(value: number): void
The rotation of the focus area in radians.
Parameters
- value: number
Returns void
Implementation of TiltShiftBlurMaterialOptions.rotation
- Defined in src/materials/TiltShiftBlurMaterial.ts:131

scale

get scale(): number
The blur scale.

Returns number
Inherited from KawaseBlurMaterial.scale
- Defined in src/materials/KawaseBlurMaterial.ts:70
set scale(value: number): void
Parameters
- value: number
Returns void
Inherited from KawaseBlurMaterial.scale
- Defined in src/materials/KawaseBlurMaterial.ts:76

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 KawaseBlurMaterial.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
Overrides KawaseBlurMaterial.setSize
- Defined in src/materials/TiltShiftBlurMaterial.ts:177

Class TiltShiftBlurMaterial

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TiltShiftBlurMaterial

Properties

kernelSize

Accessors

Protectedfar

Returns number

feather

Returns number

Parameters

Returns void

focusArea

Returns number

Parameters

Returns void

inputBuffer

Returns Texture<unknown> | null

Parameters

Returns void

kernel

Returns number

Parameters

Returns void

kernelSequence

Returns Float32Array

Protectednear

Returns number

offset

Returns number

Parameters

Returns void

outputPrecision

Returns Precision

Parameters

Returns void

rotation

Returns number

Parameters

Returns void

scale

Returns number

Parameters

Returns void

Methods

copyCameraSettings

Parameters

Returns void

setSize

Parameters

Returns void

Settings

On This Page

`Protected`far

`Protected`near