Class: StateSystem

PIXI.StateSystem

System plugin to the renderer to manage WebGL state machines.

Implements

Members

blendMode PIXI.BLEND_MODES readonly

Blend mode

Default Value:
  • PIXI.BLEND_MODES.NONE

polygonOffset number readonly

Polygon offset

stateId number readonly

State ID

_blendEq boolean protected

Whether current blend equation is different

checks Array<Function> protectedreadonly

Collection of check calls

defaultState PIXI.State protectedreadonly

Default WebGL State

gl WebGLRenderingContext protectedreadonly

GL context

map Array<Function> protectedreadonly

Collection of calls

Methods

forceState (state) void

Sets the state, when previous state is unknown.

Name Type Description
state unknown

The state to set

reset () void

Resets all the logic and disables the VAOs.

set (state) void

Sets the current state

Name Type Description
state unknown

The state to set.

setBlend (value) void

Sets whether to enable or disable blending.

Name Type Description
value boolean

Turn on or off WebGl blending.

setBlendMode (value) void

Sets the blend mode.

Name Type Description
value number

The blend mode to set to.

setCullFace (value) void

Sets whether to enable or disable cull face.

Name Type Description
value boolean

Turn on or off webgl cull face.

setDepthMask (value) void

Sets whether to enable or disable depth mask.

Name Type Description
value boolean

Turn on or off webgl depth mask.

setDepthTest (value) void

Sets whether to enable or disable depth test.

Name Type Description
value boolean

Turn on or off webgl depth testing.

setFrontFace (value) void

Sets the gl front face.

Name Type Description
value boolean

true is clockwise and false is counter-clockwise

setOffset (value) void

Sets whether to enable or disable polygon offset fill.

Name Type Description
value boolean

Turn on or off webgl polygon offset testing.

setPolygonOffset (value, scale) void

Sets the polygon offset.

Name Type Description
value number

the polygon offset

scale number

the polygon offset scale

updateCheck (func, value) void

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 (system: this, state: PIXI.State) => void

the checking function to add or remove

value boolean

should the check function be added or removed.