https://github.com/devinmcgloin/clr
clr is a go library to manage different color spaces, convert between them and compare colors.
https://github.com/devinmcgloin/clr
cielab clr color golang golang-library hex hsv srgb
Last synced: 6 months ago
JSON representation
clr is a go library to manage different color spaces, convert between them and compare colors.
- Host: GitHub
- URL: https://github.com/devinmcgloin/clr
- Owner: devinmcgloin
- License: mit
- Created: 2017-06-27T23:16:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-09-28T20:01:05.000Z (almost 7 years ago)
- Last Synced: 2025-08-14T02:57:11.978Z (11 months ago)
- Topics: cielab, clr, color, golang, golang-library, hex, hsv, srgb
- Language: Go
- Homepage: https://devinmcgloin.com/clr/
- Size: 43.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clr
[](https://travis-ci.org/devinmcgloin/clr)
clr is a go library to manage different color spaces, convert between them and
compare colors.
clr currently supports sRGB HSV, and Hex types, with conversions to sRGB, Hex, HSV,
HSL, CMYK, XYZ and CIE-Lab for each.
Comparisons are done in CIE-Lab using Delta E*. I may add more comparison
options in the future, but for now Delta E* performs well enough.
Given a mapping from Hex to color names you can find the nearest color visually
in the mapping from any given color. Data for these mappings is up to you to
provide by implementing `ColorTable`.
There is also a CLI tool to explore the package called `clr`.
```
$ clr --hex "#0c6624"
&{Code:0c6624}
sRGB: 12 102 36
HSL: 136 78 22
HSV: 136 88 40
CMYK: 88 0 64 60
HEX: 0c6624
Generic Color: Green
Specific Color: Camarone
```
## API
clr is based on two primitives `Color` and `ColorTable`. `Color` has three
backing types currently, Hex, RGB, and HSV. You can add your own types by
implementing the `Color` interface.
```golang
type Color interface {
Valid() bool
RGB() (int, int, int)
HSL() (int, int, int)
HSV() (int, int, int)
CMYK() (int, int, int, int)
XYZ() (float64, float64, float64)
CIELAB() (l, a, b float64)
Hex() string
ColorName(colors ColorTable) ColorSpace
Distance(c Color) float64
RGBA() (r, g, b, a uint32)
}
```
clr also contains functionality for finding the closest color name to a given
color. This requires an instance of ColorTable, which provides the possible
color matches. clr matches to the closest color in CIELAB.
```golang
type ColorTable interface {
Iterate() []Color
Lookup(hexCode string) ColorSpace
}
```