Spec-Zone.ru › Phaser

Класс: Phaser.BitmapData

Конструктор

new BitmapData(game, key, width, height, skipPool)

Объект BitmapData содержит элемент Canvas, на который можно рисовать с помощью обычных операций контекста Canvas.
Один BitmapData может использоваться в качестве текстуры для одного или нескольких изображений/спрайтов.
Поэтому они являются хорошим выбором, если вам нужно динамически создавать текстуру спрайта.

Важное примечание: Каждый BitmapData создает свой собственный элемент Canvas. Поскольку BitmapData теперь являются самими объектами игры и не находятся в списке отображения,
они НЕ очищаются автоматически при изменении состояния. Поэтому вы ДОЛЖНЫ вызвать BitmapData.destroy
в методе закрытия своего состояния, если хотите освободить ресурсы, используемые BitmapData, это не произойдёт автоматически.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
game Phaser.Game

Ссылка на текущую запущенную игру.

key string

Внутренний ключ Phaser для BitmapData.

width number <optional>
256

Ширина BitmapData в пикселях. Если не определена или равна нулю, устанавливается значение по умолчанию.

height number <optional>
256

Высота BitmapData в пикселях. Если не определена или равна нулю, устанавливается значение по умолчанию.

skipPool boolean <optional>
false

Когда этот BitmapData генерирует свой внутренний холст для отрисовки, он получит холст из CanvasPool, если false, или создаст свой собственный, если true.

Исходный код: gameobjects/BitmapData.js (Строка 24)

Свойства

baseTexture : PIXI.BaseTexture

Базовая текстура PIXI.BaseTexture.

Исходный код: gameobjects/BitmapData.js (Строка 124)

canvas :HTMLCanvasElement

Канвас, на который отрисовывается этот BitmapData.

Исходный код: gameobjects/BitmapData.js (Строка 54)

context :CanvasRenderingContext2D

Двумерный контекст канваса.

Исходный код: gameobjects/BitmapData.js (Строка 60)

ctx :CanvasRenderingContext2D

Ссылка на BitmapData.context.

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

data :Uint8ClampedArray

Представление Uint8ClampedArray в BitmapData.buffer.
Обратите внимание, что в некоторых браузерах (например, Epic Browser из-за ограничений безопасности) это свойство недоступно.

Исходный код: gameobjects/BitmapData.js (Строка 84)

dirty : boolean

Если dirty, этот BitmapData будет перерисован.

Исходный код: gameobjects/BitmapData.js (Строка 159)

disableTextureUpload : boolean

Если disableTextureUpload равен true, этот BitmapData никогда не будет отправлять свои данные изображения на GPU, когда установлен флаг dirty.

Исходный код: gameobjects/BitmapData.js (Строка 154)

frameData : Phaser.FrameData

Контейнер FrameData, используемый этим BitmapData для рендеринга.

Исходный код: gameobjects/BitmapData.js (Строка 135)

game : Phaser.Game

Ссылка на текущую игру.

Исходный код: gameobjects/BitmapData.js (Строка 33)

height : number

Высота BitmapData в пикселях.

Исходный код: gameobjects/BitmapData.js (Строка 48)

imageData :ImageData

Данные изображения контекста.
Пожалуйста, обратите внимание, что вызов BitmapData.draw() или BitmapData.copy() немедленно не обновляет это свойство по соображениям производительности. Используйте BitmapData.update() для этого.
Это свойство обновляется автоматически после первого цикла игры в соответствии со свойством флага dirty.

Исходный код: gameobjects/BitmapData.js (Строка 77)

key : string

Ключ BitmapData в кэше, если он там хранится.

Исходный код: gameobjects/BitmapData.js (Строка 38)

pixels :Uint32Array

Представление Uint32Array в BitmapData.buffer.

Исходный код: gameobjects/BitmapData.js (Строка 94)

smoothProperty : string

Свойство контекста, необходимое для сглаживания этого Canvas.

Исходный код: gameobjects/BitmapData.js (Строка 70)

texture : PIXI.Texture

Текстура PIXI.Texture.

Исходный код: gameobjects/BitmapData.js (Строка 130)

textureFrame : Phaser.Frame

Кадр, используемый этим BitmapData для рендеринга.

Исходный код: gameobjects/BitmapData.js (Строка 141)

type : number

Тип объекта по константе.

Исходный код: gameobjects/BitmapData.js (Строка 149)

width : number

Ширина BitmapData в пикселях.

Исходный код: gameobjects/BitmapData.js (Строка 43)

Методы

<static> getTransform(translateX, translateY, scaleX, scaleY, skewX, skewY) → {object}

Получает JavaScript-объект с 6 свойствами, используемыми BitmapData в преобразовании.

Параметры
Имя Тип Описание
translateX number

Значение смещения по оси x.

translateY number

Значение смещения по оси y.

scaleX number

Значение масштаба по оси x.

scaleY number

Значение масштаба по оси y.

skewX number

Значение наклона по оси x.

skewY number

Значение наклона по оси y.

Возвращает
object -

JavaScript-объект, содержащий все свойства, необходимые BitmapData для преобразований.

Исходный код: gameobjects/BitmapData.js (Строка 2419)

add(object) → {Phaser.BitmapData}

Обновляет заданные объекты, чтобы они использовали этот BitmapData в качестве текстуры.
Это заменит любую текущую установленную текстуру.

