Class: Framebuffer

PIXI.Framebuffer

Frame buffer used by the BaseRenderTexture

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

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)

Add a depth texture to the frame buffer

Name Type Description
texture PIXI.BaseTexture optional

Texture to add

destroyDepthTexture ()

Destroys and removes the depth texture added to this framebuffer.

dispose ()

Disposes WebGL resources that are connected to this geometry

enableDepth ()

Enable depth on the frame buffer

enableStencil ()

Enable stencil on the frame buffer

resize (width, height)

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