Class: GlStateSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:13

System plugin to the renderer to manage WebGL state machines

Advanced

Implements

• System

Constructors

Constructor

> new GlStateSystem(renderer): GlStateSystem

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:69

Parameters

renderer

WebGLRenderer

Returns

GlStateSystem

Properties

_blendEq

> protected _blendEq: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:36

Whether current blend equation is different

blendMode

> readonly blendMode: BLEND_MODES

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:34

Blend mode

Default

'none'
@readonly

blendModesMap

> protected blendModesMap: Record<BLEND_MODES, number[]>

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:43

checks

> protected readonly checks: (system, state) => void[]

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:53

Collection of check calls

Parameters

system

this

state

State

Returns

void

defaultState

> protected readonly defaultState: State

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:58

Default WebGL State

gl

> protected readonly gl: WebGL2RenderingContext

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:42

GL context

map

> protected readonly map: (value) => void[]

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:48

Collection of calls

Parameters

value

boolean

Returns

void

polygonOffset

> readonly polygonOffset: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:28

Polygon offset

stateId

> readonly stateId: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:23

State ID

Methods

contextChange()

> protected contextChange(gl): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:71

Parameters

gl

WebGL2RenderingContext

Returns

void

forceState()

> forceState(state): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:81

Sets the state, when previous state is unknown.

Parameters

state

State

The state to set

Returns

void

onRenderTargetChange()

> protected onRenderTargetChange(renderTarget): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:70

Parameters

renderTarget

RenderTarget

Returns

void

resetState()

> resetState(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:124

Resets all the logic and disables the VAOs.

Returns

void

set()

> set(state): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:76

Sets the current state

Parameters

state

State

The state to set.

Returns

void

setBlend()

> setBlend(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:86

Sets whether to enable or disable blending.

Parameters

value

boolean

Turn on or off WebGl blending.

Returns

void

setBlendMode()

> setBlendMode(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:116

Sets the blend mode.

Parameters

value

BLEND_MODES

The blend mode to set to.

Returns

void

setCullFace()

> setCullFace(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:106

Sets whether to enable or disable cull face.

Parameters

value

boolean

Turn on or off webgl cull face.

Returns

void

setDepthMask()

> setDepthMask(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:101

Sets whether to enable or disable depth mask.

Parameters

value

boolean

Turn on or off webgl depth mask.

Returns

void

setDepthTest()

> setDepthTest(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:96

Sets whether to enable or disable depth test.

Parameters

value

boolean

Turn on or off webgl depth testing.

Returns

void

setFrontFace()

> setFrontFace(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:111

Sets the gl front face.

Parameters

value

boolean

true is clockwise and false is counter-clockwise

Returns

void

setOffset()

> setOffset(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:91

Sets whether to enable or disable polygon offset fill.

Parameters

value

boolean

Turn on or off webgl polygon offset testing.

Returns

void

setPolygonOffset()

> setPolygonOffset(value, scale): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/gl/state/GlStateSystem.d.ts:122

Sets the polygon offset.

Parameters

value

number

the polygon offset

scale

number

the polygon offset scale

Returns

void