phaser/resources/docgen/output/PIXI.CanvasTinter.json

{"class":{"name":"PIXI.CanvasTinter","extends":"","static":false,"constructor":true,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"getTintedTexture","static":false,"returns":{"types":["HTMLCanvasElement"],"help":"The tinted canvas"},"help":"Basically this method just needs a sprite and a color and tints the sprite with the given color.","line":22,"public":true,"protected":false,"private":false,"parameters":[{"name":"sprite","type":["PIXI.Sprite"],"help":"the sprite to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"roundColor","static":false,"returns":null,"help":"Rounds the specified color according to the PIXI.CanvasTinter.cacheStepsPerColorChannel.","line":190,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"the color to round, should be a hex color","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintMethod","static":false,"returns":null,"help":"The tinting method that will be used.","line":232,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"tintPerPixel","static":false,"returns":null,"help":"Tint a texture pixel per pixel.","line":147,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintWithMultiply","static":false,"returns":null,"help":"Tint a texture using the \"multiply\" operation.","line":66,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"tintWithOverlay","static":false,"returns":null,"help":"Tint a texture using the \"overlay\" operation.","line":112,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to tint","optional":false,"default":null},{"name":"color","type":["number"],"help":"the color to use to tint the sprite with","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"the current canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"cacheStepsPerColorChannel","type":["number"],"help":"Number of steps which will be used as a cap when rounding colors.","inlineHelp":"","line":209,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canUseMultiply","type":["boolean"],"help":"Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method.","inlineHelp":"","line":225,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"convertTintToImage","type":["boolean"],"help":"Tint cache boolean flag.","inlineHelp":"","line":217,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}