Class: State

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:10

This is a WebGL state, and is is passed to GlStateSystem.

Each mesh rendered may require WebGL to be in a different state. For example you may want different blend mode or to enable polygon offsets

Advanced

Constructors

Constructor

> new State(): State

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:21

Returns

State

Properties

_blendModeId

> _blendModeId: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:18

Internal

data

> data: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:16

The data is a unique number based on the states settings. This lets us quickly compare states with a single number rather than looking at all the individual settings.

default2d

> static default2d: State

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:80

Accessors

blend

Get Signature

> get blend(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:26

Activates blending of the computed fragment color values.

Default

true

Returns

boolean

Set Signature

> set blend(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:27

Parameters

value

boolean

Returns

void

blendMode

Get Signature

> get blendMode(): BLEND_MODES

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:66

The blend mode to be applied when this state is set. Apply a value of normal to reset the blend mode. Setting this mode to anything other than NO_BLEND will automatically switch blending on.

Default

'normal'

Returns

BLEND_MODES

Set Signature

> set blendMode(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:67

Parameters

value

BLEND_MODES

Returns

void

clockwiseFrontFace

Get Signature

> get clockwiseFrontFace(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:59

Specifies whether or not front or back-facing polygons can be culled.

Default

false

Returns

boolean

Set Signature

> set clockwiseFrontFace(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:60

Parameters

value

boolean

Returns

void

culling

Get Signature

> get culling(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:41

Activates culling of polygons.

Default

false

Returns

boolean

Set Signature

> set culling(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:42

Parameters

value

boolean

Returns

void

cullMode

Get Signature

> get cullMode(): CULL_MODES

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:36

Returns

CULL_MODES

Set Signature

> set cullMode(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:35

The culling settings for this state none - No culling back - Back face culling front - Front face culling

Parameters

value

CULL_MODES

Returns

void

depthMask

Get Signature

> get depthMask(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:53

Enables or disables writing to the depth buffer.

Default

true

Returns

boolean

Set Signature

> set depthMask(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:54

Parameters

value

boolean

Returns

void

depthTest

Get Signature

> get depthTest(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:47

Activates depth comparisons and updates to the depth buffer.

Default

false

Returns

boolean

Set Signature

> set depthTest(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:48

Parameters

value

boolean

Returns

void

offsets

Get Signature

> get offsets(): boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:32

Activates adding an offset to depth values of polygon's fragments

Default

false

Returns

boolean

Set Signature

> set offsets(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:33

Parameters

value

boolean

Returns

void

polygonOffset

Get Signature

> get polygonOffset(): number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:72

The polygon offset. Setting this property to anything other than 0 will automatically enable polygon offset fill.

Default

0

Returns

number

Set Signature

> set polygonOffset(value): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:73

Parameters

value

number

Returns

void

Methods

toString()

> toString(): string

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:74

Returns

string

for2d()

> static for2d(): State

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/state/State.d.ts:79

A quickly getting an instance of a State that is configured for 2d rendering.

Returns

State

a new State with values set for 2d rendering