Class PostProcessingHandler

PostProcessingHandler is responsible for applying post processing effects to the scene. It is internally used by the Volume component

Index

Constructors

Accessors

anyPassHasDepth anyPassHasNormal composer hasSmaaEffect isActive multisampling

Methods

apply dispose getEffectIsActive unapply

Constructors

constructor

new PostProcessingHandler(context: Context): PostProcessingHandler
Parameters
- context: Context
Returns PostProcessingHandler

Accessors

anyPassHasDepth

get anyPassHasDepth(): boolean
Returns boolean

anyPassHasNormal

get anyPassHasNormal(): boolean
Returns boolean

composer

get composer(): null | EffectComposer
Returns null | EffectComposer

hasSmaaEffect

get hasSmaaEffect(): boolean
Returns boolean

isActive

get isActive(): boolean
Returns boolean

multisampling

get multisampling(): number
Returns number
set multisampling(value: number): void
Parameters
- value: number
Returns void

Methods

apply

apply(components: PostProcessingEffect[]): Promise<void>
Parameters
- components: PostProcessingEffect[]
Returns Promise<void>

dispose

dispose(): void
Returns void

getEffectIsActive

getEffectIsActive(effect: Effect): boolean
Returns true if a specific effect is currently active in the post processing stack.
Parameters
- effect: Effect
Returns boolean

unapply

unapply(dispose?: boolean): void
Parameters
- dispose: boolean = true
Returns void