Class: FramebufferSystem

Extends

• PIXI.System

Members

managedFramebuffers Array.<PIXI.Framebuffer> readonly

A list of managed framebuffers

renderer PIXI.Renderer inherited

The renderer this manager works for.

size object readonly

Get the size of the current width and height. Returns object with width and height values.

unknownFramebuffer Framebuffer readonly

Framebuffer value that shows that we don't know what is bound

Methods

bind (framebuffer, frame)

FramebufferSystem.js:82

Bind a framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer
frame	PIXI.Rectangle	optional frame, default is framebuffer size

blit (framebuffer, sourcePixels, destPixels)

FramebufferSystem.js:303

Only works with WebGL2

blits framebuffer to another of the same or bigger size after that target framebuffer is bound

Fails with WebGL warning if blits multisample framebuffer to different size

Name	Type	Description
framebuffer	PIXI.Framebuffer	optional by default it blits "into itself", from renderBuffer to texture.
sourcePixels	PIXI.Rectangle	optional source rectangle in pixels
destPixels	PIXI.Rectangle	optional dest rectangle in pixels, assumed to be the same as sourcePixels

clear (r, g, b, a, mask)

FramebufferSystem.js:172

Clear the color of the context

Name	Type	Default	Description
r	Number		Red value from 0 to 1
g	Number		Green value from 0 to 1
b	Number		Blue value from 0 to 1
a	Number		Alpha value from 0 to 1
mask	PIXI.BUFFER_BITS	BUFFER_BITS.COLOR | BUFFER_BITS.DEPTH	optional Bitwise OR of masks that indicate the buffers to be cleared, by default COLOR and DEPTH buffers.

contextChange ()

FramebufferSystem.js:40

Sets up the renderer context and necessary buffers.

destroy () inherited

System.js:25

Generic destroy methods to be overridden by the subclass

detectSamples (samples)PIXI.MSAA_QUALITY

FramebufferSystem.js:274

Detects number of samples that is not more than a param but as close to it as possible

Name	Type	Description
samples	PIXI.MSAA_QUALITY	number of samples

Returns:

Type	Description
PIXI.MSAA_QUALITY	recommended number of samples

disposeAll (contextLost)

FramebufferSystem.js:368

Disposes all framebuffers, but not textures bound to them

Name	Type	Default	Description
contextLost	boolean	false	optional If context was lost, we suppress all delete function calls

disposeFramebuffer (framebuffer, contextLost)

FramebufferSystem.js:345

Disposes framebuffer

Name	Type	Default	Description
framebuffer	PIXI.Framebuffer		framebuffer that has to be disposed of
contextLost	boolean	false	optional If context was lost, we suppress all delete function calls

initFramebuffer (framebuffer)PIXI.GLFramebuffer protected

FramebufferSystem.js:185

Initialize framebuffer for this context

Name	Type	Description
framebuffer	PIXI.Framebuffer

Returns:

Type	Description
PIXI.GLFramebuffer	created GLFramebuffer

reset ()

FramebufferSystem.js:407

resets framebuffer stored state, binds screen framebuffer

should be called before renderTexture reset()

resizeFramebuffer (framebuffer) protected

FramebufferSystem.js:200

Resize the framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer

setViewport (x, y, width, height)

FramebufferSystem.js:139

Set the WebGLRenderingContext's viewport.

Name	Type	Description
x	Number	X position of viewport
y	Number	Y position of viewport
width	Number	Width of viewport
height	Number	Height of viewport

updateFramebuffer (framebuffer) protected

FramebufferSystem.js:221

Update the framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer