Class: EffectComposer
EffectComposer with support for simple post processing effects
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new EffectComposer(params)
Constructor for a new EffectComposer
Parameters
| Name | Type | Description |
|---|---|---|
params | EffectComposerParams | params for the EffectComposer |
Defined in
packages/three/src/postprocessing/effect-composer.ts:91
Properties
_effects
• _effects: Effect[] = []
Effects in the effect composer
Defined in
packages/three/src/postprocessing/effect-composer.ts:85
camera
• camera: Camera
The camera for the effect composer
Defined in
packages/three/src/postprocessing/effect-composer.ts:55
composer
• composer: EffectComposer
The effect composer implementation
Defined in
packages/three/src/postprocessing/effect-composer.ts:65
effectPass
• effectPass: undefined | EffectPass
The effect composers effect pass
Defined in
packages/three/src/postprocessing/effect-composer.ts:80
normalPass
• normalPass: undefined | NormalPass
The effect composers default normal pass
Defined in
packages/three/src/postprocessing/effect-composer.ts:75
renderPass
• renderPass: RenderPass
The effect composers default render pass
Defined in
packages/three/src/postprocessing/effect-composer.ts:70
renderer
• renderer: WebGLRenderer
The renderer for the effect composer
Defined in
packages/three/src/postprocessing/effect-composer.ts:50
scene
• scene: Scene
The scene for the effect composer
Defined in
packages/three/src/postprocessing/effect-composer.ts:60
Accessors
add
• get add(): Object
Methods for adding to the Effect Composer
Returns
Object
| Name | Type |
|---|---|
effects | (...e: Effect[]) => void |
pass | (pass: Pass, index?: number) => void |
Defined in
packages/three/src/postprocessing/effect-composer.ts:120
remove
• get remove(): Object
Methods for removing from the effect composer
Returns
Object
| Name | Type |
|---|---|
effect | (effect: Effect) => void |
pass | (pass: Pass) => void |
Defined in
packages/three/src/postprocessing/effect-composer.ts:143
Methods
addEffects
▸ Private addEffects(effects): void
Adds effects to the effect composers built in effect pass
Parameters
| Name | Type | Description |
|---|---|---|
effects | Effect[] | the effects to add |
Returns
void
Defined in
packages/three/src/postprocessing/effect-composer.ts:184
recreateEffectPass
▸ Private recreateEffectPass(): void
Recreates the effect pass
Returns
void
Defined in
packages/three/src/postprocessing/effect-composer.ts:192
render
▸ render(timeElapsed): void
Renders the effect composer
Parameters
| Name | Type | Description |
|---|---|---|
timeElapsed | number | the time elapsed |
Returns
void
Defined in
packages/three/src/postprocessing/effect-composer.ts:167
setSize
▸ setSize(width, height): void
Sets the size of the effect composer
Parameters
| Name | Type | Description |
|---|---|---|
width | number | the width for the effect composer |
height | number | the height for the effect composer |
Returns
void