Class: Framebuffer

Members

colorTexture Array.<PIXI.BaseTexture> readonly

Reference to the colorTexture.

height number

Height of framebuffer in pixels

multisample PIXI.MSAA_QUALITY

Desired number of samples for antialiasing. 0 means AA should not be used.

Experimental WebGL2 feature, allows to use antialiasing in individual renderTextures. Antialiasing is the same as for main buffer with renderer antialias:true options. Seriously affects GPU memory consumption and GPU performance.

renderTexture.framebuffer.multisample = PIXI.MSAA_QUALITY.HIGH;
//...
renderer.render(renderTexture, myContainer);
renderer.framebuffer.blit(); // copies data from MSAA framebuffer to texture

Default Value:

• PIXI.MSAA_QUALITY.NONE

width number

Width of framebuffer in pixels

Methods

addColorTexture (index, texture)

Framebuffer.js:72

Add texture to the colorTexture array

Name	Type	Default	Description
index	number	0	optional Index of the array to add the texture to
texture	PIXI.BaseTexture		optional Texture to add to the array

addDepthTexture (texture)

Framebuffer.js:90

Add a depth texture to the frame buffer

Name	Type	Description
texture	PIXI.BaseTexture	optional Texture to add

destroyDepthTexture ()

Framebuffer.js:158

Destroys and removes the depth texture added to this framebuffer.

dispose ()

Framebuffer.js:152

Disposes WebGL resources that are connected to this geometry

enableDepth ()

Framebuffer.js:108

Enable depth on the frame buffer

enableStencil ()

Framebuffer.js:117

Enable stencil on the frame buffer

resize (width, height)

Framebuffer.js:129

Resize the frame buffer

Name	Type	Description
width	number	Width of the frame buffer to resize to
height	number	Height of the frame buffer to resize to