gm-tools

Friendly tools for interacting with GraphicsMagick.

:cloud: Installation

# Using npm
npm install --save gm-tools

# Using yarn
yarn add gm-tools

:clipboard: Example

const gmTools = require("gm-tools");

let img = gmTools(__dirname + "/octocat.jpg");

// Get all the pixels
img.pixels((err, pixels) => {
    console.log(err || pixels);
    // [ PixelClass { r: 34, g: 30, b: 31, a: 2.55 },
    //   PixelClass { r: 34, g: 30, b: 31, a: 2.55 },
    //   PixelClass { r: 34, g: 30, b: 31, a: 2.55 },
    //   ...
    //   PixelClass { r: 241, g: 241, b: 243, a: 2.55 },
    //   ...
    //   PixelClass { r: 191, g: 189, b: 190, a: 2.55 },
    //   PixelClass { r: 195, g: 191, b: 192, a: 2.55 },
    //   PixelClass { r: 92, g: 90, b: 91, a: 2.55 },
    //   PixelClass { r: 32, g: 30, b: 31, a: 2.55 },
    //   PixelClass { r: 32, g: 30, b: 31, a: 2.55 },
    //   ...
    //   PixelClass { r: 34, g: 30, b: 31, a: 2.55 } ]
});

// Get pixel at given coordinates
img.getPixel(0, 0, (err, pixel) => {
    console.log(err || pixel);
    // PixelClass { r: 34, g: 30, b: 31, a: 2.55 }
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

GmParser(input, cb)

Creates a new instance of GmParser.

Params

• String|Buffer|GraphicsMagick input: The path to an image file, the image buffer or an existing GraphicsMagick object.
• Function cb: The callback function.

resize(width, height)

Resizes the image.

Params

• Number width: The size width.
• Number height: The size height.

parse(cb)

Parses the image internally.

Params

• Function cb: The callback function.

getSize(cb)

Gets the image size. This appends the width and height functions to the GmParser instance that return the width and height of the image.

Params

• Function cb: The callback function.

toPNGBuffer(cb)

Converts the image into a buffer that is parsed by pngjs.

Params

• Function cb: The callback function.

pixels(buffer, cb)

Gets all the image pixels.

Params

• Buffer buffer: An optional pngjs buffer. If provided, the pixels array will be returned.
• Function cb: The callback function.

Return

• Array An array of pixels (only if the buffer argument is provided).

getPixel(x, y, buffer, cb)

Gets the pixel data at given coordinates.

Params

• Number x: The x coordinate.
• Number y: The y coordinate.
• Buffer buffer: An optional pngjs buffer. If provided, the pixels array will be returned.
• Function cb: The callback function.

Return

• Pixel A Pixel instance. This will be returned only if the buffer argument is provided.

gmTools(input, cb)

Friendly tools for interacting with graphicsmagick

Params

• String|Buffer|GraphicsMagick input: The path to an image file, the image buffer or an existing GraphicsMagick object.
• Function cb: The callback function.

Return

• GmParser The GmParser instance.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• image-parser

:scroll: License

MIT © Ionică Bizău