Class: ScreenRenderTarget

Constructor

new ScreenRenderTarget(view)

Create a new ScreenRenderTarget.

Parameters:

Name	Type	Description
`view`	HTMLCanvasElement	The canvas element which the Render Target rendered to.

Extends

RenderTargetBase

Members

clearColor :boolean

Whether to clear the color buffer before rendering to this render target.

Type:

boolean

Overrides: RenderTargetBase#clearColor
Default Value: true

clearDepth :boolean

Whether to clear the depth buffer before rendering to this render target.

Type:

boolean

Overrides: RenderTargetBase#clearDepth
Default Value: true

clearStencil :boolean

Whether to clear the stencil buffer before rendering to this render target.

Type:

boolean

Overrides: RenderTargetBase#clearStencil
Default Value: true

colorClearValue :Color4

Clear color value.

Type:

Color4

Overrides: RenderTargetBase#colorClearValue

depthClearValue :number

Clear depth value.

Type:

number

Overrides: RenderTargetBase#depthClearValue
Default Value: 1

height :number

The height of the render target.

Type:

number

Overrides: RenderTargetBase#height

(readonly) isRenderTarget :boolean

This flag can be used for type testing.

Type:

boolean

Overrides: RenderTargetBase#isRenderTarget
Default Value: true

(readonly) isScreenRenderTarget :boolean

This flag can be used for type testing.

Type:

boolean

Default Value: true

occlusionQuerySet :QuerySet|null

A querySet that will store the occlusion query results. If null, occlusion queries are disabled.

Type:

QuerySet | null

Overrides: RenderTargetBase#occlusionQuerySet
Default Value: null

stencilClearValue :number

Clear stencil value.

Type:

number

Overrides: RenderTargetBase#stencilClearValue
Default Value: 0

timestampWrites :object

An array of objects defining where and when timestamp query values will be written.

Type:

object

Properties

Name	Type	Description
`querySet`	QuerySet \| null	A timestamp querySet. If null, timestamp queries are disabled.
`beginningOfPassWriteIndex`	number	A number specifying the query index in querySet where the timestamp at the beginning of the render pass will be written.
`endOfPassWriteIndex`	number	A number specifying the query index in querySet where the timestamp at the end of the render pass will be written.

Overrides: RenderTargetBase#timestampWrites

view :HTMLCanvasElement

The canvas element which the Render Target rendered to.

Type:

HTMLCanvasElement

width :number

The width of the render target.

Type:

number

Overrides: RenderTargetBase#width

Methods

addEventListener(type, listener)

Adds a listener to an event type.

Parameters:

Name	Type	Description
`type`	string	The type of event to listen to.
`listener`	function	The function that gets called when the event is fired.

Overrides: RenderTargetBase#addEventListener

dispatchEvent(event)

Fire an event.

Parameters:

Name	Type	Description
`event`	object	The event that gets fired.

Overrides: RenderTargetBase#dispatchEvent

dispose()

Dispatches a dispose event.

Overrides: RenderTargetBase#dispose

removeEventListener(type, listener)

Removes a listener from an event type.

Parameters:

Name	Type	Description
`type`	string	The type of the listener that gets removed.
`listener`	function	The listener function that gets removed.

Overrides: RenderTargetBase#removeEventListener

resize(width, height)

Resizes the render target to the specified dimensions. This method will set the width and height properties of the canvas.

Parameters:

Name	Type	Description
`width`	number	The width of the render target.
`height`	number	The height of the render target.

Overrides: RenderTargetBase#resize

setClear(coloropt, depthopt, stencilopt) → {RenderTargetBase}

Sets the clear state.

Parameters:

Name	Type	Attributes	Description
`color`	boolean	<optional>	Whether to clear the color buffer.
`depth`	boolean	<optional>	Whether to clear the depth buffer.
`stencil`	boolean	<optional>	Whether to clear the stencil buffer.

Overrides: RenderTargetBase#setClear

Returns:

A reference to this render target.

Type:: RenderTargetBase

setColorClearValue(r, g, b, a) → {RenderTargetBase}

Sets the clear values.

Parameters:

Name	Type	Description
`r`	number	Red channel value between 0.0 and 1.0.
`g`	number	Green channel value between 0.0 and 1.0.
`b`	number	Blue channel value between 0.0 and 1.0.
`a`	number	Alpha channel value between 0.0 and 1.0.

Overrides: RenderTargetBase#setColorClearValue

Returns:

A reference to this render target.

Type:: RenderTargetBase

setDepthClearValue(depth) → {RenderTargetBase}

Sets the clear depth value.

Parameters:

Name	Type	Description
`depth`	number	The depth value.

Overrides: RenderTargetBase#setDepthClearValue

Returns:

A reference to this render target.

Type:: RenderTargetBase

setOcclusionQuerySet(querySet) → {RenderTargetBase}

Sets the occlusion query set.

Parameters:

Name	Type	Description
`querySet`	QuerySet \| null	The occlusion query set. If null, occlusion queries are disabled.

Overrides: RenderTargetBase#setOcclusionQuerySet

Returns:

A reference to this render target.

Type:: RenderTargetBase

setStencilClearValue(stencil) → {RenderTargetBase}

Sets the clear stencil value.

Parameters:

Name	Type	Description
`stencil`	number	The stencil value.

Overrides: RenderTargetBase#setStencilClearValue

Returns:

A reference to this render target.

Type:: RenderTargetBase

setTimestampWrites(querySet, beginIndexopt, endIndexopt) → {RenderTargetBase}

Sets the timestamp query set and the query indices.

Parameters:

Name	Type	Attributes	Default	Description
`querySet`	QuerySet \| null			The timestamp query set. If null, timestamp queries are disabled.
`beginIndex`	number	<optional>	0	The query index in querySet where the timestamp at the beginning of the render pass will be written.
`endIndex`	number	<optional>	1	The query index in querySet where the timestamp at the end of the render pass will be written.

Overrides: RenderTargetBase#setTimestampWrites

Returns:

A reference to this render target.

Type:: RenderTargetBase