Параметры
Имя Тип Описание
object Phaser.Sprite | Array.<Phaser.Sprite> | Phaser.Image | Array.<Phaser.Image>

Один Sprite/Image или массив Sprites/Images.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 393)

addToWorld(x, y, anchorX, anchorY, scaleX, scaleY) → {Phaser.Image}

Создаёт новый объект Phaser.Image, назначает этому BitmapData в качестве текстуры, добавляет его в мир и возвращает его.

Параметры
Имя Тип Аргумент По умолчанию Описание
x number <необязательно>
0

Координата x для размещения Image.

y number <необязательно>
0

Координата y для размещения Image.

anchorX number <необязательно>
0

Установить точку привязки x для Image. Значение между 0 и 1, где 0 - верхний левый угол, 1 - нижний правый.

anchorY number <необязательно>
0

Установить точку привязки y для Image. Значение между 0 и 1, где 0 - верхний левый угол, 1 - нижний правый.

scaleX number <необязательно>
1

Горизонтальный коэффициент масштаба Image. Значение 1 означает отсутствие масштабирования. 2 означает увеличение в два раза и так далее.

scaleY number <необязательно>
1

Вертикальный коэффициент масштаба Image. Значение 1 означает отсутствие масштабирования. 2 означает увеличение в два раза и так далее.

Возвращает
Phaser.Image -

Новый добавленный объект Image.

Исходный код: gameobjects/BitmapData.js (Строка 1179)

alphaMask(source, mask, sourceRect, maskRect) → {Phaser.BitmapData}

Отображает изображение на этот BitmapData, используя изображение в качестве маски альфа-канала.

Параметры
Имя Тип Аргумент Описание
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Image | HTMLCanvasElement | string

Источник для копирования. Если вы передадите строку, она попытается найти Image в Game.Cache. Это довольно затратно по ресурсам, поэтому лучше передать само изображение.

mask Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Image | HTMLCanvasElement | string <необязательно>

Объект, используемый в качестве маски. Если вы передадите строку, она попытается найти Image в Game.Cache. Это довольно затратно по ресурсам, поэтому лучше передать само изображение. Если вы не предоставите маску, этот BitmapData будет использоваться в качестве маски.

sourceRect Phaser.Rectangle <необязательно>

Прямоугольник, где x/y определяют координаты для отрисовки изображения Source, а ширина/высота - размер.

maskRect Phaser.Rectangle <необязательно>

Прямоугольник, где x/y определяют координаты для отрисовки изображения Mask, а ширина/высота - размер.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1738)

blendAdd() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'lighter'.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2169)

blendColor() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'color'.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

END_OF_DOCUMENT_MARKER
Source code: gameobjects/BitmapData.js (Line 2351)

blendColorBurn() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'color-burn'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2260)

blendColorDodge() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'color-dodge'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2247)

blendDarken() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'darken'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2221)

blendDestinationAtop() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'destination-atop'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2143)

blendDestinationIn() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'destination-in'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2117)

blendDestinationOut() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'destination-out'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2130)

blendDestinationOver() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'destination-over'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2104)

blendDifference() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'difference'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2299)

blendExclusion() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'exclusion'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2312)

blendHardLight() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'hard-light'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2273)

blendHue() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'hue'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2325)

blendLighten() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'lighten'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2234)

blendLuminosity() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'luminosity'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2364)

blendMultiply() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'multiply'

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Line 2182)

blendOverlay() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'overlay'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2208)

blendReset() → {Phaser.BitmapData}

Сбрасывает режим смешивания (фактически устанавливает его на 'source-over')

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2039)

blendSaturation() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'saturation'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2338)

blendScreen() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'screen'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2195)

blendSoftLight() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'soft-light'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2286)

blendSourceAtop() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'source-atop'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2091)

blendSourceIn() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'source-in'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2065)

blendSourceOut() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'source-out'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2078)

blendSourceOver() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'source-over'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2052)

blendXor() → {Phaser.BitmapData}

Устанавливает режим смешивания на 'xor'

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2156)

circle(x, y, radius, fillStyle) → {Phaser.BitmapData}

Рисует заполненный круг в BitmapData в заданных координатах x, y и радиусе.

Параметры
Имя Тип Аргумент Описание
x number

Координата x для рисования круга. Это центр круга.

y number

Координата y для рисования круга. Это центр круга.

radius number

Радиус круга в пикселях. Радиус равен половине диаметра.

fillStyle string <optional>

Если установлено, fillStyle контекста будет установлен в это значение перед рисованием круга.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1891)

clear(x, y, width, height) → {Phaser.BitmapData}

Очищает контекст BitmapData с помощью clearRect.

Вы можете опционально определить область для очистки.
Если аргументы опущены, будет очищен весь холст.

Возможно, вам необходимо вызвать BitmapData.update после этого, чтобы очистить данные пикселей,
но Phaser не сделает это автоматически.

Параметры
Имя Тип Аргумент По умолчанию Описание
x число <необязательно>
0

Координата x верхнего левого угла области, которую нужно очистить.

y число <необязательно>
0

Координата y верхнего левого угла области, которую нужно очистить.

width число <необязательно>

Ширина области, которую нужно очистить. Если не определено, используется BitmapData.width.

height число <необязательно>

Высота области, которую нужно очистить. Если не определено, используется BitmapData.height.

Возвращаемое значение
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 463)

cls()

Очищает контекст BitmapData с помощью clearRect.

Исходный код: gameobjects/BitmapData.js (Строка 457)

