Class State

This is a WebGL state, and is is passed to PIXI.StateSystem.

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

Memberof

PIXI

Index

Constructors

Properties

_blendMode _polygonOffset data

Accessors

blend blendMode clockwiseFrontFace culling depthMask depthTest offsets polygonOffset

Methods

Constructors

constructor

new State(): State
Returns State
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:13

Properties

_blendMode

_blendMode: BLEND_MODES

_polygonOffset

_polygonOffset: number

data

data: number

Accessors

blend

get blend(): boolean
Activates blending of the computed fragment color values.

Returns boolean
Default
```
true
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:18
set blend(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:19

blendMode

get blendMode(): BLEND_MODES
The blend mode to be applied when this state is set. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode. Setting this mode to anything other than NO_BLEND will automatically switch blending on.

Returns BLEND_MODES
Default
```
PIXI.BLEND_MODES.NORMAL
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:55
set blendMode(value: BLEND_MODES): void
Parameters
- value: BLEND_MODES
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:56

clockwiseFrontFace

get clockwiseFrontFace(): boolean
Specifies whether or not front or back-facing polygons can be culled.

Returns boolean
Default
```
false
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:48
set clockwiseFrontFace(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:49

culling

get culling(): boolean
Activates culling of polygons.

Returns boolean
Default
```
false
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:30
set culling(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:31

depthMask

get depthMask(): boolean
Enables or disables writing to the depth buffer.

Returns boolean
Default
```
true
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:42
set depthMask(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:43

depthTest

get depthTest(): boolean
Activates depth comparisons and updates to the depth buffer.

Returns boolean
Default
```
false
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:36
set depthTest(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:37

offsets

get offsets(): boolean
Activates adding an offset to depth values of polygon's fragments

Returns boolean
Default
```
false
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:24
set offsets(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:25

polygonOffset

get polygonOffset(): number
The polygon offset. Setting this property to anything other than 0 will automatically enable polygon offset fill.

Returns number
Default
```
0
```
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:61
set polygonOffset(value: number): void
Parameters
- value: number
Returns void
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:62

Methods

`Static`for2d

for2d(): State
Returns State
- Defined in node_modules/@pixi/core/lib/state/State.d.ts:63