std/colors

Source Edit

Этот модуль реализует обработку цвета для Nim, а именно смешивание цветов и разбор имен цветов CSS.

Импорты

strutils, algorithm

Типы

Color = distinct int: Цвет, хранящийся как RGB, например 0xff00cc. Source Edit

Константы

Прочие функции

proc `$`(c: Color): string {....raises: [], tags: [], forbids: [].}: Преобразует цвет в его текстовое представление.
Пример:

assert $colFuchsia == "#FF00FF"
Исходный код Редактировать
proc `+`(a, b: Color): Color {....raises: [], tags: [], forbids: [].}: Складывает два цвета.

Используется насыщенная арифметика, поэтому каждый компонент цвета не может переполниться (255 используется как максимальное значение).

Пример:

var a = Color(0xaa_00_ff) b = Color(0x11_cc_cc) assert a + b == Color(0xbb_cc_ff)
Исходный код Редактировать
proc `-`(a, b: Color): Color {....raises: [], tags: [], forbids: [].}: Вычитает два цвета.

Используется насыщенная арифметика, поэтому каждый компонент цвета не может стать меньше нуля (0 используется как минимальное значение).

Пример:

var a = Color(0xff_33_ff) b = Color(0x11_ff_cc) assert a - b == Color(0xee_00_33)
Исходный код Редактировать
proc `==`(a, b: Color): bool {.borrow, ...raises: [], tags: [], forbids: [].}: Сравнивает два цвета.

var a = Color(0xff_00_ff) b = colFuchsia c = Color(0x00_ff_cc) assert a == b assert not (a == c)
Исходный код Редактировать
proc extractRGB(a: Color): tuple[r, g, b: range[0 .. 255]] {....raises: [], tags: [], forbids: [].}: Извлекает компоненты красного/зелёного/синего цвета a.
Пример:

var a = Color(0xff_00_ff) b = Color(0x00_ff_cc) type Col = range[0..255] # assert extractRGB(a) == (r: 255.Col, g: 0.Col, b: 255.Col) # assert extractRGB(b) == (r: 0.Col, g: 255.Col, b: 204.Col) echo extractRGB(a) echo typeof(extractRGB(a)) echo extractRGB(b) echo typeof(extractRGB(b))
Исходный код Редактировать
proc intensity(a: Color; f: float): Color {....raises: [], tags: [], forbids: [].}: Возвращает a с интенсивностью f. f должно быть числом с плавающей точкой от 0.0 (полностью тёмный) до 1.0 (полная интенсивность цвета).
Пример:

var a = Color(0xff_00_ff) b = Color(0x00_42_cc) assert a.intensity(0.5) == Color(0x80_00_80) assert b.intensity(0.5) == Color(0x00_21_66)
Исходный код Редактировать
proc isColor(name: string): bool {....raises: [], tags: [], forbids: [].}: Возвращает true, если name является известным именем цвета или шестнадцатеричным цветом, начинающимся с #. Без учета регистра.
Пример:

var a = "silver" b = "#0179fc" c = "#zzmmtt" assert a.isColor assert b.isColor assert not c.isColor
Исходный код Редактировать
proc parseColor(name: string): Color {....raises: [ValueError], tags: [], forbids: [].}: Парсит name в значение цвета.

Если не удалось разобрать допустимый цвет, ValueError поднимается. Без учета регистра.

Пример:

var a = "silver" b = "#0179fc" c = "#zzmmtt" assert parseColor(a) == Color(0xc0_c0_c0) assert parseColor(b) == Color(0x01_79_fc) doAssertRaises(ValueError): discard parseColor(c)
Исходный код Редактировать
proc rgb(r, g, b: range[0 .. 255]): Color {....raises: [], tags: [], forbids: [].}: Создаёт цвет из значений RGB.
Пример:

assert rgb(0, 255, 128) == Color(0x00_ff_80)
Исходный код Редактировать

Шаблоны

template mix(a, b: Color; fn: untyped): untyped: Использует fn для смешивания цветов a и b.

fn вызывается для каждого компонента R, G и B. Если результат fn не находится в range[0..255], он будет насыщен до него.

Пример:

var a = Color(0x0a2814) b = Color(0x050a03) proc myMix(x, y: int): int = 2 * x - 3 * y assert mix(a, b, myMix) == Color(0x05_32_1f)
Исходный код Изменить