PixiJS

Class: GlContextSystem

GlContextSystem

System plugin to the renderer to manage the context

new GlContextSystem (renderer)

ts:183
Name Type Description
renderer WebGLRenderer

The renderer this System works for.

Implements

Members

defaultOptions ContextSystemOptions static

The default options for the system.

Properties:
Name Type Default Description
context null

WebGLOptions.context
multiView boolean false

WebGLOptions.multiView
powerPreference default

WebGLOptions.powerPreference
preferWebGLVersion number 2

WebGLOptions.webGLVersion
premultipliedAlpha boolean true

WebGLOptions.premultipliedAlpha
preserveDrawingBuffer boolean false

WebGLOptions.preserveDrawingBuffer

canvas ICanvas readonly

The canvas that the WebGL Context is rendering to. This will be the view canvas. But if multiView is enabled, this canvas will not be attached to the DOM. It will be rendered to and then copied to the target canvas.

extensions object readonly

Extensions available.

Properties:
Name Type Description
anisotropicFiltering EXT_texture_filter_anisotropic

WebGL v1 and v2 extension
depthTexture WEBGL_depth_texture

WebGL v1 extension
drawBuffers WEBGL_draw_buffers

WebGL v1 extension
floatTexture OES_texture_float

WebGL v1 extension
loseContext WEBGL_lose_context

WebGL v1 extension
vertexArrayObject OES_vertex_array_object

WebGL v1 extension

isLost boolean readonly

true if the context is lost

multiView boolean

Whether to enable multi-view rendering. Set to true when rendering to multiple canvases on the dom.

Default Value:
  • false

supports object readonly

Features supported by current renderer.

Properties:
Name Type Default Description
msaa boolean true

Support for MSAA (antialiasing of dynamic textures)
nonPowOf2mipmaps boolean true

Support for mipmaps if a texture is non-power of two
nonPowOf2wrapping boolean true

Support for wrapping modes if a texture is non-power of two
srgbTextures boolean true

Support for SRGB texture format
uint32Indices boolean true

Support for 32-bit indices buffer.
uniformBufferObject boolean true

Support for UniformBufferObjects
vertexArrayObject boolean true

Support for VertexArrayObjects

Methods

forceContextLoss () void

ts:443

this function can be called to force a webGL context loss this will release all resources on the GPU. Useful if you need to put Pixi to sleep, and save some GPU memory

As soon as render is called - all resources will be created again.

contextChange (gl) void protected

ts:204

Handles the context change event.

Name Type Description
gl WebGLRenderingContext

New WebGL context.

createContext (preferWebGLVersion, options) void protected

ts:306

Initialize from context options

Name Type Description
preferWebGLVersion 1 | 2
options object

context attributes
See:

getExtensions () void protected

ts:340

Auto-populate the extensions.

handleContextLost (event) void protected

ts:399

Handles a lost webgl context

Name Type Description
event WebGLContextEvent

The context lost event.

handleContextRestored () void protected

ts:422

Handles a restored webgl context.

initFromContext (gl) void protected

ts:283

Initializes the context.

Name Type Description
gl WebGLRenderingContext

WebGL context

validateContext (gl) void protected

ts:455

Validate context.

Name Type Description
gl WebGLRenderingContext

Render context.