Provides methods used for setting the blend mode of a Game Object. Should be applied as a mixin and not used directly.
- Since: 3.0.0
- Source: src/gameobjects/components/BlendMode.js (Line 9)
Members
-
blendMode :Phaser.BlendModes|string
-
Sets the Blend Mode being used by this Game Object.
This can be a const, such as
Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)Under WebGL only the following Blend Modes are available:
- ADD
- MULTIPLY
- SCREEN
- ERASE
Canvas has more available depending on browser support.
You can also create your own custom Blend Modes in WebGL.
Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency of which blend modes are used.
Type:
- Phaser.BlendModes | string
- Since: 3.0.0
- Source: src/gameobjects/components/BlendMode.js (Line 30)
Methods
-
setBlendMode(value)
-
Sets the Blend Mode being used by this Game Object.
This can be a const, such as
Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)Under WebGL only the following Blend Modes are available:
- ADD
- MULTIPLY
- SCREEN
- ERASE (only works when rendering to a framebuffer, like a Render Texture)
Canvas has more available depending on browser support.
You can also create your own custom Blend Modes in WebGL.
Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency in which blend modes are used.
Parameters:
Name Type Description valuestring | Phaser.BlendModes The BlendMode value. Either a string or a CONST.
- Since: 3.0.0
- Source: src/gameobjects/components/BlendMode.js (Line 79)
Returns:
This Game Object instance.