copy(source, x, y, width, height, tx, ty, newWidth, newHeight, rotate, anchorX, anchorY, scaleX, scaleY, alpha, blendMode, roundPx) → {Phaser.BitmapData}

Копирует прямоугольную область из исходного объекта в этот BitmapData. Если в качестве источника указано null, копирование производится из самого себя.

Вы можете, по желанию, изменять размер, смещать, поворачивать, масштабировать, изменять альфа-канал или режим смешивания при отрисовке.

Все повороты, масштабирование и отрисовка по умолчанию выполняются вокруг центра области, но это можно изменить параметрами якоря.

Обратите внимание, что исходное изображение также может быть этим BitmapData, что может создать интересные эффекты.

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

Вы можете предпочесть использовать copyTransform, если вы просто пытаетесь нарисовать Sprite в этом BitmapData,
и не хотите изменять смещение, масштаб или поворот от их исходных значений.

Параметры
Имя Тип Аргумент По умолчанию Описание
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Phaser.RenderTexture | Image | HTMLCanvasElement | string <необязательно>

Источник для копирования. Если строка, попытается найти Image в кэше игры. Это довольно дорого, поэтому старайтесь предоставлять само изображение.

x число <необязательно>
0

Координата x, представляющая верхний левый угол области для копирования из исходного изображения.

y число <необязательно>
0

Координата y, представляющая верхний левый угол области для копирования из исходного изображения.

width число <необязательно>

Ширина области для копирования из исходного изображения. Если не указано, используется полная ширина исходного изображения.

height число <необязательно>

Высота области для копирования из исходного изображения. Если не указано, используется полная высота исходного изображения.

tx число <необязательно>

Координата x для смещения перед отрисовкой. Если не указано, по умолчанию используется параметр x. Если null и source — объект отображения, по умолчанию используется source.x.

ty число <необязательно>

Координата y для смещения перед отрисовкой. Если не указано, по умолчанию используется параметр y. Если null и source — объект отображения, по умолчанию используется source.y.

newWidth число <необязательно>

Новая ширина копируемого блока. Если не указано, по умолчанию используется параметр width.

newHeight число <необязательно>

Новая высота копируемого блока. Если не указано, по умолчанию используется параметр height.

rotate число <необязательно>
0

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

anchorX число <необязательно>
0

Точка якоря, вокруг которой блок поворачивается и масштабируется. Значение от 0 до 1, где 0 — верхний левый угол, а 1 — нижний правый.

anchorY число <необязательно>
0

Точка якоря, вокруг которой блок поворачивается и масштабируется. Значение от 0 до 1, где 0 — верхний левый угол, а 1 — нижний правый.

scaleX число <необязательно>
1

Горизонтальный коэффициент масштабирования блока. Значение 1 означает отсутствие масштабирования. 2 — в два раза больше и так далее.

scaleY число <необязательно>
1

Вертикальный коэффициент масштабирования блока. Значение 1 означает отсутствие масштабирования. 2 — в два раза больше и так далее.

alpha число <необязательно>
1

Альфа-канал, который будет установлен для контекста перед отрисовкой. Значение от 0 (полностью прозрачно) до 1 (непрозрачно).

blendMode строка <необязательно>
null

Режим композиции, который будет использоваться при отрисовке. По умолчанию режим смешивания отсутствует. Это значение Canvas globalCompositeOperation, такое как «lighter» или «xor».

roundPx логическое <необязательно>
false

Нужно ли округлять значения x и y до целых чисел перед отрисовкой? Это предотвращает антиалиасинг в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1205)
END_OF_DOCUMENT_MARKER

copyRect(source, area, x, y, alpha, blendMode, roundPx) → {Phaser.BitmapData}

Копирует область, определённую параметром Rectangle, из исходного изображения в этот BitmapData по заданным координатам.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Phaser.RenderTexture | Image | string

Изображение для копирования. Если вы передадите строку, она будет использоваться для поиска изображения в кэше игры.

area Phaser.Rectangle

Область Rectangle, которую нужно скопировать из исходного изображения.

x number

Координата x для назначения копируемого изображения.

y number

Координата y для назначения копируемого изображения.

alpha number <optional>
1

Значение прозрачности (alpha), которое будет установлено для контекста перед рисованием. Значение от 0 (полностью прозрачно) до 1 (полностью непрозрачно).

blendMode string <optional>
null

Режим композиции, который будет использован при рисовании. По умолчанию режим композиции не используется. Это значение Canvas globalCompositeOperation, такое как 'lighter' или 'xor'.

roundPx boolean <optional>
false

Нужно ли округлять значения x и y до целых чисел перед рисованием? Это предотвращает размытие в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1534)

copyTransform(source, blendMode, roundPx) → {Phaser.BitmapData}

Рисует указанный source объект игры в этот BitmapData, используя его свойство worldTransform для определения
позиции, масштаба и поворота места рисования. Эта функция используется внутри drawGroup.
Она учитывает цвет и режим масштабирования объекта перед рисованием.

Вы можете дополнительно указать режим композиции и округлять ли пиксели.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Phaser.BitmapText <optional>

Объект игры для рисования.

blendMode string <optional>
null

Режим композиции, который будет использован при рисовании. По умолчанию режим композиции не используется. Это значение Canvas globalCompositeOperation, такое как 'lighter' или 'xor'.

roundPx boolean <optional>
false

