Spec-Zone.ru › Phaser

Класс: Phaser.Color

Конструктор

new Color()

Класс Phaser.Color представляет собой набор статических методов, которые помогают в манипулировании и преобразовании цветов.

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

Общедоступные методы

<static> blendAdd(a, b) → {integer}

Складывает исходный и фоновый цвета и возвращает значение, не превышающее 255.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1058)

<static> blendAverage(a, b) → {integer}

Берёт среднее значение исходного и фонового цветов.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1045)

<static> blendColorBurn(a, b) → {integer}

Затемняет фоновый цвет, отражая исходный цвет.
Рисование белым цветом не производит изменений.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1217)

<static> blendColorDodge(a, b) → {integer}

Усветляет фоновый цвет, отражая исходный цвет.
Рисование чёрным цветом не производит изменений.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1203)

<static> blendDarken(a, b) → {integer}

Выбирает более тёмный из фонового и исходного цветов.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1016)

<static> blendDifference(a, b) → {integer}

Вычитает более тёмный из двух цветов из более светлого.

Рисование белым цветом инвертирует фоновый цвет; рисование чёрным цветом не производит изменений.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1084)

<static> blendExclusion(a, b) → {integer}

Создаёт эффект, похожий на режим Difference, но с меньшим контрастом.
Рисование белым цветом инвертирует фоновый цвет; рисование чёрным цветом не производит изменений.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1127)

<static> blendGlow(a, b) → {integer}

Режим смешивания свечения. Этот режим является вариацией режима отражения с переставленными исходным и фоновым цветами.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1331)

<static> blendHardLight(a, b) → {integer}

Умножает или экранирует цвета в зависимости от исходного значения цвета.

Если исходный цвет светлее 0,5, фон осветляется, как при экранировании;
это полезно для добавления бликов к сцене.

Если исходный цвет темнее 0,5, фон затемняется, как при умножении;
это полезно для добавления теней к сцене.

Степень осветления или затемнения пропорциональна разнице между исходным цветом и 0,5;
если она равна 0,5, фон не изменяется.

Рисование чистым черным или белым цветом дает чистый черный или белый цвет. Эффект похож на освещение фона ярким прожектором.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendHardMix(a, b) → {integer}

Выполняет blendVividLight для исходных и фоновых цветов.
Если результирующий цвет равен 128 или больше, он получает значение 255; если меньше 128, значение 0.
Поэтому все смешанные пиксели имеют значения красного, зеленого и синего каналов либо 0, либо 255.
Это изменяет все пиксели на основные аддитивные цвета (красный, зеленый или синий), белый или черный.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendLighten(a, b) → {integer}

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

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendLinearBurn(a, b) → {integer}

Псевдоним для blendSubtract, он просто суммирует значения двух цветов и вычитает 255.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendLinearDodge(a, b) → {integer}

Псевдоним для blendAdd, он просто суммирует значения двух цветов.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendLinearLight(a, b) → {integer}

Этот режим смешивания сочетает в себе Linear Dodge и Linear Burn (масштабированный так, чтобы нейтральные цвета стали средним серым).
Dodge применяется к значениям верхнего слоя светлее среднего серого, а burn — к более темным значениям.
Вычисление упрощается до суммы нижнего слоя и удвоенного верхнего слоя, вычитая 128. Контраст уменьшается.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendMultiply(a, b) → {integer}

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

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

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

<static> blendNegation(a, b) → {integer}

Режим смешивания отрицания.

Параметры
Имя Тип Описание
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1099)

<static> blendNormal(a, b) → {integer}

Смешивает исходный цвет, игнорируя фон.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 990)

<static> blendOverlay(a, b) → {integer}

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

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1141)

<static> blendPhoenix(a, b) → {integer}

Режим смешивания Phoenix. Вычитает более светлый цвет из более тёмного и добавляет 255, что даёт яркий результат.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1344)

<static> blendPinLight(a, b) → {integer}

Если фоновый цвет (источник света) светлее 50%, используется режим blendDarken, и цвета светлее фонового цвета не изменяются.
Если фоновый цвет темнее 50% серого, цвета светлее смешиваемого цвета заменяются, а цвета темнее смешиваемого цвета не изменяются.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1288)

<static> blendReflect(a, b) → {integer}

Режим смешивания Reflect. Этот режим полезен при добавлении блестящих объектов или светлых зон к изображениям.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1318)

<static> blendScreen(a, b) → {integer}

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

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1112)

