Class: FramebufferSystem

PIXI.systems.FramebufferSystem

System plugin to the renderer to manage framebuffers.

new PIXI.systems.FramebufferSystem (renderer)

Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Extends

Members

managedFramebuffers Array.<PIXI.Framebuffer> readonly

A list of managed framebuffers

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)

Bind a framebuffer

Name Type Description
framebuffer PIXI.Framebuffer
frame PIXI.Rectangle optional

frame, default is framebuffer size

clear (r, g, b, a)

Clear the color of the context

Name Type 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

contextChange ()

Sets up the renderer context and necessary buffers.

destroy () inherited

Generic destroy methods to be overridden by the subclass

disposeAll (contextLost)

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)

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

Initialize framebuffer

Name Type Description
framebuffer PIXI.Framebuffer

resets framebuffer stored state, binds screen framebuffer

should be called before renderTexture reset()

resizeFramebuffer (framebuffer) protected

Resize the framebuffer

Name Type Description
framebuffer PIXI.Framebuffer

setViewport (x, y, width, height)

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

Update the framebuffer

Name Type Description
framebuffer PIXI.Framebuffer