Нужно ли округлять значения x и y до целых чисел перед рисованием? Это предотвращает размытие в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1426)

destroy()

Уничтожает этот BitmapData и возвращает используемый холст в пул холстов для повторного использования.

Исходный код: gameobjects/BitmapData.js (Строка 2024)

draw(source, x, y, width, height, blendMode, roundPx) → {Phaser.BitmapData}

Рисует указанный Phaser.Sprite, Phaser.Image или Phaser.Text в этот BitmapData по указанным координатам.
Можно использовать необязательные значения width и height для «растяжения» спрайта при рисовании. Используется растяжение drawImage, а не масштабирование.

Дочерние элементы будут нарисованы в своих x и y координатах мирового пространства. Если они выходят за пределы BitmapData, они не будут видны.
При рисовании будут учтены поворот, масштаб, режим масштабирования, прозрачность и цвет.

Примечание: следует убедиться, что хотя бы один полный цикл обновления произошел до вызова этой функции,
иначе объекты, вероятно, будут отрисованы неправильно или вообще не будут видны.
Вы можете самостоятельно инициировать обновление, вызвав stage.updateTransform() перед вызовом draw.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.RenderTexture

Объект Sprite, Image или Text для рисования в BitmapData.

x number <optional>
0

Координата x для смещения перед рисованием. Если не указано, по умолчанию source.x.

y number <optional>
0

Координата y для смещения перед рисованием. Если не указано, по умолчанию source.y.

width number <optional>

Новая ширина копируемого Sprite. Если не указано, по умолчанию source.width.

height number <optional>

Новая высота копируемого Sprite. Если не указано, по умолчанию source.height.

blendMode string <optional>
null

Режим композиции, который будет использован при рисовании. По умолчанию режим композиции не используется. Это значение Canvas globalCompositeOperation, такое как 'lighter' или 'xor'.

roundPx boolean <optional>
false

Нужно ли округлять значения x и y до целых чисел перед рисованием? Это предотвращает размытие в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1553)

drawFull(parent, blendMode, roundPx) → {Phaser.BitmapData}

Отображает игровой объект или группу в этот BitmapData, а затем рекурсивно перебирает всех его потомков.

Если у потомка есть свойство exists, то он (и его потомки) будут отображаться только если exists равен true.

Потомки будут отображаться в их x и y координатах в мировом пространстве. Если они находятся за пределами границ BitmapData, они не будут отображаться. В зависимости от ваших требований, вам может потребоваться предварительно изменить размер BitmapData, чтобы он соответствовал границам верхнего уровня игрового объекта.

При отображении учитываются значения вращения, масштабирования и альфа-канала потомка.

Совершенно допустимо передать game.world в качестве родительского объекта, и он переберет весь список отображения.

Примечание: если вы пытаетесь получить весь свой игровой процесс в начале состояния, убедитесь, что по крайней мере один полный цикл обновления
произошел до этого, иначе все объекты будут отображаться с неверными позициями и масштабами. Вы можете
вызвать обновление самостоятельно, вызвав stage.updateTransform() перед вызовом drawFull.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
parent Phaser.World | Phaser.Group | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText

Игровой объект, который будет нарисован в этом BitmapData, а затем рекурсивно нарисует всех его потомков.

blendMode string <optional>
null

Режим смешивания, который будет использоваться при отрисовке. По умолчанию режим смешивания не используется. Это значение Canvas globalCompositeOperation, такое как 'lighter' или 'xor'.

roundPx boolean <optional>
false

Нужно ли округлять значения x и y до целых чисел перед отрисовкой? Это предотвращает размытие в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1648)

drawGroup(group, blendMode, roundPx) → {Phaser.BitmapData}

Отображает непосредственных потомков Phaser.Group в этом BitmapData.

Совершенно допустимо передать game.world в качестве группы, и он переберет весь список отображения.

Потомки отображаются только если у них установлено свойство exists в true, и у них есть текстуры на основе изображений или RenderTexture.

Потомки будут отображаться в их x и y координатах в мировом пространстве. Если они находятся за пределами границ BitmapData, они не будут отображаться.
При отрисовке учитываются значения вращения, масштабирования, scaleMode, альфа-канала и цвета.

Примечание: Убедитесь, что по крайней мере один полный цикл обновления произошел до вызова этого,
иначе объекты, скорее всего, отобразятся неправильно или вообще не отобразятся.
Вы можете вызвать обновление самостоятельно, вызвав stage.updateTransform() перед вызовом drawGroup.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
group Phaser.Group

Группа для отрисовки в этом BitmapData. Также может быть Phaser.World.

blendMode string <optional>
null

Режим смешивания, который будет использоваться при отрисовке. По умолчанию режим смешивания не используется. Это значение Canvas globalCompositeOperation, такое как 'lighter' или 'xor'.

roundPx boolean <optional>
false

Нужно ли округлять значения x и y до целых чисел перед отрисовкой? Это предотвращает размытие в некоторых случаях.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1581)

extract(destination, r, g, b, a, resize, r2, g2, b2) → {Phaser.BitmapData}

