node package manager


GD graphics library (libgd) C++ bindings for Node.js


GD graphics library, libgd, C++ bindings for Node.js. This version is the community-maintained official NodeJS node-gd repo. With node-gd you can easily create, manipulate, open and save paletted and true color images from and to a variety of image formats including JPEG, PNG, GIF and BMP.

$ sudo apt-get install libgd2-xpm-dev # libgd
$ npm install node-gd
$ sudo yum install gd-devel
$ npm install node-gd

Using Homebrew

$ brew install gd
$ npm install node-gd

...or using MacPorts

$ sudo port install gd2
$ npm install node-gd

Sorry, will not build on Windows.

There are different flavours of images, of which the main ones are palette-based (up to 256 colors) and true color images (millions of colors). GIFs are always palette-based, PNGs can be both palette-based or true color. JPEGs are always true color images. gd.create() will create a palette-based base image while gd.createTrueColor() will create a true color image.

Full API documentation and more examples can be found in the doc directory.

Since node-gd@1.0.0, gd.create and gd.createTrueColor are async. You will have to modify your code. This means that you should either change all gd.create calls to gd.createSync and gd.createTrueColor to gd.createTrueColorSync or rewrite those call and wrap further calls in a callback.

Example of synchronously creating a rectangular image with a bright green background and in magenta the text "Hello world!"

// Require library 
var gd = require('node-gd');
// Create blank new image in memory 
var img = gd.createSync(200, 80);
// Set background color 
img.colorAllocate(0, 255, 0);
// Set text color 
var txtColor = img.colorAllocate(255, 0, 255);
// Set full path to font file 
var fontPath = '/full/path/to/font.ttf';
// Render string in image 
img.stringFT(txtColor, fontPath, 24, 0, 10, 60, 'Hello world!');
// Write image buffer to disk 
img.savePng('output.png', 1, function(err) {
  if(err) {
    throw err;

Asynchronous example of drawing a red lined hexagon on a black background:

var gd = require('node-gd');
gd.createTrueColor(200,200, function(errorimg) {
  if (error) throw error;
  var points = [
    { x: 100, y: 20 },
    { x: 170, y: 60 },
    { x: 170, y: 140},
    { x: 100, y: 180},
    { x: 30, y: 140},
    { x: 30, y: 60},
    { x: 100, y: 20},
  img.polygon(points, 0xff0000);
  img.bmp('test1.bmp', 0);

Another example:

var gd = require('node-gd');
gd.openFile('/path/to/file.jpg', function(errimg) {
  if (err) {
    throw err;
  img.saveFile('/path/to/newFile.bmp', function(err) {
    if (err) {
      throw err;

Some output functions are synchronous because they are handled by libgd. An example of this is the creation of animated GIFs.

Copyright (c) 2010-2016 the contributors. Apparently since December 27th 2012, node-gd is licensed under an MIT license.

The current version is based on code created by taggon, here the original author's repo, and on the additions by mikesmullin. Porting node-gd to nan and extending the API is done by y-a-v-a, on Twitter as @_y_a_v_a_.