You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Namespace: BlendModes

Phaser. BlendModes

Phaser Blend Modes.

Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 7)

Members

<static, constant> ADD :number

Add blend mode. For Canvas and WebGL. Where both shapes overlap the color is determined by adding color values.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 37)

<static, constant> COLOR :number

Color blend mode. For Canvas only. Preserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 191)

<static, constant> COLOR_BURN :number

Color Burn blend mode. For Canvas only. Divides the inverted bottom layer by the top layer, and then inverts the result.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 114)

<static, constant> COLOR_DODGE :number

Color Dodge blend mode. For Canvas only. Divides the bottom layer by the inverted top layer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 103)

<static, constant> COPY :number

Copy blend mode. For Canvas only. Only the new shape is shown.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 311)

<static, constant> DARKEN :number

Darken blend mode. For Canvas only. Retains the darkest pixels of both layers.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 81)

<static, constant> DESTINATION_ATOP :number

Destination-out blend mode. For Canvas only. The existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 289)

<static, constant> DESTINATION_IN :number

Destination-in blend mode. For Canvas only. The existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 267)

<static, constant> DESTINATION_OUT :number

Destination-out blend mode. For Canvas only. The existing content is kept where it doesn't overlap the new shape.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 278)

<static, constant> DESTINATION_OVER :number

Destination-over blend mode. For Canvas only. New shapes are drawn behind the existing canvas content.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 256)

<static, constant> DIFFERENCE :number

Difference blend mode. For Canvas only. Subtracts the bottom layer from the top layer or the other way round to always get a positive value.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 147)

<static, constant> ERASE :number

Alpha erase blend mode. For Canvas and WebGL.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 213)

<static, constant> EXCLUSION :number

Exclusion blend mode. For Canvas only. Like difference, but with lower contrast.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 158)

<static, constant> HARD_LIGHT :number

Hard Light blend mode. For Canvas only. A combination of multiply and screen like overlay, but with top and bottom layer swapped.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 125)

<static, constant> HUE :number

Hue blend mode. For Canvas only. Preserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 169)

<static, constant> LIGHTEN :number

Lighten blend mode. For Canvas only. Retains the lightest pixels of both layers.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 92)

<static, constant> LIGHTER :number

Lighten blend mode. For Canvas only. Where both shapes overlap the color is determined by adding color values.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 300)

<static, constant> LUMINOSITY :number

Luminosity blend mode. For Canvas only. Preserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 202)

<static, constant> MULTIPLY :number

Multiply blend mode. For Canvas and WebGL. The pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 48)

<static, constant> NORMAL :number

Normal blend mode. For Canvas and WebGL. This is the default setting and draws new shapes on top of the existing canvas content.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 26)

<static, constant> OVERLAY :number

Overlay blend mode. For Canvas only. A combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 70)

<static, constant> SATURATION :number

Saturation blend mode. For Canvas only. Preserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 180)

<static, constant> SCREEN :number

Screen blend mode. For Canvas and WebGL. The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 59)

<static, constant> SKIP_CHECK :number

Skips the Blend Mode check in the renderer.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 16)

<static, constant> SOFT_LIGHT :number

Soft Light blend mode. For Canvas only. A softer version of hard-light. Pure black or white does not result in pure black or white.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 136)

<static, constant> SOURCE_ATOP :number

Source-out blend mode. For Canvas only. The new shape is only drawn where it overlaps the existing canvas content.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 245)

<static, constant> SOURCE_IN :number

Source-in blend mode. For Canvas only. The new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 223)

<static, constant> SOURCE_OUT :number

Source-out blend mode. For Canvas only. The new shape is drawn where it doesn't overlap the existing canvas content.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 234)

<static, constant> XOR :number

Xor blend mode. For Canvas only. Shapes are made transparent where both overlap and drawn normal everywhere else.

Type:
  • number
Since: 3.0.0
Source: src/renderer/BlendModes.js (Line 322)