Package Exports
- imgpx
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (imgpx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
imgpx
Get a matrix of pixels of a given image.
☁️ Installation
$ npm i --save imgpx📋 Example
const imgpx = require("imgpx");
imgpx("https://octodex.github.com/images/original.png", {
resize: [400, 400]
}, (err, pixels, img) => {
if (err) { return console.error(err); }
console.log(img.height());
// 400
console.log(pixels.length);
// 400
console.log(pixels[0].length);
// 400
});
imgpx(`${__dirname}/octocat.png`, (err, pixels) => {
console.log(err || pixels);
});
// [ [ PixelClass { r: 0, g: 0, b: 0, a: 0 },
// PixelClass { r: 0, g: 0, b: 0, a: 0 },
// PixelClass { r: 0, g: 0, b: 0, a: 0 },
// ...
// PixelClass { r: 0, g: 0, b: 0, a: 0 } ],
// [ PixelClass { r: 0, g: 0, b: 0, a: 0 },
// PixelClass { r: 0, g: 0, b: 0, a: 0 },
// ...
// PixelClass { r: 0, g: 0, b: 0, a: 0.18 },
// PixelClass { r: 0, g: 0, b: 0, a: 0.12 },
// ...
// PixelClass { r: 0, g: 0, b: 0, a: 0 } ],
// ... ]📝 Documentation
imgpx(source, options, callback)
Params
- String|Buffer|Lwip
source: The image url/path/buffer or the lwip object itself. - Object
options: An object containing: image_type(String): An optional field representing the image type (default: taken from the url/path).resize(Array): An array of two numbers ([width, height]) used to resize the image. If not provided, the image will not be resized.- Function
callback: The callback function.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💰 Donations
Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. 🚀
PayPal donations are appreciated too! Each dollar helps.
Thanks! ❤️
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
image-to-ascii—A Node.JS module that converts images to ASCII art.