Class PostProcessModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- PostProcessModule

Implements

IAppModuleBase

Constructors

constructor

new PostProcessModule(app?, options?): PostProcessModule
Parameters
- Optional app: App
- Optional options: PostProcessModuleOptions
Returns PostProcessModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

_composer

_composer: EffectComposer

`Protected` _destroyed

_destroyed: boolean = false

_isFirstRender

_isFirstRender: boolean = true

_passes

_passes: Pass[] = []

appRenderIndex

appRenderIndex: number = 0

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

depthPickingPass

depthPickingPass: DepthPickingPass

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: PostProcessModuleOptions

signal

signal: {
    afterAddComposer: Signal;
    afterAddRenderPass: Signal;
    afterRebuild: Signal;
    afterRemoveComposer: Signal;
    afterRemoveRenderPass: Signal;
    afterRenderComposer: Signal;
    beforRebuild: Signal;
    beforRenderComposer: Signal;
    beforeAddComposer: Signal;
    beforeAddRenderPass: Signal;
    beforeRemoveComposer: Signal;
    beforeRemoveRenderPass: Signal;
} = ...

Type declaration

afterAddComposer: Signal
afterAddRenderPass: Signal
afterRebuild: Signal
afterRemoveComposer: Signal
afterRemoveRenderPass: Signal
afterRenderComposer: Signal
beforRebuild: Signal
beforRenderComposer: Signal
beforeAddComposer: Signal
beforeAddRenderPass: Signal
beforeRemoveComposer: Signal
beforeRemoveRenderPass: Signal

`Static` moduleName

moduleName: string = "PostProcessModule"

Accessors

app

get app(): App
Returns App
Inherited from AppModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from AppModuleBase.app

bloomEffect

get bloomEffect(): SelectiveBloomEffect
Returns SelectiveBloomEffect

composer

get composer(): EffectComposer
Returns EffectComposer

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

outlineEffect

get outlineEffect(): OutlineEffect
Returns OutlineEffect

selectedEffect

get selectedEffect(): OutlineEffect
Returns OutlineEffect

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

addColorDepthEffect

addColorDepthEffect(): void
Returns void

addDepthOfFieldEffect

addDepthOfFieldEffect(): void
Returns void

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.addDispose

addEffectRenderPass

addEffectRenderPass(pass, orderIndex?): void
Parameters
- pass: Pass
- Optional orderIndex: number
Returns void

addGlitchEffect

addGlitchEffect(): void
Returns void

addKawaseBlurPass

addKawaseBlurPass(): void
Returns void

addPixelationEffect

addPixelationEffect(): void
Returns void

addSSAOEffect

addSSAOEffect(): void
Returns void

addToneMappingEffect

addToneMappingEffect(): void
Returns void

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from AppModuleBase.applyMixinsTo

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from AppModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from AppModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

getDepth

getDepth(x, y): Promise<number>
Parameters
- x: number
- y: number
Returns Promise<number>

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from AppModuleBase.hasEvent

isComposerEnable

isComposerEnable(): boolean
Returns boolean

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from AppModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from AppModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.on

onAppRender

onAppRender(time): void
Parameters
- time: Time
Returns void
Implementation of IAppModuleBase.onAppRender

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.once

refreshEffectRenderPass

refreshEffectRenderPass(foreceUpdate?): void
Parameters
- Optional foreceUpdate: boolean
Returns void

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.removeDispose

removeEffectRenderPass

removeEffectRenderPass(pass): void
Parameters
- pass: Pass
Returns void

setComposerEnable

setComposerEnable(b): void
Parameters
- b: boolean
Returns void

setEffectRenderPassEnable

setEffectRenderPassEnable(pass, enable): void
Parameters
- pass: Pass
- enable: boolean
Returns void

setEffectRenderPassOrder

setEffectRenderPassOrder(pass, orderIndex): void
Parameters
- pass: Pass
- orderIndex: number
Returns void

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>

Class PostProcessModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional app: App

Optional options: PostProcessModuleOptions

Returns PostProcessModule

Properties

Optional _app

_composer

Protected _destroyed

_isFirstRender

_passes

appRenderIndex

data

Type declaration

[key: string]: any

depthPickingPass

extData

Type declaration

[key: string]: any

Readonly instanceId

onSetApp

options

signal

Type declaration

afterAddComposer: Signal

afterAddRenderPass: Signal

afterRebuild: Signal

afterRemoveComposer: Signal

afterRemoveRenderPass: Signal

afterRenderComposer: Signal

beforRebuild: Signal

beforRenderComposer: Signal

beforeAddComposer: Signal

beforeAddRenderPass: Signal

beforeRemoveComposer: Signal

beforeRemoveRenderPass: Signal

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

bloomEffect

Returns SelectiveBloomEffect

composer

Returns EffectComposer

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

outlineEffect

Returns OutlineEffect

selectedEffect

Returns OutlineEffect

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

`Optional` app: App

`Optional` options: PostProcessModuleOptions

`Optional` _app

`Protected` _destroyed

`Readonly` instanceId

`Static` moduleName

`Optional` orderIndex: number

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` fn: Function