PixiJS API Documentation

Class: StateSystem

PIXI.StateSystem

System plugin to the renderer to manage WebGL state machines.

new PIXI.StateSystem (renderer) overrides

Name	Type	Description
`renderer`	PIXI.Renderer	The renderer this System works for.

Extends

PIXI.System

Members

blendMode number readonly

Blend mode

Default Value:

PIXI.BLEND_MODES.NONE

checks Array<Function> readonly

Collection of check calls

defaultState PIXI.State readonly

Default WebGL State

gl WebGLRenderingContext readonly

GL context

map Array<Function> readonly

Collection of calls

polygonOffset number readonly

Polygon offset

stateId number readonly

State ID

_blendEq boolean protected

Whether current blend equation is different

Methods

forceState (state) void

StateSystem.ts:159

Sets the state, when previous state is unknown

Name	Type	Description
`state`	unknown	The state to set

reset () void

StateSystem.ts:292

Resets all the logic and disables the vaos

set (state) void

StateSystem.ts:119

Sets the current state

Name	Type	Description
`state`	unknown	The state to set.

setBlend (value) void

StateSystem.ts:179

Enables or disabled blending.

Name	Type	Description
`value`	boolean	Turn on or off webgl blending.

setBlendMode (value) void

StateSystem.ts:243

Sets the blend mode.

Name	Type	Description
`value`	number	The blend mode to set to.

setCullFace (value) void

StateSystem.ts:223

Sets whether to enable or disable cull face.

Name	Type	Description
`value`	boolean	Turn on or off webgl cull face.

setDepthMask (value) void

StateSystem.ts:213

Sets whether to enable or disable depth mask.

Name	Type	Description
`value`	boolean	Turn on or off webgl depth mask.

setDepthTest (value) void

StateSystem.ts:203

Sets whether to enable or disable depth test.

Name	Type	Description
`value`	boolean	Turn on or off webgl depth testing.

setFrontFace (value) void

StateSystem.ts:233

Sets the gl front face.

Name	Type	Description
`value`	boolean	true is clockwise and false is counter-clockwise

setOffset (value) void

StateSystem.ts:191

Enables or disable polygon offset fill

Name	Type	Description
`value`	boolean	Turn on or off webgl polygon offset testing.

setPolygonOffset (value, scale) void

StateSystem.ts:280

Sets the polygon offset.

Name	Type	Description
`value`	number	the polygon offset
`scale`	number	the polygon offset scale

updateCheck (func, value) void

StateSystem.ts:306

checks to see which updates should be checked based on which settings have been activated. For example, if blend is enabled then we should check the blend modes each time the state is changed or if polygon fill is activated then we need to check if the polygon offset changes. The idea is that we only check what we have too.

Name	Type	Description
`func`	Function	the checking function to add or remove
`value`	boolean	should the check function be added or removed.

Inherited Properties

From class PIXI.System

renderer PIXI.Renderer inherited

The renderer this manager works for.

Inherited Methods

From class PIXI.System

destroy () void inherited

System.ts:29

Generic destroy methods to be overridden by the subclass