Класс: Phaser.Canvas

Конструктор

new Canvas()

Исходный код: utils/Canvas.js (Строка 14)

Публичные методы

<static> addToDOM(canvas, parent, overflowHidden) → {HTMLCanvasElement}

Добавляет указанный элемент холста в DOM. Холст будет добавлен как дочерний элемент заданному родительскому элементу.
Если родительский элемент не указан, он будет добавлен как дочерний элемент document.body.

Parameters

Name	Type	Argument	Default	Description
canvas	HTMLCanvasElement			Холст, который необходимо добавить в DOM.
parent	string | HTMLElement			Элемент DOM, в который нужно добавить холст.
overflowHidden	boolean	<optional>	true	Если установлено в true, к родительскому элементу DOM будет добавлен стиль overflow='hidden'.

Returns

HTMLCanvasElement -

Возвращает исходный холст.

Source code: utils/Canvas.js (Line 109)

<static> create(parent, width, height, id, skipPool) → {HTMLCanvasElement}

Создаёт элемент DOM canvas. Элемент не добавляется в документ автоматически.

Parameters

Name	Type	Argument	Default	Description
parent	object			Объект, который будет владеть созданным холстом.
width	number	<optional>	256	Ширина элемента холста.
height	number	<optional>	256	Высота элемента холста.
id	string	<optional>	(none)	Если указано и не пустая строка, это будет установлено в качестве ID элемента холста. В противном случае ID не будет установлен.
skipPool	boolean	<optional>	false	Если true, холст не будет помещён в глобальный CanvasPool.

Returns

HTMLCanvasElement -

Созданный элемент холста.

Source code: utils/Canvas.js (Line 16)

<static> getSmoothingEnabled(context) → {boolean}

Возвращает true, если у заданного контекста включено сглаживание изображений, в противном случае возвращает false.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	Контекст, для проверки сглаживания.

Returns

boolean -

True, если у заданного контекста включено сглаживание изображений, в противном случае false.

Source code: utils/Canvas.js (Line 242)

<static> getSmoothingPrefix(context) → {string | null}

Возвращает префикс вендора Smoothing Enabled для заданного контекста, или null если не задан.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	Контекст, для включения или выключения сглаживания изображений.

Returns

string | null -

Возвращает префикс вендора smoothingEnabled или null, если он не установлен в контексте.

Source code: utils/Canvas.js (Line 217)

<static> removeFromDOM(canvas)

Удаляет указанный элемент холста из DOM.

Parameters

Name	Type	Description
canvas	HTMLCanvasElement	Холст, который необходимо удалить из DOM.

Source code: utils/Canvas.js (Line 156)

<static> setBackgroundColor(canvas, color) → {HTMLCanvasElement}

Устанавливает цвет фона за холстом. Это изменяет свойство стиля холста.

Parameters

Name	Type	Argument	Default	Description
canvas	HTMLCanvasElement			Холст, для которого нужно установить цвет фона.
color	string	<optional>	'rgb(0,0,0)'	Цвет для установки. Может быть в формате 'rgb(r,g,b)', или '#RRGGBB', или любой допустимый цвет CSS.

Returns

HTMLCanvasElement -

Возвращает исходный холст.

Source code: utils/Canvas.js (Line 47)

<static> setImageRenderingBicubic(canvas) → {HTMLCanvasElement}

Устанавливает свойство CSS image-rendering для данного холста в 'bicubic' (также 'auto').
Обратите внимание, что если это не даёт желаемого результата, обратитесь к методу CanvasUtils.setSmoothingEnabled.

Parameters

Name	Type	Description
canvas	HTMLCanvasElement	Холст, для которого нужно установить image-rendering bicubic.

Returns

HTMLCanvasElement -

Возвращает исходный холст.

Source code: utils/Canvas.js (Line 283)

<static> setImageRenderingCrisp(canvas) → {HTMLCanvasElement}

Устанавливает свойство CSS image-rendering для заданного холста в 'crisp' (также 'optimize contrast' в webkit).
Обратите внимание, что если это не даёт желаемого результата, обратитесь к setSmoothingEnabled.

Parameters

Имя	Тип	Описание
canvas	HTMLCanvasElement	Поверхность холста, на которой нужно установить резкое отображение изображений.

Возвращаемое значение

HTMLCanvasElement -

Возвращает исходный холст.

Исходный код: utils/Canvas.js (Строка 260)

<static> setSmoothingEnabled(context, value) → {CanvasRenderingContext2D}

Устанавливает свойство сглаживания изображений для данного контекста. Установка значения false отключает сглаживание изображений.
По умолчанию браузеры включают сглаживание изображений, что не всегда желательно визуально, особенно
при использовании пиксельной графики в игре. Обратите внимание, что это свойство устанавливается непосредственно в контексте, поэтому любое изображение,
отображаемое в контексте, будет затронуто. Это свойство устанавливается во всех современных браузерах, но поддержка может быть нестабильной в более старых браузерах, особенно на мобильных устройствах.

Параметры

Имя	Тип	Описание
context	CanvasRenderingContext2D	Контекст, для которого нужно включить или отключить сглаживание изображений.
value	boolean	Если значение true, включить сглаживание изображений, false — отключить.

Возвращаемое значение

CanvasRenderingContext2D -

Возвращает исходный контекст.

Исходный код: utils/Canvas.js (Строка 192)

<static> setTouchAction(canvas, value) → {HTMLCanvasElement}

Устанавливает свойство touch-action для стиля холста. Может использоваться для отключения стандартных действий браузера при взаимодействии с касанием.

Параметры

Имя	Тип	Аргумент	Описание
canvas	HTMLCanvasElement		Холст, для которого нужно установить touch action.
value	string	<optional>	Действие касания для установки. По умолчанию 'none'.

Возвращаемое значение

HTMLCanvasElement -

Исходный холст.

Исходный код: utils/Canvas.js (Строка 65)

<static> setTransform(context, translateX, translateY, scaleX, scaleY, skewX, skewY) → {CanvasRenderingContext2D}

Устанавливает преобразование для данного контекста холста, используя предоставленные матричные значения.

Параметры

Имя	Тип	Описание
context	CanvasRenderingContext2D	Контекст, для которого нужно установить преобразование.
translateX	number	Значение для горизонтального смещения.
translateY	number	Значение для вертикального смещения.
scaleX	number	Значение для горизонтального масштабирования.
scaleY	number	Значение для вертикального масштабирования.
skewX	number	Значение для горизонтального наклона.
skewY	number	Значение для вертикального наклона.

Возвращаемое значение

CanvasRenderingContext2D -

Возвращает исходный контекст.

Исходный код: utils/Canvas.js (Строка 171)

<static> setUserSelect(canvas, value) → {HTMLCanvasElement}

Устанавливает свойство user-select для стиля холста. Может использоваться для отключения стандартных действий браузера по выделению.

Параметры

Имя	Тип	Аргумент	Описание
canvas	HTMLCanvasElement		Холст, для которого нужно установить действие.
value	string	<optional>	Действие для установки. По умолчанию 'none'.

Возвращаемое значение

HTMLCanvasElement -

Исходный холст.

Исходный код: utils/Canvas.js (Строка 85)