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
  • BLENDMODE_SRC1_COLOR
  • BLENDMODE_ONE_MINUS_SRC1_COLOR
  • BLENDMODE_SRC1_ALPHA
  • BLENDMODE_ONE_MINUS_SRC1_ALPHA

  All op parameters can take the following values:

  • BLENDEQUATION_ADD
  • BLENDEQUATION_SUBTRACT
  • BLENDEQUATION_REVERSE_SUBTRACT
  • BLENDEQUATION_MIN
  • BLENDEQUATION_MAX

  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

hasAttachmentOverrides

• get hasAttachmentOverrides(): boolean

  Gets whether any color attachment has been given an independent blend state using BlendState#setAttachment.

  Returns boolean

clearAttachment

• clearAttachment(index: number): void

  Removes the independent blend state of the specified color attachment, making it follow attachment 0 again.

  Parameters

  • index: number

    The index of the color attachment, in 1 to 7 range.

  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.

getAttachment

• getAttachment(index: number, dst: BlendState): BlendState

  Stores the blend state of the specified color attachment in the supplied blend state. When the attachment does not have an independent blend state, the state of attachment 0 is stored.

  Parameters

  • index: number

    The index of the color attachment, in 0 to 7 range.

  • dst: BlendState

    The blend state to store the result in. This avoids allocations, as a single instance can be reused.

  Returns BlendState

  The supplied dst, for chaining.

setAttachment

• setAttachment(index: number, src: BlendState | null): void

  Assigns an independent blend state to the specified color attachment. The blend state of the supplied source is copied, and so subsequent changes to either the source or to attachment 0 do not affect it. An attachment which has not been assigned an independent state instead follows attachment 0.

  Note that this requires GraphicsDevice#supportsIndependentBlending - on devices without support, the state of attachment 0 is used for all attachments.

  Parameters

  • index: number

    The index of the color attachment, in 1 to 7 range. Attachment 0 is configured using the other functions and properties of this class.

  • src: BlendState | null

    The blend state to copy from, or null to make the attachment follow attachment 0 again.

  Returns void

  Example

  // attachment 1 keeps the blending of attachment 0, but does not write any channels
  const state = material.blendState.clone();
  const noWrite = state.clone();
  noWrite.setColorWrite(false, false, false, false);
  state.setAttachment(1, noWrite);
  Copy