Pass

clay.compositor. Pass

# new Pass()

Source:

Extends

Members

# __uid__ :number

Source:
Inherited From:
Type:
  • number

# blendWithPrevious :Boolean

Source:
Type:
  • Boolean

# clearColor :Boolean

Source:
Type:
  • Boolean

# clearDepth :Boolean

Source:
Type:
  • Boolean

# fragment :string

Source:

Fragment shader string

Type:
  • string

# material :clay.Material

Source:
Type:

# outputs :Object

Source:
Type:
  • Object

Methods

# 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>

# attachOutput(texture, attachment)

Source:
Parameters:
Name Type Description
texture clay.Texture
attachment number

# 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>

# detachOutput(texture)

Source:
Parameters:
Name Type Description
texture clay.Texture

# dispose(renderer)

Source:
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>

# getUniform(name)

Source:
Parameters:
Name Type Description
name string
Returns:

# 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>

# render(renderer, frameBufferopt)

Source:
Parameters:
Name Type Attributes Description
renderer clay.Renderer
frameBuffer clay.FrameBuffer <optional>

# renderQuad()

Source:

Simply do quad rendering

# setUniform(name, value)

Source:
Parameters:
Name Type Description
name string
value

# 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