Compositor

clay.compositor. Compositor

# new Compositor()

Source:

Compositor provide graph based post processing

Extends

Members

# __uid__ :number

Source:
Inherited From:
Type:
  • number

# nodes :Array.<clay.compositor.CompositorNode>

Source:
Inherited From:
Type:

Methods

# addNode(node)

Source:
Overrides:
Parameters:
Name Type Description
node clay.compositor.CompositorNode

# after(name, action, contextopt)

Source:
Inherited From:
Mixes In:

Alias of once('after' + name)

Parameters:
Name Type Attributes Description
name string
action function
context Object <optional>

# before(name, action, contextopt)

Source:
Inherited From:
Mixes In:

Alias of once('before' + name)

Parameters:
Name Type Attributes Description
name string
action function
context Object <optional>

# dirty()

Source:
Inherited From:

Mark to update

# dispose(renderer)

Source:

Dispose compositor

Parameters:
Name Type Description
renderer clay.Renderer

# error(action, contextopt)

Source:
Inherited From:
Mixes In:

Alias of on('error')

Parameters:
Name Type Attributes Description
action function
context Object <optional>

# getNodeByName(name) → {clay.compositor.CompositorNode}

Source:
Inherited From:
Parameters:
Name Type Description
name string
Returns:
Type
clay.compositor.CompositorNode

# has(name, action) → {boolean}

Source:
Inherited From:
Mixes In:

If registered the event handler

Parameters:
Name Type Description
name string
action function
Returns:
Type
boolean

# off(action, contextopt)

Source:
Inherited From:
Mixes In:

Remove event listener

Parameters:
Name Type Attributes Description
action function
context Object <optional>

# on(name, action, contextopt)

Source:
Inherited From:
Mixes In:

Register event handler

Parameters:
Name Type Attributes Description
name string
action function
context Object <optional>

# once(name, action, contextopt)

Source:
Inherited From:
Mixes In:

Register event, event will only be triggered once and then removed

Parameters:
Name Type Attributes Description
name string
action function
context Object <optional>

# removeNode(node)

Source:
Inherited From:
Parameters:
Name Type Description
node clay.compositor.CompositorNode | string

# render(renderer)

Source:
Parameters:
Name Type Description
renderer clay.Renderer

# success(action, contextopt)

Source:
Inherited From:
Mixes In:

Alias of on('success')

Parameters:
Name Type Attributes Description
action function
context Object <optional>

# trigger(name)

Source:
Inherited From:
Mixes In:

Trigger event

Parameters:
Name Type Description
name string

# update()

Source:
Inherited From:

Update links of graph