Class: OffscreenRenderTarget

Constructor

new OffscreenRenderTarget(width, height)

Create a new OffscreenRenderTarget.

Parameters:

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

Extends

RenderTargetBase

Members

activeCubeFace :number

An alias for OffscreenRenderTarget#activeLayer. Specifically represents the currently rendered cube face (0-5) when using cube textures.

Type:

number

activeLayer :number

The active layer index for rendering. For cube render targets, this represents the active cube face.

Type:

number

Default Value: 0

activeMipmapLevel :number

The active mipmap level for rendering. Not supported in WebGL1.

Type:

number

Default Value: 0

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) isOffscreenRenderTarget :boolean

This flag can be used for type testing.

Type:

boolean

Default Value: true

(readonly) isRenderTarget :boolean

This flag can be used for type testing.

Type:

boolean

Overrides: RenderTargetBase#isRenderTarget
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

texture :TextureBase|null

The main texture attachment which is the first color attachment.

Type:

TextureBase | null

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

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

attach(target, attachmentopt) → {OffscreenRenderTarget}

Attach a texture(RTT) or renderbuffer to the framebuffer. Notice: For now, dynamic Attachment during rendering is not supported.

Parameters:

Name	Type	Attributes	Default	Description
`target`	TextureBase \| RenderBuffer			The texture or renderbuffer to attach.
`attachment`	ATTACHMENT	<optional>	ATTACHMENT.COLOR_ATTACHMENT0	The attachment point.

Returns:

Self for chaining.

Type:: OffscreenRenderTarget

detach(attachmentopt) → {OffscreenRenderTarget}

Detach a texture(RTT) or renderbuffer.

Parameters:

Name	Type	Attributes	Default	Description
`attachment`	ATTACHMENT	<optional>	ATTACHMENT.COLOR_ATTACHMENT0	The attachment point to detach.

Returns:

Self for chaining.

Type:: OffscreenRenderTarget

dispatchEvent(event)

Fire an event.

Parameters:

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

Overrides: RenderTargetBase#dispatchEvent

dispose(disposeAttachmentsopt)

Dispose the render target.

Parameters:

Name	Type	Attributes	Default	Description
`disposeAttachments`	boolean	<optional>	true	Whether to dispose attachments as well.

Overrides: RenderTargetBase#dispose

getAttachment(attachmentopt) → {TextureBase|RenderBuffer|null}

Get the attached attachment at the specified attachment point.

Parameters:

Name	Type	Attributes	Default	Description
`attachment`	ATTACHMENT	<optional>	ATTACHMENT.COLOR_ATTACHMENT0	The attachment point.

Returns:

The attached texture or renderbuffer.

Type:: TextureBase | RenderBuffer | null

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, depthopt)

Resize the render target to the specified dimensions. This will resize all attached attachments.

Parameters:

Name	Type	Attributes	Description
`width`	number		The new width of the render target.
`height`	number		The new height of the render target.
`depth`	number	<optional>	DEPRECATED: Depth parameter is no longer used. Individual textures manage their own depth dimensions.

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

(static) create2D(width, height) → {OffscreenRenderTarget}

Create a simple offscreen render target with a color texture and a depth-stencil renderbuffer.

Parameters:

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

Returns:

The created offscreen render target.

Type:: OffscreenRenderTarget

(static) create2DArray(width, height, depth) → {OffscreenRenderTarget}

Create a simple offscreen render target with a 2D array color texture. Note: No depth-stencil attachment is created by default.

Parameters:

Name	Type	Description
`width`	number	The width of the render target.
`height`	number	The height of the render target.
`depth`	number	The depth of the 2D array texture (number of layers).

Returns:

The created offscreen render target.

Type:: OffscreenRenderTarget

(static) create3D(width, height, depth) → {OffscreenRenderTarget}

Create a simple offscreen render target with a 3D color texture. Note: No depth-stencil attachment is created by default.

Parameters:

Name	Type	Description
`width`	number	The width of the render target.
`height`	number	The height of the render target.
`depth`	number	The depth of the 3D texture.

Returns:

The created offscreen render target.

Type:: OffscreenRenderTarget

(static) createCube(width, height) → {OffscreenRenderTarget}

Create a simple offscreen render target with a cube color texture and a depth-stencil renderbuffer.

Parameters:

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

Returns:

The created offscreen render target.

Type:: OffscreenRenderTarget