Class: CanvasTinter

PIXI.CanvasTinter

new PIXI.CanvasTinter ()

Utility methods for Sprite/Texture tinting.

Tinting with the CanvasRenderer involves creating a new canvas to use as a texture, so be aware of the performance implications.

Members

PIXI.CanvasTinter.cacheStepsPerColorChannel number static

Number of steps which will be used as a cap when rounding colors.

PIXI.CanvasTinter.canUseMultiply boolean static

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

PIXI.CanvasTinter.convertTintToImage boolean static

Tint cache boolean flag.

Methods

PIXI.CanvasTinter.getTintedCanvas (sprite, color)HTMLCanvasElement static

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

Name Type Description
sprite PIXI.Sprite

the sprite to tint

color number

the color to use to tint the sprite with

Returns:
Type Description
HTMLCanvasElement The tinted canvas

PIXI.CanvasTinter.roundColor (color)number static

Rounds the specified color according to the CanvasTinter.cacheStepsPerColorChannel.

Name Type Description
color number

the color to round, should be a hex color

Returns:
Type Description
number The rounded color.

PIXI.CanvasTinter.tintMethod () static

The tinting method that will be used.

PIXI.CanvasTinter.tintWithMultiply (texture, color, canvas) static

Tint a texture using the 'multiply' operation.

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

PIXI.CanvasTinter.tintWithOverlay (texture, color, canvas) static

Tint a texture using the 'overlay' operation.

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

PIXI.CanvasTinter.tintWithPerPixel (texture, color, canvas) static

Tint a texture pixel per pixel.

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