Ищет в этом BitmapData все пиксели, соответствующие заданным значениям r,g,b, и затем рисует их в заданном BitmapData назначения.
Исходный BitmapData остается неизменным.
BitmapData назначения должен быть достаточно большим, чтобы принять все отсканированные пиксели, если параметр 'resize' не является true.
Несмотря на то, что BitmapData назначения возвращается из этого метода, он на самом деле изменяется непосредственно на месте, что означает, что этот вызов совершенно допустим:
picture.extract(mask, r, g, b)
Вы можете указать необязательные значения цвета r2, g2, b2. Если они указаны, нарисованный пиксель в назначенном bitmap будет иметь цвет r2, g2, b2.
Если они не указаны, он будет нарисован в том же цвете, что и извлеченный. Вы можете указать один или несколько альтернативных цветов, что позволяет вам изменять цвет во время извлечения.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
destination Phaser.BitmapData

BitmapData, в который будут нарисованы извлеченные пиксели.

r number

Красный компонент цвета в диапазоне 0 - 255.

g number

Зеленый компонент цвета в диапазоне 0 - 255.

b number

Синий компонент цвета в диапазоне 0 - 255.

a number <optional>
255

Компонент альфа цвета в диапазоне 0 - 255 для нового пикселя, который будет нарисован.

resize boolean <optional>
false

Нужно ли изменить размер BitmapData назначения для соответствия этому до копирования пикселей?

r2 number <optional>

Альтернативный красный компонент цвета для записи в назначение в диапазоне 0 - 255.

g2 number <optional>

Альтернативный зеленый компонент цвета для записи в назначение в диапазоне 0 - 255.

b2 number <optional>

Альтернативный синий компонент цвета для записи в назначение в диапазоне 0 - 255.

Возвращаемое значение
Phaser.BitmapData -

BitmapData, на котором были нарисованы извлеченные пиксели.

Исходный код: gameobjects/BitmapData.js (Строка 1772)

fill(r, g, b, a) → {Phaser.BitmapData}

Заполняет BitmapData указанным цветом.

Параметры
Имя Тип Аргумент По умолчанию Описание
r number

Значение красного цвета, от 0 до 0xFF (255).

g number

Значение зеленого цвета, от 0 до 0xFF (255).

b number

Значение синего цвета, от 0 до 0xFF (255).

a number <optional>
1

Значение альфа-канала, от 0 до 1.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 494)

generateTexture(key) → {PIXI.Texture}

Создает новый элемент изображения, преобразуя холст BitmapData в dataURL.

Изображение сохраняется в кэше изображений с заданным ключом.

Наконец, создается PIXI.Texture на основе изображения и возвращается.

Вы можете применить текстуру к спрайту или любому другому поддерживающему объекту, используя либо ключ, либо саму текстуру. Сначала вызовите generateTexture:

var texture = bitmapdata.generateTexture('ball');

Затем вы можете применить текстуру к спрайту:

game.add.sprite(0, 0, texture);

или используя строковый ключ:

game.add.sprite(0, 0, 'ball');

Параметры
Имя Тип Описание
key string

Ключ, который будет использоваться для хранения изображения в кэше.

Возвращаемое значение
PIXI.Texture -

Ново созданная текстура.

Исходный код: gameobjects/BitmapData.js (Строка 516)

getBounds(rect) → {Phaser.Rectangle}

Сканирует BitmapData и вычисляет границы. Это прямоугольник, определяющий область всех непрозрачных пикселей.
Возвращаемый прямоугольник будет охватывать область от левого верхнего до правого нижнего угла изображения, исключая прозрачные пиксели.

Параметры
Имя Тип Аргумент Описание
rect Phaser.Rectangle <optional>

Если указан, этот объект Rectangle будет заполнен границами, иначе будет создан новый объект.

Возвращаемое значение
Phaser.Rectangle -

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

Исходный код: gameobjects/BitmapData.js (Строка 1151)

getFirstPixel(direction) → {object}

Сканирует BitmapData по пикселям до тех пор, пока не найдет пиксель, который не является прозрачным (т. е. имеет значение альфа-канала > 0).
Затем сканирование прекращается и возвращается объект, содержащий цвет пикселя в свойствах r, g и b, и его координаты в свойствах x и y.

Параметр direction управляет направлением начала сканирования:

0 = сверху вниз
1 = снизу вверх
2 = слева направо
3 = справа налево

Параметры
Имя Тип Аргумент По умолчанию Описание
direction number <optional>
0

Направление сканирования для поиска первого пикселя. 0 = сверху вниз, 1 = снизу вверх, 2 = слева направо, 3 = справа налево.

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

Возвращает объект, содержащий цвет пикселя в свойствах r, g и b, и его координаты в свойствах x и y.

Исходный код: gameobjects/BitmapData.js (Строка 1068)

getPixel(x, y, out) → {object}

Получить цвет определенного пикселя в контексте в объект цвета.
Если вы что-то нарисовали в BitmapData с момента его создания, необходимо вызвать BitmapData.update для обновления буфера массива,
в противном случае это может вернуть устаревшие значения цвета, или, что хуже, - выбросить исключение во время выполнения, так как он пытается получить доступ к элементу массива, которого не существует.

Параметры
Имя Тип Аргумент Описание
x number

Координата x пикселя, который нужно установить. Должно лежать в пределах размеров этого BitmapData.

y number

Координата y пикселя, который нужно установить. Должно лежать в пределах размеров этого BitmapData.

out object <optional>

Объект, в который будут созданы 4 свойства: r, g, b и a. Если не указан, будет создан новый объект.

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

Объект с значениями красного, зеленого, синего и альфа-каналов, заданными в свойствах r, g, b и a.

Исходный код: gameobjects/BitmapData.js (Строка 985)

