Class: Canvas

Methods

<static> addToDOM(canvas, parent [, overflowHidden])

Adds the given canvas element to the DOM. The canvas will be added as a child of the given parent. If no parent is given it will be added as a child of the document.body.

Parameters:

Name	Type	Argument	Default	Description
canvas	HTMLCanvasElement			The canvas to be added to the DOM.
parent	string | HTMLElement			The DOM element to add the canvas to.
overflowHidden	boolean	<optional>	true	If set to true it will add the overflow='hidden' style to the parent DOM element.

Source:

src/utils/Canvas.js line 120

Returns:

Returns the source canvas.

Type

HTMLCanvasElement

<static> create(parent [, width] [, height] [, id] [, skipPool])

Creates a canvas DOM element. The element is not automatically added to the document.

Parameters:

Name	Type	Argument	Default	Description
parent	object			The object that will own the canvas that is created.
width	number	<optional>	256	The width of the canvas element.
height	number	<optional>	256	The height of the canvas element..
id	string	<optional>	(none)	If specified, and not the empty string, this will be set as the ID of the canvas element. Otherwise no ID will be set.
skipPool	boolean	<optional>	false	If true the canvas will not be placed in the CanvasPool global.

Source:

src/utils/Canvas.js line 16

Returns:

The newly created canvas element.

Type

HTMLCanvasElement

<static> dispose(canvas)

Sets canvas dimensions to 1.

Parameters:

Name	Type	Description
canvas	HTMLCanvasElement	The canvas to be disposed of.

Source:

src/utils/Canvas.js line 46

Returns:

The canvas.

Type

HTMLCanvasElement

<static> getSmoothingEnabled(context)

Returns true if the given context has image smoothing enabled, otherwise returns false.

Parameters:

Name	Type	Description
context	CanvasRenderingContext2D	The context to check for smoothing on.

Source:

src/utils/Canvas.js line 248

Returns:

True if the given context has image smoothing enabled, otherwise false.

Type

boolean

<static> getSmoothingPrefix(context)

Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.

Parameters:

Name	Type	Description
context	CanvasRenderingContext2D	The context to enable or disable the image smoothing on.

Source:

src/utils/Canvas.js line 224

Returns:

Returns the smoothingEnabled vendor prefix, or null if not set on the context.

Type

string | null

<static> removeFromDOM(canvas)

Removes the given canvas element from the DOM.

Parameters:

Name	Type	Description
canvas	HTMLCanvasElement	The canvas to be removed from the DOM.

Source:

src/utils/Canvas.js line 166

<static> setBackgroundColor(canvas [, color])

Sets the background color behind the canvas. This changes the canvas style property.

Parameters:

Name	Type	Argument	Default	Description
canvas	HTMLCanvasElement			The canvas to set the background color on.
color	string	<optional>	'rgb(0,0,0)'	The color to set. Can be in the format 'rgb(r,g,b)', or '#RRGGBB' or any valid CSS color.

Source:

src/utils/Canvas.js line 61

Returns:

Returns the source canvas.

Type

HTMLCanvasElement

<static> setImageRenderingBicubic(canvas)

Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto'). Note that if this doesn't given the desired result then see the CanvasUtils.setSmoothingEnabled method.

Parameters:

Name	Type	Description
canvas	HTMLCanvasElement	The canvas to set image-rendering bicubic on.

Source:

src/utils/Canvas.js line 291

Returns:

Returns the source canvas.

Type

HTMLCanvasElement

<static> setImageRenderingCrisp(canvas)

Sets the CSS image-rendering property to pixelated or crisp-edges. This can remove blurring when the game canvas is scaled up. In some browsers this has no visible effect in WEBGL mode. Note that if this doesn't given the desired result then see the setSmoothingEnabled.

Parameters:

Name	Type	Description
canvas	HTMLCanvasElement	The canvas to set image-rendering crisp on.

Source:

src/utils/Canvas.js line 265

See:

• https://developer.mozilla.org/en-US/docs/Web/CSS/image-rendering
• https://caniuse.com/#feat=css-crisp-edges

Returns:

Returns the source canvas.

Type

HTMLCanvasElement

<static> setSmoothingEnabled(context, value)

Sets the Image Smoothing property on the given context. Set to false to disable image smoothing. By default browsers have image smoothing enabled, which isn't always what you visually want, especially when using pixel art in a game. Note that this sets the property on the context itself, so that any image drawn to the context will be affected. This sets the property across all current browsers but support is patchy on earlier browsers, especially on mobile.

Parameters:

Name	Type	Description
context	CanvasRenderingContext2D	The context to enable or disable the image smoothing on.
value	boolean	If set to true it will enable image smoothing, false will disable it.

Source:

src/utils/Canvas.js line 200

Returns:

Returns the source context.

Type

CanvasRenderingContext2D

<static> setTouchAction(canvas [, value])

Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.

Parameters:

Name	Type	Argument	Description
canvas	HTMLCanvasElement		The canvas to set the touch action on.
value	string	<optional>	The touch action to set. Defaults to 'none'.

Source:

src/utils/Canvas.js line 78

Returns:

The source canvas.

Type

HTMLCanvasElement

<static> setTransform(context, translateX, translateY, scaleX, scaleY, skewX, skewY)

Sets the transform of the given canvas to the matrix values provided.

Parameters:

Name	Type	Description
context	CanvasRenderingContext2D	The context to set the transform on.
translateX	number	The value to translate horizontally by.
translateY	number	The value to translate vertically by.
scaleX	number	The value to scale horizontally by.
scaleY	number	The value to scale vertically by.
skewX	number	The value to skew horizontaly by.
skewY	number	The value to skew vertically by.

Source:

src/utils/Canvas.js line 180

Returns:

Returns the source context.

Type

CanvasRenderingContext2D

<static> setUserSelect(canvas [, value])

Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.

Parameters:

Name	Type	Argument	Description
canvas	HTMLCanvasElement		The canvas to set the touch action on.
value	string	<optional>	The touch action to set. Defaults to 'none'.

Source:

src/utils/Canvas.js line 97

Returns:

The source canvas.

Type

HTMLCanvasElement