These docs are for Phaser 2.6.2 Phaser 3 docs can be found on GitHub pages.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. CanvasTinter

new CanvasTinter()

Utility methods for Sprite/Texture tinting.

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 5)

Public Properties

<static> canHandleAlpha : boolean

If the browser isn't capable of handling tinting with alpha this will be false.
This property is only applicable if using tintWithPerPixel.

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 146)

<static> canUseMultiply : boolean

Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method.

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 156)

Public Methods

<static> checkInverseAlpha()

Checks if the browser correctly supports putImageData alpha channels.

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 113)

<static> getTintedTexture(sprite, color) → {HTMLCanvasElement}

Basically this method just needs a sprite and a color and tints the sprite with the given color.

Parameters
Name Type Description
sprite PIXI.Sprite

the sprite to tint

color Number

the color to use to tint the sprite with

Returns
HTMLCanvasElement -

The tinted canvas

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 13)

<static> tintMethod()

The tinting method that will be used.

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 165)

<static> tintPerPixel(texture, color, canvas)

Tint a texture pixel per pixel.

Parameters
Name Type Description
texture PIXI.Texture

the texture to tint

color Number

the color to use to tint the sprite with

canvas HTMLCanvasElement

the current canvas

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 65)

<static> tintWithMultiply(texture, color, canvas)

Tint a texture using the "multiply" operation.

Parameters
Name Type Description
texture PIXI.Texture

the texture to tint

color Number

the color to use to tint the sprite with

canvas HTMLCanvasElement

the current canvas

Source code: pixi/renderers/canvas/utils/CanvasTinter.js (Line 31)