getPixel32(x, y) → {number}

Получить цвет определенного пикселя, включая его значение альфа-канала.
Если вы что-то нарисовали в BitmapData с момента его создания, необходимо вызвать BitmapData.update для обновления буфера массива,
в противном случае это может вернуть устаревшие значения цвета, или, что хуже, - выбросить исключение во время выполнения, так как он пытается получить доступ к элементу массива, которого не существует.
Обратите внимание, что на системах с порядком байтов little-endian формат — 0xAABBGGRR, а на системах с порядком байтов big-endian — 0xRRGGBBAA.

Параметры
Имя Тип Описание
x number

Координата x пикселя, который нужно установить. Должно лежать в пределах размеров этого BitmapData.

y number

Координата y пикселя, который нужно установить. Должно лежать в пределах размеров этого BitmapData.

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

Целое число с кодом цвета (формат: 0xAARRGGBB)

Исходный код: gameobjects/BitmapData.js (Строка 1016)

getPixelRGB(x, y, out, hsl, hsv) → {object}

Получить цвет определенного пикселя, включая значение альфа-канала, как объект цвета, содержащий свойства r, g, b, a и rgba.
Если вы что-то нарисовали на BitmapData после его создания, вы должны вызвать BitmapData.update для обновления буфера массива,
иначе это может вернуть устаревшие значения цвета или, что еще хуже, — выбросить ошибку во время выполнения, пытаясь получить доступ к элементу массива, которого не существует.

Parameters
Name Type Argument Default Description
x number

Координата x пикселя, который нужно установить. Должно находиться в пределах размеров этого BitmapData.

y number

Координата y пикселя, который нужно установить. Должно находиться в пределах размеров этого BitmapData.

out object <optional>

Объект, в который будут созданы 3 свойства: r, g и b. Если не указан, будет создан новый объект.

hsl boolean <optional>
false

Также преобразовать значения rgb в hsl?

hsv boolean <optional>
false

Также преобразовать значения rgb в hsv?

Returns
object -

Объект со значениями красного, зеленого и синего цветов, установленным в свойствах r, g и b.

Source code: gameobjects/BitmapData.js (Строка 1036)

getPixels(rect) → {ImageData}

Получить все пиксели из области, указанной заданным объектом Rectangle.

Parameters
Name Type Description
rect Phaser.Rectangle

Область Rectangle для получения.

Returns
ImageData -

Возвращает объект ImageData, содержащий свойство data типа Uint8ClampedArray.

Source code: gameobjects/BitmapData.js (Строка 1055)

line(x1, y1, x2, y2, color, width) → {Phaser.BitmapData}

Рисует линию между заданными координатами в указанном цвете и толщине.

Parameters
Name Type Argument Default Description
x1 number

Координата x для начала линии.

y1 number

Координата y для начала линии.

x2 number

Координата x для окончания линии.

y2 number

Координата y для окончания линии.

color string <optional>
'#fff'

Цвет линии.

width number <optional>
1

Толщина линии.

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Строка 1920)

load(source) → {Phaser.BitmapData}

Принимает заданный объект Game Object, изменяет размеры этого BitmapData для соответствия ему, а затем рисует его в холст BitmapDatas, готовый к дальнейшей обработке.
Исходный объект игры не изменяется этим действием.
Если исходный объект использует текстуру в качестве части Texture Atlas или Sprite Sheet, будет использована только текущая рамка для определения размера.
Если указана строка, предполагается, что это ключ к кешу, и будет просмотрен Phaser.Cache для поиска изображения с ключом, соответствующим строке.

Parameters
Name Type Description
source Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapData | Image | HTMLCanvasElement | string

Объект, который будет использован для заполнения этого BitmapData. Если вы передаёте строку, он сначала попытается найти изображение в Game.Cache.

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Строка 422)

move(x, y, wrap) → {Phaser.BitmapData}

Сдвигает содержимое этого BitmapData на заданные расстояния.

Изображение будет перематываться по краям со всех сторон, если аргумент wrap имеет значение true (по умолчанию).

Parameters
Name Type Argument Default Description
x integer

Количество пикселей для горизонтального сдвига холста. Используйте отрицательное значение для сдвига влево, положительное — вправо.

y integer

Количество пикселей для вертикального сдвига холста. Используйте отрицательное значение для сдвига вверх, положительное — вниз.

wrap boolean <optional>
true

Перемотать содержимое BitmapData.

Returns
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Source code: gameobjects/BitmapData.js (Строка 240)

moveH(distance, wrap) → {Phaser.BitmapData}

Горизонтально смещает содержимое этого BitmapData.

Изображение будет перематываться по сторонам, если аргумент wrap имеет значение true (по умолчанию).

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
distance integer

Количество пикселей для горизонтального смещения холста. Используйте отрицательное значение для смещения влево, положительное - вправо.

wrap boolean <optional>
true

Обернуть содержимое BitmapData.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 267)

moveV(distance, wrap) → {Phaser.BitmapData}

Смещает содержимое BitmapData по вертикали.

Изображение будет циклически повторяться по краям, если аргумент wrap равен true (по умолчанию).

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
distance integer

Количество пикселей для вертикального смещения холста. Используйте отрицательное значение для смещения вверх, положительное - для смещения вниз.

wrap boolean <optional>
true

Обернуть содержимое BitmapData.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 330)

processPixel(callback, callbackContext, x, y, width, height) → {Phaser.BitmapData}

