bryt

bryt

Get colors by brightness.

Overview

bryt provides an API for getting all colors for a given brightness. A brightness is represented by an integer between 0 and 255. Some brightnesses have more colors than others.

Determining a color's brightness is a pretty simple calculation, but choosing a color by brightness is not. bryt is essentially a giant lookup table that sorts all 16,581,375 colors. Each color is represented by a 4-byte integer. The raw data is 66,325,500 bytes. bryt packs this data into only 3,085,594 bytes.

bryt sorts every color by brightness and stores them in compressed lookup archives. Secondly, since colors in a specific range are similar, it stores color ranges instead of every actual color. Each file is compressed using brotli.

Yes, this is a large dependency, but it's static. The idea is this package will never change.

Installation

npm install bryt

Examples

Get brightness info.

const bryt = require('bryt');

const info = bryt.getBrightness(128);
console.log(`Brightness ${info.brightness} has ${info.count} colors`);

for (let i = 0; i < info.count; i++) {
	console.log(`Color ${i + 1}) ${info.getColor(i)}`);
}

console.log('All colors:', info.getColors());

Get a specific color by brightness and index.

const color = bryt.getColor(200, 3);

Get all colors for a specific brightness. Note that this is not super performant.

const colors = bryt.getColors(187);
for (const color of colors) {
	console.log(color);
}

Convert a integer color to an RGB array.

const color = bryt.getColor(200, 3);
const [ red, green, blue ] = bryt.toRGB(color);
console.log(`red: ${red}, green: ${green}, blue ${blue}`);

API

getBrightness(brightness)

• brightness (Number): A positive integer between 0 and 255.

Returns Object containing the brightness, count of colors, getColor(idx), and getColors().

getColor(brightness, idx)

• brightness (Number): A positive integer between 0 and 255.

Returns Number as a positive integer.

getColors(brightness)

• brightness (Number): A positive integer between 0 and 255.

Returns Array<Number> containing all colors (as integers).

toRGB(num)

• num (Number): A positive integer to split into red, green, and blue components.

Returns Array<Number>.

License

MIT