FIX: issue #9 - applying css attribs over img ruins the palette function. FIX: issue #3- update README regarding createPalette return val

This commit is contained in:
Lokesh Dhakar
2012-04-23 17:13:05 -04:00
parent 5cf0e60319
commit 79d4c70838
4 changed files with 169 additions and 147 deletions

View File

@@ -1,30 +1,41 @@
# Color Thief
A script for grabbing the dominant color or a representative color palette from an image. Uses javascript and canvas.
#Color Thief
###[See a Demo](http://lokeshdhakar.com/projects/color-thief)
A script for grabbing the dominant color or color palette from an image. Uses javascript and canvas.
###Usage
[See a Demo](http://lokeshdhakar.com/projects/color-thief) | [Read more on my blog](http://lokeshdhakar.com/color-thief)
####Get Dominant Color
##Usage
###Get Dominant Color
```js
getDominantColor(sourceImage)
```
returns {r: num, g: num, b: num}
```js
returns [num, num, num]
```
Uses the median cut algorithm provided by quantize.js to cluster similar
colors and return the base color from the largest cluster.
####Create Palette
###Create Palette
```js
createPalette(sourceImage, colorCount)
```
returns array[ {r: num, g: num, b: num}, {r: num, g: num, b: num}, ...]
```js
returns [ [num, num, num], [num, num, num], ... ]
```
Use the median cut algorithm provided by quantize.js to cluster similar
colors.
BUGGY: Function does not always return the requested amount of colors. It can be +/- 2.
##License
by Lokesh Dhakar | [lokeshdhakar.com](http://www.lokeshdhakar.com) | [twitter.com/lokeshdhakar](http://twitter.com/lokeshdhakar)
###License
Licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/)
Thanks to [jfsiii](https://github.com/jfsiii) for a large number of code improvements and other for submitting issues and fixes.
Licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/)
* Free for use in both personal and commercial projects.
* Attribution requires leaving author name, author homepage link, and the license info intact.