Просматривает область, указанную в BitmapData, и отправляет цвет каждого пикселя в заданный обратный вызов вместе с его координатами x и y.
Значение, возвращаемое обратным вызовом, устанавливается как новый цвет для этого пикселя, если он не вернёт тот же цвет, в этом случае он пропускается.
Обратите внимание, что формат полученного цвета будет отличаться в зависимости от того, является ли система big-endian или little-endian.
Ожидается, что ваш обратный вызов будет обрабатывать порядок байтов. Если вы хотите, чтобы это делал Phaser, используйте processPixelRGB.
Обратный вызов также получит координаты пикселя x и y соответственно.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
callback function

Обратный вызов, которому будет отправлен каждый цвет пикселя для обработки.

callbackContext object

Контекст, в котором будет вызван обратный вызов.

x number <optional>
0

Координата x верхнего левого угла области для обработки.

y number <optional>
0

Координата y верхнего левого угла области для обработки.

width number <optional>

Ширина области для обработки.

height number <optional>

Высота области для обработки.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 700)

processPixelRGB(callback, callbackContext, x, y, width, height) → {Phaser.BitmapData}

Просматривает область, указанную в BitmapData, и отправляет объект цвета для каждого пикселя в заданный обратный вызов.
Обратный вызов получит объект цвета со 6 свойствами: { r: number, g: number, b: number, a: number, color: number, rgba: string }.
Где r, g, b и a — целые числа от 0 до 255, представляющие значения компонентов цвета для красного, зеленого, синего и альфа-канала.
Свойство color — Int32 полного цвета. Обратите внимание, что порядок байтов этого свойства будет меняться в зависимости от системы.
Свойство rgba — строка CSS rgba(), которую можно использовать с вызовами context.fillStyle и другими.
Обратный вызов также получит координаты пикселя x и y соответственно.
Обратный вызов должен вернуть либо false, в этом случае изменения пикселя не будут внесены, либо новый объект цвета.
Если возвращается новый объект цвета, пиксель будет установлен на значения r, g, b и a, указанные в нём.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
callback function

Обратный вызов, которому будет отправлен каждый объект цвета пикселя для обработки.

callbackContext object

Контекст, в котором будет вызван обратный вызов.

x number <optional>
0

Координата x верхнего левого угла области для обработки.

y number <optional>
0

Координата y верхнего левого угла области для обработки.

width number <optional>

Ширина области для обработки.

height number <optional>

Высота области для обработки.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 642)

rect(x, y, width, height, fillStyle) → {Phaser.BitmapData}

Рисует заполненный прямоугольник в BitmapData по заданным координатам x, y и ширине/высоте.

Параметры
Имя Тип Аргумент Описание
x число

Координата x левого верхнего угла прямоугольника.

y число

Координата y левого верхнего угла прямоугольника.

width число

Ширина прямоугольника.

height число

Высота прямоугольника.

fillStyle строка <необязательно>

Если задано, свойство fillStyle контекста будет установлено в это значение перед отрисовкой прямоугольника.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1825)

render() → {Phaser.BitmapData}

Если игра запущена в WebGL, это запустит текстуру в GPU, если она загрязнена.
Это вызывается автоматически, если BitmapData используется спрайтом, иначе нужно помнить о вызове в функции render.
Если вы хотите подавить эту функциональность, установите BitmapData.disableTextureUpload в true.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 2004)

replaceRGB(r1, g1, b1, a1, r2, g2, b2, a2, region) → {Phaser.BitmapData}

Заменяет все пиксели, соответствующие одному цвету, другим. Значения цветов задаются двумя наборами значений RGBA.
Необязательный параметр region управляет, происходит ли замена только в определенной области BitmapData или во всей BitmapData.

Параметры
Имя Тип Аргумент Описание
r1 число

Красный цвет для замены. От 0 до 255.

g1 число

Зеленый цвет для замены. От 0 до 255.

b1 число

Синий цвет для замены. От 0 до 255.

a1 число

Альфа-значение цвета для замены. От 0 до 255.

r2 число

Красный цвет для замены. От 0 до 255.

g2 число

Зеленый цвет для замены. От 0 до 255.

b2 число

Синий цвет для замены. От 0 до 255.

a2 число

Альфа-значение цвета для замены. От 0 до 255.

region Phaser.Rectangle <необязательно>

Область для поиска. Если не указана, замена выполняется во всей BitmapData.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 754)

resize(width, height) → {Phaser.BitmapData}

Изменяет размер BitmapData. Это изменяет размер базовой области canvas и обновляет буфер.

Параметры
Имя Тип Описание
width целое число

Новая ширина BitmapData.

height целое число

Новая высота BitmapData.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 552)

setHSL(h, s, l, region) → {Phaser.BitmapData}

Устанавливает значения цветового тона, насыщенности и светлоты для каждого пикселя в заданной области или во всей BitmapData, если область не указана.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
h число <необязательно>
null

Цветовой тон в диапазоне 0 - 1.

s число <необязательно>
null

Насыщенность в диапазоне 0 - 1.

l число <необязательно>
null

Светлота в диапазоне 0 - 1.

region Phaser.Rectangle <необязательно>

Область для выполнения операции. Если не указана, операция выполняется по всей BitmapData.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 804)

setPixel(x, y, red, green, blue, immediate) → {Phaser.BitmapData}

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

Параметры
Имя Тип Аргумент По умолчанию Описание
x число

