Class: PostProcessingComponent
Components are used to attach functionality to object3D, it has an owner object3D. The component can receive update events at each frame.
Hierarchy
↳
PostProcessingComponent
Properties
Constructors
Accessors
Methods
- onUpdate
- onLateUpdate
- onBeforeUpdate
- onCompute
- onGraphic
- onParentChange
- cloneTo
- destroy
- init
- start
- stop
- onEnable
- onDisable
- addPost
- removePost
- getPost
Properties
object3D
• object3D: Object3D
= null
owner object3D
Inherited from
Defined in
src/components/ComponentBase.ts:17
Constructors
constructor
• new PostProcessingComponent()
Inherited from
Defined in
src/components/ComponentBase.ts:31
Accessors
transform
• get
transform(): Transform
Return the Transform component attached to the Object3D.
Returns
Inherited from
ComponentBase.transform
Defined in
src/components/ComponentBase.ts:38
enable
• get
enable(): boolean
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Returns
boolean
Inherited from
ComponentBase.enable
Defined in
src/components/ComponentBase.ts:59
• set
enable(value
): void
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
ComponentBase.enable
Defined in
src/components/ComponentBase.ts:45
Methods
onUpdate
▸ Optional
onUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:111
onLateUpdate
▸ Optional
onLateUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:112
onBeforeUpdate
▸ Optional
onBeforeUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:113
onCompute
▸ Optional
onCompute(view?
, command?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
command? | GPUCommandEncoder |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:114
onGraphic
▸ Optional
onGraphic(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:115
onParentChange
▸ Optional
onParentChange(lastParent?
, currentParent?
): any
Parameters
Name | Type |
---|---|
lastParent? | Object3D |
currentParent? | Object3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:116
cloneTo
▸ cloneTo(obj
): void
clone component data to target object3D
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | target object3D |
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:123
destroy
▸ destroy(force?
): void
release this component
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:190
init
▸ init(param?
): void
Parameters
Name | Type |
---|---|
param? | any |
Returns
void
Overrides
Defined in
src/components/post/PostProcessingComponent.ts:8
start
▸ start(): void
Returns
void
Overrides
Defined in
src/components/post/PostProcessingComponent.ts:12
stop
▸ stop(): void
Returns
void
Overrides
Defined in
src/components/post/PostProcessingComponent.ts:16
onEnable
▸ onEnable(): void
Returns
void
Overrides
Defined in
src/components/post/PostProcessingComponent.ts:20
onDisable
▸ onDisable(): void
Returns
void
Overrides
Defined in
src/components/post/PostProcessingComponent.ts:24
addPost
▸ addPost<T
>(c
): T
Type parameters
Name | Type |
---|---|
T | extends PostBase <T > |
Parameters
Name | Type |
---|---|
c | Ctor <T > |
Returns
T
Defined in
src/components/post/PostProcessingComponent.ts:44
removePost
▸ removePost<T
>(c
): void
Type parameters
Name | Type |
---|---|
T | extends PostBase <T > |
Parameters
Name | Type |
---|---|
c | Ctor <T > |
Returns
void
Defined in
src/components/post/PostProcessingComponent.ts:55
getPost
▸ getPost<T
>(c
): T
Type parameters
Name | Type |
---|---|
T | extends PostBase <T > |
Parameters
Name | Type |
---|---|
c | Ctor <T > |
Returns
T