Class ContextSystem

System plugin to the renderer to manage the context.

Memberof

PIXI

Implements

ISystem<ContextSystemOptions>

Index

Constructors

constructor

new ContextSystem(renderer: Renderer): ContextSystem
Parameters
- renderer: Renderer
  The renderer this System works for.
Returns ContextSystem
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:104

Properties

`Protected`CONTEXT_UID

CONTEXT_UID: number

`Readonly`extensions

extensions: WebGLExtensions

Extensions available.

`Protected`gl

gl: IRenderingContext

powerPreference

powerPreference: WebGLPowerPreference

preserveDrawingBuffer

preserveDrawingBuffer: boolean

`Readonly`supports

supports: ISupportDict

Features supported by current context.

useContextAlpha

useContextAlpha: boolean | "notMultiplied"

Pass-thru setting for the canvas' context alpha property. This is typically not something you need to fiddle with. If you want transparency, use backgroundAlpha.

Member

Deprecated

since 7.0.0

`Readonly`webGLVersion

webGLVersion: number

Either 1 or 2 to reflect the WebGL version being used.

Accessors

isLost

get isLost(): boolean
true if the context is lost

Returns boolean
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:109

Methods

`Protected`contextChange

contextChange(gl: IRenderingContext): void
Handles the context change event.
Parameters
- gl: IRenderingContext
  New WebGL context.
Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:114

createContext

createContext(
canvas: ICanvas,
options: WebGLContextAttributes,
): IRenderingContext
Helper class to create a WebGL Context
Parameters
- canvas: ICanvas
  the canvas element that we will get the context from
- options: WebGLContextAttributes
  An options object that gets passed in to the canvas element containing the context attributes
Returns IRenderingContext
the WebGL context

See
https://developer.mozilla.org/en/docs/Web/API/HTMLCanvasElement/getContext
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:137

destroy

destroy(): void
Generic destroy methods to be overridden by the subclass

Returns void
Implementation of ISystem.destroy
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:147

`Protected`getExtensions

getExtensions(): void
Auto-populate the PIXI.ContextSystem.extensions extensions.

Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:139

`Protected`handleContextLost

handleContextLost(event: WebGLContextEvent): void
Handles a lost webgl context
Parameters
- event: WebGLContextEvent
  The context lost event.
Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:144

`Protected`handleContextRestored

handleContextRestored(): void
Handles a restored webgl context.

Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:146

init

init(options: ContextSystemOptions): void
Parameters
- options: ContextSystemOptions
Returns void
Implementation of ISystem.init
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:115

`Protected`initFromContext

initFromContext(gl: IRenderingContext): void
Protected
Initializes the context.
Parameters
- gl: IRenderingContext
  WebGL context
Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:121

`Protected`initFromOptions

initFromOptions(options: WebGLContextAttributes): void
Protected
Initialize from context options
Parameters
- options: WebGLContextAttributes
  context attributes
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:128

`Protected`postrender

postrender(): void
Handle the post-render runner event.

Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:149

`Protected`validateContext

validateContext(gl: IRenderingContext): void
Validate context.
Parameters
- gl: IRenderingContext
  Render context.
Returns void
- Defined in node_modules/@pixi/core/lib/context/ContextSystem.d.ts:154

Class ContextSystem

Memberof

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContextSystem

Properties

ProtectedCONTEXT_UID

Readonlyextensions

Protectedgl

powerPreference

preserveDrawingBuffer

Readonlysupports

useContextAlpha

Member

Deprecated

ReadonlywebGLVersion

Accessors

isLost

Returns boolean

Methods

ProtectedcontextChange

Parameters

Returns void

createContext

Parameters

Returns IRenderingContext

See

destroy

Returns void

ProtectedgetExtensions

Returns void

ProtectedhandleContextLost

Parameters

Returns void

ProtectedhandleContextRestored

Returns void

init

Parameters

Returns void

ProtectedinitFromContext

Parameters

Returns void

ProtectedinitFromOptions

Parameters

Returns void

See

Protectedpostrender

Returns void

ProtectedvalidateContext

Parameters

Returns void

Settings

On This Page

`Protected`CONTEXT_UID

`Readonly`extensions

`Protected`gl

`Readonly`supports

`Readonly`webGLVersion

`Protected`contextChange

`Protected`getExtensions

`Protected`handleContextLost

`Protected`handleContextRestored

`Protected`initFromContext

`Protected`initFromOptions

`Protected`postrender

`Protected`validateContext