Renderer

Renderer

# new Renderer()

Source:

deferred/Renderer.js, line 54

Deferred renderer

Extends

clay.core.Base

Members

# uid :number

Source:

core/Base.js, line 15

Inherited From:

clay.core.Base#__uid__

Type:

number

# autoResize :boolean

Source:

deferred/Renderer.js, line 109

If enable auto resizing from given defualt renderer size.

Type:

boolean

# shadowMapPass :clay.prePass.ShadowMap

Source:

deferred/Renderer.js, line 104

Provide ShadowMapPass for shadow rendering.

Type:

clay.prePass.ShadowMap

Methods

# after(name, action, contextopt)

Source:

core/mixin/notifier.js, line 125

Inherited From:

clay.core.Base#after

Mixes In:

clay.core.mixin.notifier.after

Alias of once('after' + name)

Parameters:

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

# before(name, action, contextopt)

Source:

core/mixin/notifier.js, line 110

Inherited From:

clay.core.Base#before

Mixes In:

clay.core.mixin.notifier.before

Alias of once('before' + name)

Parameters:

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

# dispose(renderer)

Source:

deferred/Renderer.js, line 618

Parameters:

Name	Type	Description
`renderer`	clay.Renderer

# error(action, contextopt)

Source:

core/mixin/notifier.js, line 149

Inherited From:

clay.core.Base#error

Mixes In:

clay.core.mixin.notifier.error

Alias of on('error')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# getGBuffer() → {clay.deferred.GBuffer}

Source:

deferred/Renderer.js, line 224

Returns:

Type: clay.deferred.GBuffer

# getTargetFrameBuffer() → {clay.FrameBuffer}

Source:

deferred/Renderer.js, line 217

Returns:

Type: clay.FrameBuffer

# getTargetTexture() → {clay.Texture2D}

Source:

deferred/Renderer.js, line 210

Returns:

Type: clay.Texture2D

# has(name, action) → {boolean}

Source:

core/mixin/notifier.js, line 187

Inherited From:

clay.core.Base#has

Mixes In:

clay.core.mixin.notifier.has

If registered the event handler

Parameters:

Name	Type	Description
`name`	string
`action`	function

Returns:

Type: boolean

# off(action, contextopt)

Source:

core/mixin/notifier.js, line 159

Inherited From:

clay.core.Base#off

Mixes In:

clay.core.mixin.notifier.off

Remove event listener

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# on(name, action, contextopt)

Source:

core/mixin/notifier.js, line 65

Inherited From:

clay.core.Base#on

Mixes In:

clay.core.mixin.notifier.on

Register event handler

Parameters:

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

# once(name, action, contextopt)

Source:

core/mixin/notifier.js, line 91

Inherited From:

clay.core.Base#once

Mixes In:

clay.core.mixin.notifier.once

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, scene, camera, optsopt)

Source:

deferred/Renderer.js, line 170

Do render

Parameters:

Name Type Attributes Description

renderer clay.Renderer

scene clay.Scene

camera clay.Camera

opts

Object

<optional>

Properties

Name	Type	Attributes	Default	Description
`renderToTarget`	boolean	<optional>	`false`	If not ouput and render to the target texture
`notUpdateShadow`	boolean	<optional>	`true`	If not update the shadow.
`notUpdateScene`	boolean	<optional>	`true`	If not update the scene.

# resize(width, height)

Source:

deferred/Renderer.js, line 243

Set renderer size.

Parameters:

Name	Type	Description
`width`	number
`height`	number

# success(action, contextopt)

Source:

core/mixin/notifier.js, line 139

Inherited From:

clay.core.Base#success

Mixes In:

clay.core.mixin.notifier.success

Alias of on('success')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# trigger(name)

Source:

core/mixin/notifier.js, line 14

Inherited From:

clay.core.Base#trigger

Mixes In:

clay.core.mixin.notifier.trigger

Trigger event

Parameters:

Name	Type	Description
`name`	string