Class PersistenceEffect

A drop-in Persistence Effect

Credit: https://tympanus.net/codrops/2021/12/28/adding-a-persistence-effect-to-three-js-scenes/

Demo: https://kokomi-playground.vercel.app/entries/#starTunnel

Hierarchy (view full)

Component
- PersistenceEffect

Index

Constructors

constructor

new PersistenceEffect(base, config?): PersistenceEffect
Parameters
- base: Base
- config: Partial<PersistenceEffectConfig> = {}
Returns PersistenceEffect
Overrides Component.constructor
- Defined in src/effects/persistenceEffect.ts:37

Properties

base

base: Base

clearColor

clearColor: number

container

container: Scene

emitter

emitter: Emitter<any>

fadeColor

fadeColor: Color

fadeFactor

fadeFactor: number

fadeMaterial

fadeMaterial: ShaderMaterial

fadePlane

fadePlane: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

framebuffer1

framebuffer1: WebGLRenderTarget<Texture>

framebuffer2

framebuffer2: WebGLRenderTarget<Texture>

isActive

isActive: boolean

orthoCamera

orthoCamera: OrthographicCamera

resultPlane

resultPlane: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

rotationAngle

rotationAngle: number

scaleX

scaleX: number

scaleY

scaleY: number

uvMatrix

uvMatrix: Matrix3

Methods

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/effects/persistenceEffect.ts:132

disable

disable(): void
Returns void
- Defined in src/effects/persistenceEffect.ts:156

emit

emit(type, event?): void
Parameters
- type: string
- event: any = {}
Returns void
Inherited from Component.emit
- Defined in src/components/component.ts:41

enable

enable(): void
Returns void
- Defined in src/effects/persistenceEffect.ts:153

off

off(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.off
- Defined in src/components/component.ts:37

on

on(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.on
- Defined in src/components/component.ts:33

update

update(time): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/effects/persistenceEffect.ts:159

Class PersistenceEffect

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PersistenceEffect

Properties

base

clearColor

container

emitter

fadeColor

fadeFactor

fadeMaterial

fadePlane

framebuffer1

framebuffer2

isActive

orthoCamera

resultPlane

rotationAngle

scaleX

scaleY

uvMatrix

Methods

addExisting

Returns void

disable

Returns void

emit

Parameters

Returns void

enable

Returns void

off

Parameters

Returns void

on

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page