MCPcopy
hub / github.com/phaserjs/phaser / BlendMode

Interface BlendMode

types/phaser.d.ts:18129–18178  ·  view source on GitHub ↗

* Provides methods used for setting the blend mode of a Game Object. * Blend modes control how a Game Object is composited onto the display when rendered. * They determine how the pixels of the object are blended with the pixels already on screen, * enabling ef

Source from the content-addressed store, hash-verified

18127 * and the `setBlendMode` method.
18128 */
18129 interface BlendMode {
18130 /**
18131 * Sets the Blend Mode being used by this Game Object.
18132 *
18133 * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)
18134 *
18135 * Under WebGL only the following Blend Modes are available:
18136 *
18137 * * NORMAL
18138 * * ADD
18139 * * MULTIPLY
18140 * * SCREEN
18141 * * ERASE
18142 *
18143 * Canvas has more available depending on browser support.
18144 *
18145 * You can also create your own custom Blend Modes in WebGL.
18146 *
18147 * Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
18148 * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
18149 * reasons try to be careful about the construction of your Scene and the frequency with which blend modes
18150 * are used.
18151 */
18152 blendMode: Phaser.BlendModes | string | number;
18153 /**
18154 * Sets the Blend Mode being used by this Game Object.
18155 *
18156 * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)
18157 *
18158 * Under WebGL only the following Blend Modes are available:
18159 *
18160 * * NORMAL
18161 * * ADD
18162 * * MULTIPLY
18163 * * SCREEN
18164 * * ERASE (only works when rendering to a framebuffer, like a Render Texture)
18165 *
18166 * Canvas has more available depending on browser support.
18167 *
18168 * You can also create your own custom Blend Modes in WebGL.
18169 *
18170 * Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
18171 * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
18172 * reasons try to be careful about the construction of your Scene and the frequency with which blend modes
18173 * are used.
18174 * @param value The BlendMode value. Either a string, a CONST or a number.
18175 * @returns This Game Object instance.
18176 */
18177 setBlendMode(value: string | Phaser.BlendModes | number): this;
18178 }
18179
18180 /**
18181 * Provides methods used for calculating and setting the size of a non-Frame based Game Object.

Callers 8

DrawingContext.jsFile · 0.80
ListCompositor.jsFile · 0.80
DynamicTexture.jsFile · 0.80
ContainerWebGLRendererFunction · 0.80
Container.jsFile · 0.80
ContainerCanvasRendererFunction · 0.80
LayerWebGLRendererFunction · 0.80

Calls

no outgoing calls

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…