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:95

Bind a framebuffer

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

clear (r, g, b, a)

FramebufferSystem.js:222

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

FramebufferSystem.js:43

Sets up the renderer context and necessary buffers.

destroy () inherited

System.js:40

Generic destroy methods to be overridden by the subclass

disposeAll (contextLost)

FramebufferSystem.js:420

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:385

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

FramebufferSystem.js:237

Initialize framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer

reset ()

FramebufferSystem.js:437

resets framebuffer stored state, binds screen framebuffer

should be called before renderTexture reset()

resizeFramebuffer (framebuffer) protected

FramebufferSystem.js:264

Resize the framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer

setViewport (x, y, width, height)

FramebufferSystem.js:182

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:295

Update the framebuffer

Name	Type	Description
framebuffer	PIXI.Framebuffer