API Docs for: 2.0.0
Show:

CanvasTinter Class

Defined in: src/pixi/renderers/canvas/utils/CanvasTinter.js:5
Module: PIXI

Constructor

CanvasTinter

() static

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:5

Methods

getTintedTexture

(
  • sprite
  • color
)
HTMLCanvasElement

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:14

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

Parameters:

  • sprite Sprite

    the sprite to tint

  • color Number

    the color to use to tint the sprite with

Returns:

HTMLCanvasElement:

The tinted canvas

roundColor

(
  • color
)

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:184

Rounds the specified color according to the PIXI.CanvasTinter.cacheStepsPerColorChannel.

Parameters:

  • color Number

    the color to round, should be a hex color

tintMethod

()

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:227

The tinting method that will be used.

tintPerPixel

(
  • texture
  • color
  • canvas
)

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:139

Tint a texture pixel per pixel.

Parameters:

  • texture Texture

    the texture to tint

  • color Number

    the color to use to tint the sprite with

  • canvas HTMLCanvasElement

    the current canvas

tintWithMultiply

(
  • texture
  • color
  • canvas
)

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:58

Tint a texture using the "multiply" operation.

Parameters:

  • texture Texture

    the texture to tint

  • color Number

    the color to use to tint the sprite with

  • canvas HTMLCanvasElement

    the current canvas

tintWithOverlay

(
  • texture
  • color
  • canvas
)

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:104

Tint a texture using the "overlay" operation.

Parameters:

  • texture Texture

    the texture to tint

  • color Number

    the color to use to tint the sprite with

  • canvas HTMLCanvasElement

    the current canvas

Properties

cacheStepsPerColorChannel

Number

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:203

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

canUseMultiply

Boolean

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:219

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

convertTintToImage

Boolean

Defined in src/pixi/renderers/canvas/utils/CanvasTinter.js:211

Tint cache boolean flag.