Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Renderer . WebGL . RenderTarget

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Renderer . WebGL . RenderTarget

A Render Target encapsulates a WebGL framebuffer and the WebGL Texture that displays it.

Instances of this class are typically created by, and belong to WebGL Pipelines, however other Game Objects and classes can take advantage of Render Targets as well.

Constructor:

new RenderTarget(renderer, width, height, [scale], [minFilter], [autoClear], [autoResize])

Parameters:

name type arguments Default description
renderer Phaser.Renderer.WebGL.WebGLRenderer

A reference to the WebGLRenderer.

width number

The width of this Render Target.

height number

The height of this Render Target.

scale number <optional> 1

A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.

minFilter number <optional> 0

The minFilter mode of the texture when created. 0 is LINEAR, 1 is NEAREST.

autoClear boolean <optional> true

Automatically clear this framebuffer when bound?

autoResize boolean <optional> false

Automatically resize this Render Target if the WebGL Renderer resizes?

Since: 3.50.0

Members

autoClear: boolean
Focus
Focus

Description:

Controls if this Render Target is automatically cleared (via gl.COLOR_BUFFER_BIT) during the RenderTarget.bind method.

If you need more control over how, or if, the target is cleared, you can disable this via the config on creation, or even toggle it directly at runtime.

Type:
boolean
Since: 3.50.0
Focus
Focus
<readonly> autoResize: boolean
Focus
Focus

Description:

Does this Render Target automatically resize when the WebGL Renderer does?

Modify this property via the setAutoResize method.

Type:
boolean
Since: 3.50.0
Focus
Focus
destroy:
Focus
Focus

Description:

Removes all external references from this class and deletes the WebGL framebuffer and texture instances.

Does not remove this Render Target from the parent pipeline.

Since: 3.50.0
Focus
Focus
framebuffer: WebGLFramebuffer
Focus
Focus

Description:

The WebGLFramebuffer of this Render Target.

This is created in the RenderTarget.resize method.

Type:
WebGLFramebuffer
Since: 3.50.0
Focus
Focus
<readonly> height: number
Focus
Focus

Description:

The height of the texture.

Type:
number
Since: 3.50.0
Focus
Focus
minFilter: number
Focus
Focus

Description:

The minFilter mode of the texture. 0 is LINEAR, 1 is NEAREST.

Type:
number
Since: 3.50.0
Focus
Focus

Description:

A reference to the WebGLRenderer instance.

Type:
Since: 3.50.0
Focus
Focus
scale: number
Focus
Focus

Description:

A value between 0 and 1. Controls the size of this Render Target in relation to the Renderer.

A value of 1 matches it. 0.5 makes the Render Target half the size of the renderer, etc.

Type:
number
Since: 3.50.0
Focus
Focus
texture: WebGLTexture
Focus
Focus

Description:

The WebGLTexture of this Render Target.

This is created in the RenderTarget.resize method.

Type:
WebGLTexture
Since: 3.50.0
Focus
Focus
unbind:
Focus
Focus

Description:

Unbinds this Render Target and optionally flushes the WebGL Renderer first.

Since: 3.50.0
Focus
Focus
<readonly> width: number
Focus
Focus

Description:

The width of the texture.

Type:
number
Since: 3.50.0
Focus
Focus

Methods

adjustViewport()
Focus
Focus

Description:

Adjusts the GL viewport to match the width and height of this Render Target.

Also disables SCISSOR_TEST.

Examples:
Since: 3.50.0
Focus
Focus
bind([adjustViewport], [width], [height])
Focus
Focus

Description:

Pushes this Render Target as the current frame buffer of the renderer.

If autoClear is set, then clears the texture.

If adjustViewport is true then it will flush the renderer and then adjust the GL viewport.

Parameters:

name type arguments Default description
adjustViewport boolean <optional> false

Adjust the GL viewport by calling RenderTarget.adjustViewport ?

width number <optional>

Optional new width of this Render Target.

height number <optional>

Optional new height of this Render Target.

Examples:
Since: 3.50.0
Focus
Focus
clear()
Focus
Focus

Description:

Clears this Render Target.

Examples:
Since: 3.50.0
Focus
Focus
resize(width, height)
Focus
Focus

Description:

Resizes this Render Target.

Deletes both the frame buffer and texture, if they exist and then re-creates them using the new sizes.

This method is called automatically by the pipeline during its resize handler.

Parameters:

name type description
width number

The new width of this Render Target.

height number

The new height of this Render Target.

Returns:
Description:

This RenderTarget instance.

Examples:
Since: 3.50.0
Focus
Focus
setAutoResize(autoResize)
Focus
Focus

Description:

Sets if this Render Target should automatically resize when the WebGL Renderer emits a resize event.

Parameters:

name type description
autoResize boolean

Automatically resize this Render Target when the WebGL Renderer resizes?

Returns:
Description:

This RenderTarget instance.

Examples:
Since: 3.50.0
Focus
Focus