Координата x пикселя, который нужно установить. Должна находиться в пределах размеров этого BitmapData.

y число

Координата y пикселя, который нужно установить. Должна находиться в пределах размеров этого BitmapData.

red число

Значение красного цвета, от 0 до 0xFF (255).

green число

Значение зеленого цвета, от 0 до 0xFF (255).

blue число

Значение синего цвета, от 0 до 0xFF (255).

immediate логическое <необязательно>
true

Если true будет вызван context.putImageData и установлен флаг dirty.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 967)

setPixel32(x, y, red, green, blue, alpha, immediate) → {Phaser.BitmapData}

Устанавливает цвет заданного пикселя в соответствии со значениями красного, зеленого, синего и альфа-каналов.

Параметры
Имя Тип Аргумент По умолчанию Описание
x число

Координата x пикселя, который нужно установить. Должна находиться в пределах размеров этого BitmapData.

y число

Координата y пикселя, который нужно установить. Должна находиться в пределах размеров этого BitmapData.

red число

Значение красного цвета, от 0 до 0xFF (255).

green число

Значение зеленого цвета, от 0 до 0xFF (255).

blue число

Значение синего цвета, от 0 до 0xFF (255).

alpha число

Значение альфа-канала, от 0 до 0xFF (255).

immediate логическое <необязательно>
true

Если true будет вызван context.putImageData и установлен флаг dirty.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 928)

shadow(color, blur, x, y) → {Phaser.BitmapData}

Устанавливает свойства тени для контекста этого BitmapData, которые будут влиять на все операции рисования, выполненные для него.
Вы можете отменить существующую тень, вызвав этот метод без параметров.
Примечание: На момент написания (октябрь 2014 года) Chrome все еще не поддерживает shadowBlur, используемый с drawImage.

Параметры
Имя Тип Аргумент По умолчанию Описание
color строка

Цвет тени в формате CSS, например #000000 или rgba(0,0,0,1). Если null или undefined, тень будет сброшена.

blur число <необязательно>
5

Степень размытия тени. Низкие значения = четкая тень, высокие значения = более мягкая тень.

x число <необязательно>
10

Горизонтальное смещение тени в пикселях.

y число <необязательно>
10

Вертикальное смещение тени в пикселях.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1706)

shiftHSL(h, s, l, region) → {Phaser.BitmapData}

Изменяет значения оттенка, насыщенности и светлоты каждого пикселя в заданной области или во всем BitmapData, если область не указана.
Изменение добавляет заданное значение к текущим значениям h, s и l, а не заменяет их.
Оттенок зацикливается, чтобы оставаться в диапазоне от 0 до 1. Насыщенность и светлота ограничиваются значением 1.

Параметры
Имя Тип Аргумент По умолчанию Описание
h число <необязательно>
null

Величина изменения оттенка.

s число <необязательно>
null

Величина изменения насыщенности.

l число <необязательно>
null

Величина изменения светлоты.

region Phaser.Rectangle <необязательно>

Область, в которой выполнить операцию. Если не указана, операция выполняется для всего BitmapData.

Возвращает
Phaser.BitmapData -

Этот объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 865)

text(text, x, y, font, color, shadow) → {Phaser.BitmapData}

Рисует текст на BitmapData с заданным шрифтом и цветом.
По умолчанию шрифт — 14px Courier, что удобно для быстрого рисования отладочного текста.
Если вам нужно много работы со шрифтами для этого BitmapData, рекомендуется реализовать собственный метод рисования текста.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
text string

Текст, который нужно записать в BitmapData.

x число

Координата x верхнего левого угла строчки текста.

y число

Координата y верхнего левого угла строчки текста.

font string <optional>
'14px Courier'

Шрифт. Передаётся напрямую в Context.font, поэтому поддерживаются любые шрифты.

color string <optional>
'rgb(255,255,255)'

Цвет текста.

shadow boolean <optional>
true

Отобразить тень одного пикселя чёрного цвета под текстом (смещение на text.x/y + 1)

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1849)

textureLine(line, image, repeat) → {Phaser.BitmapData}

Принимает заданный объект Line и изображение и отрисовывает его в BitmapData как повторяющуюся линию текстуры.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
line Phaser.Line

Объект Phaser.Line, который будет использоваться для определения начала и конца линии.

image string | Image

Ключ изображения в Phaser.Cache, используемый в качестве текстуры для этой линии, или само изображение.

repeat string <optional>
'repeat-x'

Режим повторения узора при отрисовке линии. Может быть repeat, repeat-x или no-repeat.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 1954)

update(x, y, width, height) → {Phaser.BitmapData}

Пересоздаёт BitmapData.imageData из текущего контекста.
Затем перестраивает ArrayBuffer, ссылку на данные Uint8ClampedArray и массив пикселей Int32Array.
Если не заданы, размеры по умолчанию соответствуют полному размеру контекста.

Предупреждение: это очень ресурсоёмкая операция, используйте её экономно.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
x число <optional>
0

Координата x верхнего левого угла области данных изображения, которую нужно извлечь.

y число <optional>
0

Координата y верхнего левого угла области данных изображения, которую нужно извлечь.

width число <optional>
1

Ширина области данных изображения.

height число <optional>
1

Высота области данных изображения.

Возвращаемое значение
Phaser.BitmapData -

Объект BitmapData для цепочки методов.

Исходный код: gameobjects/BitmapData.js (Строка 596)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.BitmapData.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API