<static> blendSoftLight(a, b) → {integer}

Затемняет или осветляет цвета, в зависимости от значения исходного цвета.

Если исходный цвет светлее 0,5, фон осветляется, как если бы он был осветлён;
это полезно для добавления бликов к сцене.

Если исходный цвет темнее 0,5, фон затемняется, как если бы он был затемнён.
Степень осветления или затемнения пропорциональна разнице между исходным цветом и 0,5;
если он равен 0,5, фон не изменяется.

Рисование чистым чёрным или белым цветом создаёт явно более тёмную или светлую область, но не приводит к чисто чёрному или белому.
Эффект похож на свечение рассеянного прожектора на фон.

Параметры
Name Type Description
a integer

Исходный цвет для смешивания, в диапазоне от 1 до 255.

b integer

Фоновый цвет для смешивания, в диапазоне от 1 до 255.

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

Смешанное значение цвета, в диапазоне от 1 до 255.

Source code: utils/Color.js (Line 1156)

<static> blendSubtract(a, b) → {integer}

Объединяет исходные и фоновые цвета и возвращает их значение минус 255.

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

Источник цвета для смешивания, в диапазоне от 1 до 255.

b целое число

Цвет фона для смешивания, в диапазоне от 1 до 255.

Возвращает
целое число -

Значение смешанного цвета, в диапазоне от 1 до 255.

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

<static> blendVividLight(a, b) → {целое число}

Этот режим смешивания сочетает Dodge и Burn (с пересчётом, чтобы нейтральные цвета становились средним серым).
Dodge применяется, когда значения верхнего слоя светлее среднего серого, а burn - для более тёмных значений.
Средний серый - это нейтральный цвет. Когда цвет светлее его, это фактически сдвигает точку белого нижнего
слоя вниз на удвоенное значение разницы; когда он темнее, точка чёрного сдвигается вверх на удвоенное значение разницы. Воспринимаемый контраст увеличивается.

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

Источник цвета для смешивания, в диапазоне от 1 до 255.

b целое число

Цвет фона для смешивания, в диапазоне от 1 до 255.

Возвращает
целое число -

Значение смешанного цвета, в диапазоне от 1 до 255.

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

<static> componentToHex(color) → {строка}

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

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

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

Возвращает
строка -

Строка длиной 2 символа, например, 255 = ff, 100 = 64.

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

<static> createColor(r, g, b, a, h, s, l, v) → {объект}

Функция-утилита для создания лёгкого объекта "color" с заданными компонентами.
Любые не указанные компоненты будут иметь значение по умолчанию — ноль.

Это полезно, когда нужно использовать общий объект цвета для методов getPixel и getPixelAt.

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

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

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

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

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

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

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

Альфа-компонент цвета, в диапазоне от 0 до 1.

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

Оттенок, в диапазоне от 0 до 1.

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

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

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

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

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

Значение, в диапазоне от 0 до 1.

Возвращает
объект -

Результирующий объект с свойствами r, g, b, a и h, s, l и v.

Автор:
  • Мэтт Деслориерс (@mattdesl)
Исходный код: utils/Color.js (Строка 438)

<static> fromRGBA(rgba, out) → {объект}

Утилита для преобразования целого числа в формате 0xRRGGBBAA в объект цвета.
Это не зависит от порядка байтов.

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

Шестнадцатеричное значение RGBA

out объект <необязательно>

Используемый объект, необязательно.

Возвращает
объект -

Объект цвета.

Автор:
  • Мэтт Деслориерс (@mattdesl)
Исходный код: utils/Color.js (Строка 97)

<static> getAlpha(color) → {число}

Если задано значение цвета (в формате 0xAARRGGBB), возвращается альфа-компонент в диапазоне от 0 до 255.

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

В формате 0xAARRGGBB.

Возвращает
число -

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

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

<static> getAlphaFloat(color) → {число}

Если задано значение цвета (в формате 0xAARRGGBB), возвращается альфа-компонент в диапазоне от 0 до 1.

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

В формате 0xAARRGGBB.

Возвращает
число -

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

Source code: utils/Color.js (Line 942)

<static> getBlue(color) → {number}

Учитывая собственное значение цвета (в формате 0xAARRGGBB), это вернёт компонент синего цвета, как значение от 0 до 255.

Parameters
Name Type Description
color number

В формате 0xAARRGGBB.

Returns
number -

Синий компонент цвета, будет от 0 до 255 (0 - отсутствие цвета, 255 - полный синий).

