Class CustomEffect

With this, you can just provide your vertex and fragment shader to make a customized postprocessing effect.

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

Hierarchy (View Summary)

Component
- CustomEffect

Index

Constructors

Properties

base composer container customPass emitter uniformInjector

Methods

addExisting emit off on update

Constructors

constructor

new CustomEffect(base: Base, config?: Partial<CustomEffectConfig>): CustomEffect
Parameters
- base: Base
- config: Partial<CustomEffectConfig> = {}
Returns CustomEffect
Overrides Component.constructor
- Defined in src/postprocessing/customEffect.ts:55

Properties

base

base: Base

composer

composer: EffectComposer

container

container: Scene

customPass

customPass: ShaderPass

emitter

emitter: Emitter<any>

uniformInjector

uniformInjector: UniformInjector

Methods

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/postprocessing/customEffect.ts:90

emit

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

off

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

on

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

update

update(time: number): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/postprocessing/customEffect.ts:93