Class: Framebuffer

PIXI.Framebuffer

A framebuffer can be used to render contents off of the screen. PIXI.BaseRenderTexture uses one internally to render into itself. You can attach a depth or stencil buffer to a framebuffer.

On WebGL 2 machines, shaders can output to multiple textures simultaneously with GLSL 300 ES.

new PIXI.Framebuffer (width, height)

Name Type Description
width number

Width of the frame buffer

height number

Height of the frame buffer

Members

colorTexture Array<PIXI.BaseTexture>

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) this

Add texture to the colorTexture array

Name Type Attributes Default Description
index number <optional>
0

Index of the array to add the texture to

texture PIXI.BaseTexture <optional>

Texture to add to the array

Returns:
Type Description
this

addDepthTexture (texture) this

Add a depth texture to the frame buffer

Name Type Attributes Description
texture PIXI.BaseTexture <optional>

Texture to add

Returns:
Type Description
this

destroyDepthTexture () void

Destroys and removes the depth texture added to this framebuffer.

dispose () void

Disposes WebGL resources that are connected to this geometry

enableDepth () this

Enable depth on the frame buffer

Returns:
Type Description
this

enableStencil () this

Enable stencil on the frame buffer

Returns:
Type Description
this

resize (width, height) void

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