Class BlendState

constructor

• new BlendState(
      blend?: boolean,
      colorOp?: number,
      colorSrcFactor?: number,
      colorDstFactor?: number,
      alphaOp?: number,
      alphaSrcFactor?: number,
      alphaDstFactor?: number,
      redWrite?: boolean,
      greenWrite?: boolean,
      blueWrite?: boolean,
      alphaWrite?: boolean,
  ): BlendState

• Create a new BlendState instance.

  All factor parameters can take the following values:

  • BLENDMODE_ZERO
  • BLENDMODE_ONE
  • BLENDMODE_SRC_COLOR
  • BLENDMODE_ONE_MINUS_SRC_COLOR
  • BLENDMODE_DST_COLOR
  • BLENDMODE_ONE_MINUS_DST_COLOR
  • BLENDMODE_SRC_ALPHA
  • BLENDMODE_SRC_ALPHA_SATURATE
  • BLENDMODE_ONE_MINUS_SRC_ALPHA
  • BLENDMODE_DST_ALPHA
  • BLENDMODE_ONE_MINUS_DST_ALPHA
  • BLENDMODE_CONSTANT
  • BLENDMODE_ONE_MINUS_CONSTANT

  All op parameters can take the following values:

  • BLENDEQUATION_ADD
  • BLENDEQUATION_SUBTRACT
  • BLENDEQUATION_REVERSE_SUBTRACT
  • BLENDEQUATION_MIN
  • BLENDEQUATION_MAX

  Note that MIN and MAX operations on WebGL platform require either EXT_blend_minmax or WebGL2 to work (check device.extBlendMinmax).

  Parameters

  • Optionalblend: boolean = false

    Enables or disables blending. Defaults to false.
  • OptionalcolorOp: number = BLENDEQUATION_ADD

    Configures color blending operation. Defaults to BLENDEQUATION_ADD.
  • OptionalcolorSrcFactor: number = BLENDMODE_ONE

    Configures source color blending factor. Defaults to BLENDMODE_ONE.
  • OptionalcolorDstFactor: number = BLENDMODE_ZERO

    Configures destination color blending factor. Defaults to BLENDMODE_ZERO.
  • OptionalalphaOp: number

    Configures alpha blending operation. Defaults to BLENDEQUATION_ADD.
  • OptionalalphaSrcFactor: number

    Configures source alpha blending factor. Defaults to BLENDMODE_ONE.
  • OptionalalphaDstFactor: number

    Configures destination alpha blending factor. Defaults to BLENDMODE_ZERO.
  • OptionalredWrite: boolean = true

    True to enable writing of the red channel and false otherwise. Defaults to true.
  • OptionalgreenWrite: boolean = true

    True to enable writing of the green channel and false otherwise. Defaults to true.
  • OptionalblueWrite: boolean = true

    True to enable writing of the blue channel and false otherwise. Defaults to true.
  • OptionalalphaWrite: boolean = true

    True to enable writing of the alpha channel and false otherwise. Defaults to true.

  Returns BlendState

Static ReadonlyADDBLEND

Static ReadonlyALPHABLEND

Static ReadonlyNOBLEND

Static ReadonlyNOWRITE

blend

• get blend(): boolean

• Gets whether blending is enabled.

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

• Sets whether blending is enabled.

  Parameters

  • value: boolean

  Returns void

clone

• clone(): BlendState

• Returns an identical copy of the specified blend state.

  Returns BlendState

  The result of the cloning.

copy

• copy(rhs: BlendState): BlendState

• Copies the contents of a source blend state to this blend state.

  Parameters

  • rhs: BlendState

    A blend state to copy from.

  Returns BlendState

  Self for chaining.

equals

• equals(rhs: BlendState): boolean

• Reports whether two BlendStates are equal.

  Parameters

  • rhs: BlendState

    The blend state to compare to.

  Returns boolean

  True if the blend states are equal and false otherwise.