FORGE. PostProcessing

new PostProcessing(viewer)

FORGE.PostProcessing Post processing class.
Parameters:
Name Type Description
viewer FORGE.Viewer FORGE.Viewer reference.
Source:

Extends

Members

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

_parsePassConfig(passConfig) → {THREE.Pass}

Parse shader config
Parameters:
Name Type Description
passConfig FX a pass configuration
Source:
Returns:
pass to be added to the render pipeline
Type
THREE.Pass

_parseShaderConfig(shaderConfig) → {THREE.Pass}

Parse shader config
Parameters:
Name Type Description
shaderConfig FX a shader configuration
Source:
Returns:
pass to be added to the render pipeline
Type
THREE.Pass

addConfig(config)

Add a post processing config.
Parameters:
Name Type Description
config FXConfig The config you want to add.
Source:

addConfig(uid) → {Array.<FX>}

Add a post processing config.
Parameters:
Name Type Description
uid string fx unique identifier
Source:
Returns:
fx set
Type
Array.<FX>

destroy()

Destroy sequence
Overrides:
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

parseShaderPasses(fxConfig) → {Array.<THREE.ShaderPass>}

Parse shader passes from FX configuration object
Parameters:
Name Type Description
fxConfig Array.<FX> a set of FX
Source:
Returns:
array of shader passes
Type
Array.<THREE.ShaderPass>

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
 The value you want to warn in the console.
Inherited From:
Source:

FORGE. PostProcessing

Members
Methods