Class Postprocessing

后期处理基于库https://github.com/vanruesc/postprocessing

Export

Date

2021.11.16

Author

xwb

Hierarchy

PostprocessingBase
- Postprocessing

Index

Constructors

Properties

_camera _enabled _renderer _scene

Accessors

Methods

_onDisable _onEnable addEffect addEffects addPass dispose getEffect render setMainCamera setMainScene setSize

Constructors

constructor

new Postprocessing(renderer, scene, camera, paramters?): Postprocessing
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- paramters: PostprocessingParameters = ...
Returns Postprocessing

Overrides PostprocessingBase.constructor

Properties

`Protected` _camera

_camera: Camera

`Protected` _enabled

_enabled: boolean

`Protected` _renderer

_renderer: WebGLRenderer

`Protected` _scene

_scene: Scene

Accessors

enabled

get enabled(): boolean
获取后期效果是否已启用

Returns boolean

Memberof
PostprocessingBase

Inherited from PostprocessingBase.enabled
set enabled(value): void
设置是否启用后期
Parameters
- value: boolean
Returns void

Memberof
PostprocessingBase

Inherited from PostprocessingBase.enabled

Methods

`Protected` _onDisable

_onDisable(): void
Protected
禁用后期处理

Returns void

Memberof
Postprocessing

Overrides PostprocessingBase._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用后期处理

Returns void

Memberof
Postprocessing

Overrides PostprocessingBase._onEnable

addEffect

addEffect<T>(type, effectParams): T
添加后处理效果
Type Parameters
- T extends EffcetBase
Parameters
- type: EffectCtor<T>
  
  效果类型
- effectParams: EffectParameters | EffectParameters[]
  
  效果参数
Returns T

Memberof
Postprocessing

addEffects

addEffects(...effects): void
添加后处理库原生效果
Parameters
- Rest ...effects: Effect[]
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.addEffects

addPass

addPass(pass): void
添加后处理库原生pass
Parameters
- pass: Pass
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.addPass

dispose

dispose(): void
释放

Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.dispose

getEffect

getEffect<T>(type): T
获取添加过的后处理效果
Type Parameters
- T extends EffcetBase
Parameters
- type: EffectCtor<T>
  
  效果类型
Returns T

Memberof
Postprocessing

render

render(timeSinceLastFrame, renderTarget?): void
后期渲染
Parameters
- timeSinceLastFrame: number
  
  距离上一帧的更新时长（单位：毫秒）
- Optional renderTarget: WebGLRenderTarget<Texture>
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.render

setMainCamera

setMainCamera(camera): void
设置新的相机
Parameters
- camera: Camera
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.setMainCamera

setMainScene

setMainScene(scene): void
设置新的场景
Parameters
- scene: Scene
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.setMainScene

setSize

setSize(width, height): void
设置后期渲染宽高
Parameters
- width: number
- height: number
Returns void

Memberof
Postprocessing

Overrides PostprocessingBase.setSize