PixiJS API Documentation

Class: RenderTarget

PIXI.RenderTarget

new PIXI.RenderTarget (gl, width, height, scaleMode, resolution, root)

Name	Type	Default	Description
`gl`	WebGLRenderingContext		The current WebGL drawing context
`width`	number	0	optional the horizontal range of the filter
`height`	number	0	optional the vertical range of the filter
`scaleMode`	number	PIXI.settings.SCALE_MODE	optional See PIXI.SCALE_MODES for possible values
`resolution`	number	1	optional The current resolution / device pixel ratio
`root`	boolean	false	optional Whether this object is the root element or not

Members

clearColor Array.<number>

The background colour of this render target, as an array of [r,g,b,a] values

defaultFrame glCore.GLBuffer

The stencil buffer stores masking data for the render target

filterData Array.<object>

Stores filter data for the render target

frame PIXI.Rectangle

The frame.

frameBuffer PIXI.glCore.GLFramebuffer

A frame buffer

gl WebGLRenderingContext

The current WebGL drawing context.

projectionMatrix PIXI.Matrix

The projection matrix

resolution number

The current resolution / device pixel ratio

Default Value:

root boolean

Whether this object is the root element or not

Default Value:

false

scaleMode number

The scale mode.

Default Value:

PIXI.settings.SCALE_MODE

See:

PIXI.SCALE_MODES

size PIXI.Rectangle

The size of the object as a rectangle

stencilBuffer glCore.GLBuffer

The stencil buffer stores masking data for the render target

stencilMaskStack Array.<PIXI.Graphics>

The data structure for the stencil masks

texture PIXI.glCore.GLTexture

The texture

transform PIXI.Matrix

The object's transform

Methods

activate () RenderTarget.js:223

Binds the buffers and initialises the viewport.

attachStencilBuffer () RenderTarget.js:194

Binds the stencil buffer.

calculateProjection (destinationFrame, sourceFrame) RenderTarget.js:269

Updates the projection matrix based on a projection frame (which is a rectangle)

Name	Type	Description
`destinationFrame`	Rectangle	The destination frame.
`sourceFrame`	Rectangle	The source frame.

clear (clearColor) RenderTarget.js:183

Clears the filter texture.

Name	Type	Default	Description
`clearColor`	Array.<number>	this.clearColor	optional Array of [r,g,b,a] to clear the framebuffer

destroy () RenderTarget.js:329

Destroys the render target.

resize (width, height) RenderTarget.js:302

Resizes the texture to the specified width and height

Name	Type	Description
`width`	number	the new width of the texture
`height`	number	the new height of the texture

setFrame (destinationFrame, sourceFrame) RenderTarget.js:213

Sets the frame of the render target.

Name	Type	Description
`destinationFrame`	Rectangle	The destination frame.
`sourceFrame`	Rectangle	The source frame.