Source code: utils/Color.js (Line 978)

<static> getColor(r, g, b) → {number}

Учитывая 3 значения цвета, это вернёт целое числовое представление.

Parameters
Name Type Description
r number

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

g number

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

b number

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

Returns
number -

Целое числовое значение цвета (формат: 0xRRGGBB).

Source code: utils/Color.js (Line 500)

<static> getColor32(a, r, g, b) → {number}

Учитывая альфа-канал и 3 значения цвета, это вернёт целое числовое представление.

Parameters
Name Type Description
a number

Альфа-компонент цвета, в диапазоне 0 - 255.

r number

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

g number

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

b number

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

Returns
number -

Целое числовое значение цвета (формат: 0xAARRGGBB).

Source code: utils/Color.js (Line 483)

<static> getGreen(color) → {number}

Учитывая собственное значение цвета (в формате 0xAARRGGBB), это вернёт компонент зелёного цвета, как значение от 0 до 255.

Parameters
Name Type Description
color number

В формате 0xAARRGGBB.

Returns
number -

Зелёный компонент цвета, будет от 0 до 255 (0 - отсутствие цвета, 255 - полный зелёный).

Source code: utils/Color.js (Line 966)

<static> getRandomColor(min, max, alpha) → {number}

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

Parameters
Name Type Argument Default Description
min number <optional>
0

Наименьшее значение для использования цвета.

max number <optional>
255

Наибольшее значение для использования цвета.

alpha number <optional>
255

Альфа-значение возвращаемого цвета (по умолчанию 255 = полностью непрозрачный).

Returns
number -

32-битное значение цвета с альфа-каналом.

Source code: utils/Color.js (Line 834)

<static> getRed(color) → {number}

Учитывая собственное значение цвета (в формате 0xAARRGGBB), это вернёт компонент красного цвета, как значение от 0 до 255.

Parameters
Name Type Description
color number

В формате 0xAARRGGBB.

Returns
number -

Красный компонент цвета, будет от 0 до 255 (0 - отсутствие цвета, 255 - полный красный).

Source code: utils/Color.js (Line 954)

<static> getRGB(color) → {object}

Возвращает составные части цвета как объект со свойствами alpha, red, green, blue.

Alpha будет установлен только в том случае, если он существует в заданном цвете (0xAARRGGBB)

Parameters
Name Type Description
color number

Цвет в формате RGB (0xRRGGBB) или ARGB (0xAARRGGBB).

Returns
object -

Объект со свойствами: alpha, red, green, blue (также r, g, b и a). Alpha будет присутствовать только если было дано значение цвета > 16777215.

Source code: utils/Color.js (Line 866)

<static> getWebRGB(color) → {string}

Возвращает удобное для CSS строковое значение из заданного цвета.

Parameters
Name Type Description
color number | Object

Цвет в формате RGB (0xRRGGBB), ARGB (0xAARRGGBB) или объект со свойствами r, g, b, a.

Returns
string -

Строка в формате: 'rgba(r,g,b,a)'

Source code: utils/Color.js (Line 908)

<static> hexToColor(hex, out) → {object}

Преобразует строку в формате шестнадцатеричного кода в объект цвета Phaser.

Строка шестнадцатеричного кода цвета может быть в формате '#0033ff' или сокращенном формате '#03f'; она может начинаться с необязательного символа "#" или "0x", или быть без префикса.

Канал альфа не поддерживается.

Parameters
Name Type Argument Description
hex string

Строка цвета в формате шестнадцатеричного кода.

out object <optional>

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

Returns
object -

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

Source code: utils/Color.js (Line 564)

<static> hexToRGB(hex) → {number}

Преобразует строку в формате шестнадцатеричного кода в целое числовое значение цвета.

Parameters
Name Type Description
hex string

Строка шестнадцатеричного кода для преобразования. Может быть в сокращённом формате #03f или #0033ff.

Returns
number -

Значение цвета RGB в формате 0xAARRGGBB.

Source code: utils/Color.js (Line 545)

<static> HSLColorWheel(s, l) → {array}

Получить значения цветового круга HSL в массиве, размер которого будет 360 элементов.

Parameters
Name Type Argument Default Description
s number <optional>
0.5

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

l number <optional>
0.5

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

Returns
array -

Массив, содержащий 360 элементов, соответствующих цветовому кругу HSL.

Source code: utils/Color.js (Line 735)

<static> HSLtoRGB(h, s, l, out) → {object}

