![\"Thmclrx\"](\"https://github.com/XadillaX/thmclrx/raw/master/logo.svg\"){kind=logo}
\n\n \n
\n ![](\"https://github.com/XadillaX/vscode-language-viml/raw/master/assets/github_sponsor_btn.png\")
\n
\n A theme color extractor module for Node.js with ❤ and built on the top of Byakuren.\n
\n\n## Algorithm\n\n- Minimum Differ Algorithm\n- Octree Algorithm\n- Mixed Algorithm\n\n## Installation\n\n```shell\n$ npm install --save thmclrx\n```\n\n## API\n\nThere only three API in Node.js now.\n\n### octree\n\n`octree` is to get the theme colors in an octree. The colors are unsertain but fidelity.\n\nThe function is like below:\n\n```javascript\nvar thmclrx = require(\"thmclrx\");\nthmclrx.octree(file, [maxColors], [callback], [frameNumber]);\n```\n\n+ `file`: it could be a local filename, remote url or even an image buffer.\n+ `maxColors`: count of max theme colors you want to extract. Defaults to 256;\n+ `callback`: it should be like `function(err, colors) {}`. Defaults to an empty function;\n+ `frameNumber`: the frame you want to extract. Usually used in `gif`. Defaults to 0.\n\n### minDiff\n\n`minDiff` is to get theme colors in minimum differ algorithm by passing a palette. The result theme colors are certainlly in your palette.\n\n```javascript\nvar thmclrx = require(\"thmclrx\");\nthmclrx.minDiff(file, [palette], [callback], [frameNumber]);\n```\n\n+ `file`: it could be a local filename, remote url or even an image buffer.\n+ `palette`: palette is an array that in the struct of `[ { r: .., g: .., b: .., }, { r: .., g: .., b: .. } ]`. Default palette refers [here](https://github.com/XadillaX/thmclrx/blob/master/lib/default_palette.js).\n+ `callback`: it should be like `function(err, colors) {}`. Defaults to an empty function;\n+ `frameNumber`: the frame you want to extract. Usually used in `gif`. Defaults to 0.\n\n### mixed\n\nUsing `mixed` get the basic fidelity theme colors and then using `minDiff` to standardize the fidelity theme colors to a certain palette.\n\n```javascript\nvar thmclrx = require(\"thmclrx\");\nthmclrx.mixed(file, [firstStepMaxColors], [palette], [callback], [frameNumber]);\n```\n\n+ `file`: same as the two functions above.\n+ `firstStepMaxColors`: same as the `maxColors` in `octreeGet`. Defaults to 256.\n+ `palette`: same as the `palette` in `mindiffGet`. Same default value.\n+ `callback`: same as the two functions above.\n+ `frameNumber`: same as the two functions above.\n\n## C++ API\n\nIf you want to use C++ API directly, you can refer to this.\n\n### getByOctree\n\nThis function is called in `octree` in Node.js API.\n\n```javascript\nvar thmclrx = require(\"thmclrx\").cpp;\nvar colors = thmclrx.getByOctree(pixels, [maxColor]);\n```\n\n+ `pixels`: this is an array in the struct of `[ { r: .., g: .., b: .., }, { r: .., g: .., b: .. } ]`.\n+ `maxColor`: same as the `maxColors` in `octreeGet` of Node.js API. Defaults to 256.\n+ `@return`: this function will return the theme colors.\n\n### getByMinDiff\n\nThis function is called in `minDiff` in Node.js API.\n\n```javascript\nvar thmclrx = require(\"thmclrx\").cpp;\nvar colors = thmclrx.getByMinDiff(pixels, [palette]);\n```\n\n+ `pixels`: this may be same as the `pixels` in `octreeGet` of C++ API. Otherwise, it may be the result of `octreeGet` of C++ API.\n+ `palette`: same as the `palette` in `mindiffGet` of Node.js API. Same default value.\n+ `@return`: this function will return the theme colors.\n\n### getByMixed\n\nThis function is called in `mixed` in Node.js API.\n\n```javascript\nvar thmclrx = require(\"thmclrx\").cpp;\nvar colors = thmclrx.getByMixed(pixels, maxColors, palette);\n```\n\n+ `pixels`: this may be same as the `pixels` in `octreeGet` of C++ API. Otherwise, it may be the result of `octreeGet` of C++ API.\n+ `maxColors`: same as the `maxColors` in `octreeGet` of Node.js API.\n+ `palette`: same as the `palette` in `mindiffGet` of Node.js API.\n+ `@return`: this function will return the theme colors.\n\n## Migrate From 0.x To 1.x\n\nthmclrx 0.x has three APIs which map three APIs in 1.x.\n\n+ octreeGet\n+ mindiffGet\n+ mixGet\n\nIn 1.x, these three APIs still exist but deprecated. They are exactly shallow points of `octree` / `minDiff` and `mixed`.\n\nYou may do nothing but we recommend you to rename the functions you called.\n\nBut if you're using native APIs (C++ APIs), you should read the [new document](#c-api).\n\n## Contribute\n\nIssues and PRs are welcomed!\n\n「雖然我覺得不怎麼可能有人會關注我」\n","readmeFilename":"README.md","users":{"timerui":true,"jackiealex":true}}![](\"http://img.shields.io/npm/v/thmclrx.svg\")
\n ![](\"http://img.shields.io/npm/dm/thmclrx.svg\")
\n