Class: GlContextSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:67

System plugin to the renderer to manage the context

Advanced

Implements

• System<ContextSystemOptions>

Constructors

Constructor

> new GlContextSystem(renderer): GlContextSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:127

Parameters

renderer

WebGLRenderer

The renderer this System works for.

Returns

GlContextSystem

Properties

canvas

> readonly canvas: ICanvas

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:123

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.

CONTEXT_UID

> protected CONTEXT_UID: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:75

extensions

> readonly extensions: WebGLExtensions

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:109

Extensions available.

gl

> protected gl: WebGL2RenderingContext

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:76

multiView

> multiView: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:116

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

Default

false

supports

> readonly supports: object

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:82

Features supported by current renderer.

msaa

> msaa: boolean

Support for MSAA (antialiasing of dynamic textures)

nonPowOf2mipmaps

> nonPowOf2mipmaps: boolean

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

nonPowOf2wrapping

> nonPowOf2wrapping: boolean

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

srgbTextures

> srgbTextures: boolean

Support for SRGB texture format

uint32Indices

> uint32Indices: boolean

Support for 32-bit indices buffer.

uniformBufferObject

> uniformBufferObject: boolean

Support for UniformBufferObjects

vertexArrayObject

> vertexArrayObject: boolean

Support for VertexArrayObjects

webGLVersion

> webGLVersion: 1 | 2

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:110

defaultOptions

> static defaultOptions: ContextSystemOptions

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:74

The default options for the system.

Accessors

isLost

Get Signature

> get isLost(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:132

true if the context is lost

Returns

boolean

Methods

contextChange()

> protected contextChange(gl): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:137

Handles the context change event.

Parameters

gl

WebGL2RenderingContext

New WebGL context.

Returns

void

createContext()

> protected createContext(preferWebGLVersion, options): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:153

Initialize from context options

Parameters

preferWebGLVersion

1 | 2

options

WebGLContextAttributes

context attributes

Returns

void

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:163

Generic destroy methods to be overridden by the subclass

Returns

void

Implementation of

System.destroy

ensureCanvasSize()

> ensureCanvasSize(targetCanvas): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:139

Parameters

targetCanvas

ICanvas

Returns

void

forceContextLoss()

> forceContextLoss(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:171

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.

Returns

void

getExtensions()

> protected getExtensions(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:155

Auto-populate the extensions.

Returns

void

handleContextLost()

> protected handleContextLost(event): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:160

Handles a lost webgl context

Parameters

event

WebGLContextEvent

The context lost event.

Returns

void

handleContextRestored()

> protected handleContextRestored(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:162

Handles a restored webgl context.

Returns

void

init()

> init(options): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:138

Parameters

options

ContextSystemOptions

Returns

void

Implementation of

System.init

initFromContext()

> protected initFromContext(gl): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:145

Initializes the context.

Parameters

gl

WebGL2RenderingContext

WebGL context

Returns

void

validateContext()

> protected validateContext(gl): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/context/GlContextSystem.d.ts:176

Validate context.

Parameters

gl

WebGL2RenderingContext

Render context.

Returns

void