Преобразует значение цвета HSL (оттенок, насыщенность и светлота) в RGB.
Формула преобразования взята с http://en.wikipedia.org/wiki/HSL_color_space.
Предполагает, что значения HSL находятся в диапазоне [0, 1] и возвращает значения r, g и b в диапазоне [0, 255].
Основано на коде Майкла Джексона (https://github.com/mjijackson)

Parameters
Name Type Argument Description
h number

Оттенок в диапазоне от 0 до 1.

s number

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

l number

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

out object <optional>

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

Returns
object -

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

Source code: utils/Color.js (Line 220)

<static> HSVColorWheel(s, v) → {array}

Получить значения цветового круга HSV в массиве, размер которого будет 360 элементов.

Parameters
Name Type Argument Default Description
s number <optional>
1

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

v number <optional>
1

Значение в диапазоне от 0 до 1.

Returns
array -

Массив, содержащий 360 элементов, соответствующих цветовому кругу HSV.

Source code: utils/Color.js (Line 710)

<static> HSVtoRGB(h, s, v, out) → {object}

Преобразует значение цвета HSV (оттенок, насыщенность и значение) в RGB.
Формула преобразования взята с http://en.wikipedia.org/wiki/HSL_color_space.
Предполагает, что значения HSV находятся в диапазоне [0, 1] и возвращает значения r, g и b в диапазоне [0, 255].
Основано на коде Майкла Джексона (https://github.com/mjijackson)

Parameters
Name Type Argument Description
h number

Оттенок в диапазоне от 0 до 1.

s number

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

v number

Значение в диапазоне от 0 до 1.

out object <optional>

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

Returns
object -

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

Source code: utils/Color.js (Line 327)

<static> hueToColor(p, q, t) → {number}

Преобразует оттенок в цвет RGB.
Основано на коде Майкла Джексона (https://github.com/mjijackson)

Parameters
Имя Тип Описание
p number
q number
t number
Возвращаемое значение
number -

Значение компоненты цвета.

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

<static> interpolateColor(color1, color2, steps, currentStep, alpha) → {number}

Интерполирует два заданных цвета на основе свойств шага и текущего шага.

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

Первое значение цвета.

color2 number

Второе значение цвета.

steps number

Количество шагов для выполнения интерполяции.

currentStep number

Значение currentStep. Если интерполяция займет 100 шагов, значение currentStep, равное 50, будет находиться ровно посередине между двумя.

alpha number

Значение альфа возвращаемого цвета.

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

Значение интерполированного цвета.

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

<static> interpolateColorWithRGB(color, r, g, b, steps, currentStep) → {number}

Интерполирует два заданных цвета на основе свойств шага и текущего шага.

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

Первое значение цвета.

r number

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

g number

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

b number

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

steps number

Количество шагов для выполнения интерполяции.

currentStep number

Значение currentStep. Если интерполяция займет 100 шагов, значение currentStep, равное 50, будет находиться ровно посередине между двумя.

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

Значение интерполированного цвета.

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

<static> interpolateRGB(r1, g1, b1, r2, g2, b2, steps, currentStep) → {number}

Интерполирует два заданных цвета на основе свойств шага и текущего шага.

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

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

g1 number

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

b1 number

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

r2 number

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

g2 number

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

b2 number

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

steps number

Количество шагов для выполнения интерполяции.

currentStep number

Значение currentStep. Если интерполяция займет 100 шагов, значение currentStep, равное 50, будет находиться ровно посередине между двумя.

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

Значение интерполированного цвета.

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

<static> packPixel(r, g, b, a) → {number}

Упаковывает компоненты r, g, b, a в одно целое число для использования с Int32Array.
Если устройство little endian, то используется порядок ABGR. В противном случае используется порядок RGBA.

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

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

g number

Компонента зеленого цвета, в диапазоне 0 - 255.

b number

Компонента синего цвета, в диапазоне 0 - 255.

a number

Компонента альфа цвета, в диапазоне 0 - 255.

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

Упакованный цвет как uint32

Автор:
  • Matt DesLauriers (@mattdesl)
Исходный код: utils/Color.js (Строка 14)

<static> RGBtoHSL(r, g, b, out) → {object}

Преобразует значение RGB цвета в HSL (оттенок, насыщенность и светлота).
Формула преобразования из http://en.wikipedia.org/wiki/HSL_color_space.
Предполагается, что значения RGB находятся в множестве [0, 255], а возвращаемые значения h, s и l в множестве [0, 1].
Основано на коде Майкла Джексона (https://github.com/mjijackson)

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

Компонент красного цвета, в диапазоне от 0 до 255.

g число

Компонент зелёного цвета, в диапазоне от 0 до 255.

b число

Компонент синего цвета, в диапазоне от 0 до 255.

out объект <необязательно>

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

Возвращает
объект -

Объект со значениями оттенка, насыщенности и светлоты, установленные в свойствах h, s и l.

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

<статический> RGBtoHSV(r, g, b, out) → {объект}

Преобразует значение цвета RGB в HSV (оттенок, насыщенность и значение).
Формула преобразования из http://en.wikipedia.org/wiki/HSL_color_space.
Предполагает, что значения RGB находятся в диапазоне [0, 255] и возвращает h, s и v в диапазоне [0, 1].
Основано на коде Майкла Джексона (https://github.com/mjijackson)

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

Компонент красного цвета, в диапазоне от 0 до 255.

g число

Компонент зелёного цвета, в диапазоне от 0 до 255.

b число

Компонент синего цвета, в диапазоне от 0 до 255.

out объект <необязательно>

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

Возвращает
объект -

Объект со значениями оттенка, насыщенности и значения, установленные в свойствах h, s и v.

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

<статический> RGBtoString(r, g, b, a, prefix) → {строка}

Преобразует заданные значения цвета в строку.
Если префикс был '#', то будет в формате #RRGGBB иначе 0xAARRGGBB.

Параметры
...
Имя Тип Аргумент По умолчанию Описание
Возвращает
строка -

Строка, содержащая значения цвета. Если префикс был '#', то будет в формате #RRGGBB иначе 0xAARRGGBB.

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

<статический> toABGR(r, g, b, a) → {число}

Преобразует компоненты RGBA в 32-битовое целое число в формате AABBGGRR.

Параметры
...
Имя Тип Описание
Возвращает
число -

32-битовое целое число, упакованное в RGBA.

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

<статический> toRGBA(r, g, b, a) → {число}

Утилита для преобразования компонентов RGBA в 32-битовое целое число в формате RRGGBBAA.

Параметры
...
Имя Тип Описание
Возвращает
число -

32-битовое целое число, упакованное в RGBA.

Автор:
  • Мэтт ДеСлёриерс (@mattdesl)
Исходный код: utils/Color.js (Строка 126)

<статический> unpackPixel(rgba, out, hsl, hsv) → {объект}

Распаковывает компоненты r, g, b, a в указанный объект цвета или новый
объект для использования с Int32Array. Если используется little endian, то используется порядок ABGR при
распаковке, в противном случае используется порядок RGBA. Результирующий объект цвета имеет
r, g, b, a свойства, которые не зависят от порядка байтов.

Обратите внимание, что целое число предполагается упакованным в правильном порядке байтов. В little-endian
формат — 0xAABBGGRR, а в big-endian — 0xRRGGBBAA. Если вам нужен независимый от порядка байтов метод,
используйте fromRGBA(rgba) и toRGBA(r, g, b, a).

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

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

out объект <необязательно>

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

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

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

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

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

Возвращаемое значение
объект -

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

Автор:
  • Matt DesLauriers (@mattdesl)
Исходный код: utils/Color.js (Строка 40)

<статический> updateColor(out) → {число}

Принимает объект цвета и обновляет свойства rgba, color и color32.

Параметры
Имя Тип Описание
out объект

Объект цвета для обновления.

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

Целое число значения цвета (формат: 0xAARRGGBB).

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

<статический> valueToColor(value, out) → {объект}

Преобразует значение — строку «hex», строку CSS «web» или число — в компоненты красного, зеленого, синего и альфа-каналов.

Значение может быть строкой (см. hexToColor и webToColor для поддерживаемых форматов) или упакованным целым числом (см. getRGB).

Альфа-канал не поддерживается при указании строки hex.

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

Цвет, выраженный в распознаваемом формате строки или упакованном целом числе.

out объект <необязательно>

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

Возвращаемое значение
объект -

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

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

<статический> webToColor(web, out) → {объект}

Преобразует строку CSS 'web' в объект цвета Phaser.

Строка web может быть в формате 'rgb(r,g,b)' или 'rgba(r,g,b,a)' где r/g/b находятся в диапазоне [0..255], а a — в диапазоне [0..1].

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

Строка цвета в формате CSS 'web'.

out объект <необязательно>

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

Возвращаемое значение
объект -

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

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

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

Spec-Zone.ru

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