PixiJS

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)

Framebuffer.ts:50
Name Type Description
width number

Width of the frame buffer
height number

Height of the frame buffer

Members

colorTexture 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.

Default Value:
  • PIXI.MSAA_QUALITY.NONE
Example
 import { MSAA_QUALITY } from 'pixi.js';

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

width number

Width of framebuffer in pixels.

Methods

addColorTexture (index, texture) this

Framebuffer.ts:84

Add texture to the colorTexture array.

Name Type Attributes Default Description
index number 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

Framebuffer.ts:106

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

Framebuffer.ts:192

Destroys and removes the depth texture added to this framebuffer.

dispose () void

Framebuffer.ts:186

Disposes WebGL resources that are connected to this geometry.

enableDepth () this

Framebuffer.ts:129

Enable depth on the frame buffer.

Returns:
Type Description
this

enableStencil () this

Framebuffer.ts:140

Enable stencil on the frame buffer.

Returns:
Type Description
this

resize (width, height) void

Framebuffer.ts:151

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