Options
All
  • Public
  • Public/Protected
  • All
Menu

Class State

This is a WebGL state, and is is passed The WebGL StateManager.

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

Hierarchy

  • State

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns State

Properties

_blendMode

_blendMode: BLEND_MODES

_polygonOffset

_polygonOffset: number

data

data: number

Accessors

blend

  • get blend(): boolean
  • set blend(value: boolean): void

  • Activates blending of the computed fragment color values

    member

    {boolean}

    Returns boolean

  • Activates blending of the computed fragment color values

    Parameters

    • value: boolean

    Returns void

blendMode

  • 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.

    member

    {number}

    default

    PIXI.BLEND_MODES.NORMAL

    see

    PIXI.BLEND_MODES

    Returns 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.

    Parameters

    Returns void

clockwiseFrontFace

  • get clockwiseFrontFace(): boolean
  • set clockwiseFrontFace(value: boolean): void

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

    member

    {boolean}

    default

    false

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

culling

  • get culling(): boolean
  • set culling(value: boolean): void

  • Activates culling of polygons.

    member

    {boolean}

    default

    false

    Returns boolean

  • Activates culling of polygons.

    Parameters

    • value: boolean

    Returns void

depthMask

  • get depthMask(): boolean
  • set depthMask(value: boolean): void

  • Enables or disables writing to the depth buffer.

    member

    {boolean}

    default

    true

    Returns boolean

  • Enables or disables writing to the depth buffer.

    Parameters

    • value: boolean

    Returns void

depthTest

  • get depthTest(): boolean
  • set depthTest(value: boolean): void

  • Activates depth comparisons and updates to the depth buffer.

    member

    {boolean}

    default

    false

    Returns boolean

  • Activates depth comparisons and updates to the depth buffer.

    Parameters

    • value: boolean

    Returns void

offsets

  • get offsets(): boolean
  • set offsets(value: boolean): void

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

    member

    {boolean}

    default

    false

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

polygonOffset

  • get polygonOffset(): number
  • set polygonOffset(value: number): void

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

    member

    {number}

    default

    0

    Returns number

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

    Parameters

    • value: number

    Returns void

Methods

toString

  • toString(): string

  • Returns string

Static for2d

  • Returns State

Generated using TypeDoc