Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Socket
Sign inDemoInstall

jimp

Package Overview
Dependencies
Maintainers
1
Versions
281
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jimp - npm Package Compare versions

Comparing version 0.2.22 to 0.2.23

fonts/open-sans/Apache License.txt
fonts/open-sans/open-sans-128-black/open-sans-128-black.fnt
fonts/open-sans/open-sans-128-black/open-sans-128-black.png
fonts/open-sans/open-sans-128-white/open-sans-128-white.fnt
fonts/open-sans/open-sans-128-white/open-sans-128-white.png
fonts/open-sans/open-sans-16-black/open-sans-16-black.fnt
fonts/open-sans/open-sans-16-black/open-sans-16-black.png
fonts/open-sans/open-sans-16-white/open-sans-16-white.fnt
fonts/open-sans/open-sans-16-white/open-sans-16-white.png
fonts/open-sans/open-sans-32-black/open-sans-32-black.fnt
fonts/open-sans/open-sans-32-black/open-sans-32-black.png
fonts/open-sans/open-sans-32-white/open-sans-32-white.fnt
fonts/open-sans/open-sans-32-white/open-sans-32-white.png
fonts/open-sans/open-sans-64-black/open-sans-64-black.fnt
fonts/open-sans/open-sans-64-black/open-sans-64-black.png
fonts/open-sans/open-sans-64-white/open-sans-64-white.fnt
fonts/open-sans/open-sans-64-white/open-sans-64-white.png
fonts/open-sans/open-sans-8-black/open-sans-8-black.fnt
fonts/open-sans/open-sans-8-black/open-sans-8-black.png
fonts/open-sans/open-sans-8-white/open-sans-8-white.fnt
fonts/open-sans/open-sans-8-white/open-sans-8-white.png

8

package.json
{
"name": "jimp",
"version": "0.2.22",
"version": "0.2.23",
"description": "An image processing library written entirely in JavaScript (i.e. zero external or native dependencies).",

@@ -8,3 +8,4 @@ "main": "index.js",

"test": "./test/tests.sh",
"prepublish": "./browser/browserify-build.sh"
"prepublish": "./browser/browserify-build.sh",
"minify-jimp": "uglifyjs browser/tmp.jimp.js --compress warnings=false --mangle -o browser/tmp.jimp.min.js"
},

@@ -32,5 +33,6 @@ "keywords": [

"jpeg-js": "^0.1.2",
"load-bmfont": "^1.2.3",
"mime": "^1.3.4",
"pixelmatch": "^4.0.0",
"pngjs": "^2.1.0",
"pngjs": "2.2.0",
"read-chunk": "^1.0.1",

@@ -37,0 +39,0 @@ "request": "^2.65.0",

138

README.md

@@ -5,4 +5,6 @@ # Jimp #

An image processing library for Node written entirely in JavaScript, with zero external or native dependencies. Install using `npm install --save jimp`.
An image processing library for Node written entirely in JavaScript, with zero external or native dependencies.
Installation: `npm install --save jimp`
Example usage:

@@ -67,37 +69,63 @@

JPEG images with EXIF orientation data will be automatically re-orientated as appropriate.
### Basic methods ###
Once the callback is filed or the promise fulfilled, the following methods can be called on the image:
```js
image.crop( x, y, w, h ); // crop to the given region
image.autocrop(); // automatically crop same-color borders from image (if any)
image.invert(); // invert the image colours
image.flip( horz, vert ); // flip the image horizontally or vertically
image.gaussian( r ); // Gaussian blur the image by r pixels (VERY slow)
image.blur( r ); // fast blur the image by r pixels
image.greyscale(); // remove colour from the image
image.sepia(); // apply a sepia wash to the image
image.opacity( f ); // multiply the alpha channel by each pixel by the factor f, 0 - 1
image.resize( w, h[, mode] ); // resize the image. Jimp.AUTO can be passed as one of the values. Optionally, a resize mode can be passed.
image.scale( f ); // scale the image by the factor f
image.scaleToFit( w, h ); // scale the image to the largest size that fits inside the given width and height
image.rotate( deg[, resize] ); // rotate the image clockwise by a number of degrees. Unless `false` is passed as the second parameter, the image width and height will be resized appropriately.
/* Resize */
image.contain( w, h[, mode] ); // scale the image to the given width and height, some parts of the image may be letter boxed
image.cover( w, h[, mode] ); // scale the image to the given width and height, some parts of the image may be clipped
image.resize( w, h[, mode] ); // resize the image. Jimp.AUTO can be passed as one of the values.
image.scale( f[, mode] ); // scale the image by the factor f
image.scaleToFit( w, h[, mode] ); // scale the image to the largest size that fits inside the given width and height
// An optional resize mode can be passed with all resize methods.
/* Crop */
image.autocrop(); // automatically crop same-color borders from image (if any)
image.crop( x, y, w, h ); // crop to the given region
/* Composing */
image.blit( src, x, y[, srcx, srcy, srcw, srch] );
// blit the image with another Jimp image at x, y, optionally cropped.
image.composite( src, x, y ); // composites another Jimp image over this iamge at x, y
image.brightness( val ); // adjust the brighness by a value -1 to +1
image.contrast( val ); // adjust the contrast by a value -1 to +1
image.posterize( n ); // apply a posterization effect with n level
image.mask( src, x, y ); // masks the image with another Jimp image at x, y using average pixel value
image.dither565(); // ordered dithering of the image and reduce color space to 16-bits (RGB565)
image.cover( w, h ); // scale the image to the given width and height, some parts of the image may be clipped
image.contain( w, h ); // scale the image to the given width and height, some parts of the image may be letter boxed
image.background( hex ); // set the default new pixel colour (e.g. 0xFFFFFFFF or 0x00000000) for by some operations (e.g. image.contain and image.rotate) and when writing formats that don't support alpha channels
image.mirror( horz, vert ); // an alias for flip
image.fade( f ); // an alternative to opacity, fades the image by a factor 0 - 1. 0 will haven no effect. 1 will turn the image
image.opaque(); // set the alpha channel on every pixel to fully opaque
image.clone(); // returns a clone of the image
// blit the image with another Jimp image at x, y, optionally cropped.
image.composite( src, x, y ); // composites another Jimp image over this iamge at x, y
image.mask( src, x, y ); // masks the image with another Jimp image at x, y using average pixel value image.rotate) and when writing formats that don't support alpha channels
/* Flip and rotate */
image.flip( horz, vert ); // flip the image horizontally or vertically
image.mirror( horz, vert ); // an alias for flip
image.rotate( deg[, mode] ); // rotate the image clockwise by a number of degrees. Optionally, a resize mode can be passed. If `false` is passed as the second parameter, the image width and height will not be resized.
// JPEG images with EXIF orientation data will be automatically re-orientated as appropriate.
/* Colour */
image.brightness( val ); // adjust the brighness by a value -1 to +1
image.contrast( val ); // adjust the contrast by a value -1 to +1
image.dither565(); // ordered dithering of the image and reduce color space to 16-bits (RGB565)
image.greyscale(); // remove colour from the image
image.invert(); // invert the image colours
image.normalize(); // normalize the channels in an image
/* Alpha channel */
image.fade( f ); // an alternative to opacity, fades the image by a factor 0 - 1. 0 will haven no effect. 1 will turn the image
image.opacity( f ); // multiply the alpha channel by each pixel by the factor f, 0 - 1
image.opaque(); // set the alpha channel on every pixel to fully opaque
image.background( hex ); // set the default new pixel colour (e.g. 0xFFFFFFFF or 0x00000000) for by some operations (e.g. image.contain and
/* Blurs */
image.gaussian( r ); // Gaussian blur the image by r pixels (VERY slow)
image.blur( r ); // fast blur the image by r pixels
/* Effects */
image.posterize( n ); // apply a posterization effect with n level
image.sepia(); // apply a sepia wash to the image
```
Some of these methods are irreversable, so it can be useful to perform them on a clone of the original image:
```js
image.clone(); // returns a clone of the image
```
(Contributions of more methods are welcome!)

@@ -110,5 +138,5 @@

```js
image.resize(250, 250); // resize the image to 250 x 250
image.resize(Jimp.AUTO, 250); // resize the height to 250 and scale the width accordingly
image.resize(250, Jimp.AUTO); // resize the width to 250 and scale the height accordingly
image.resize(250, 250); // resize the image to 250 x 250
image.resize(Jimp.AUTO, 250); // resize the height to 250 and scale the width accordingly
image.resize(250, Jimp.AUTO); // resize the width to 250 and scale the height accordingly
```

@@ -132,2 +160,40 @@

### Writing text ###
Jimp supports basic typography using BMFont format (.fnt) [bitmap fonts](https://en.wikipedia.org/wiki/Bitmap_fonts):
```js
Jimp.loadFont( path ).then(function (font) { // load font from .fnt file
image.print(font, x, y, str); // print a message on an image
});
Jimp.loadFont( path, cb ); // using a callback pattern
```
BMFont fonts are raster based and fixed in size and colour. Jimp comes with a set of fonts that can be used on images:
```js
Jimp.FONT_SANS_8_BLACK; // Open Sans, 8px, black
Jimp.FONT_SANS_16_BLACK; // Open Sans, 16px, black
Jimp.FONT_SANS_32_BLACK; // Open Sans, 32px, black
Jimp.FONT_SANS_64_BLACK; // Open Sans, 64px, black
Jimp.FONT_SANS_128_BLACK; // Open Sans, 128px, black
Jimp.FONT_SANS_8_WHITE; // Open Sans, 8px, white
Jimp.FONT_SANS_16_WHITE; // Open Sans, 16px, white
Jimp.FONT_SANS_32_WHITE; // Open Sans, 32px, white
Jimp.FONT_SANS_64_WHITE; // Open Sans, 64px, white
Jimp.FONT_SANS_128_WHITE; // Open Sans, 128px, white
```
These can be used as follows:
```js
Jimp.loadFont(Jimp.FONT_SANS_32_BLACK).then(function (font) {
image.print(font, 10, 10, "Hello world!");
});
```
Online tools are also available to convert TTF fonts to BMFont format (e.g. [Littera](http://kvazars.com/littera/)).
## Writing to files and buffers ##

@@ -225,3 +291,3 @@

```js
image.bitmap.data; // a Buffer of the raw bitmap data
image.bitmap.data; // a Buffer of the raw bitmap data
image.bitmap.width; // the width of the image

@@ -260,3 +326,3 @@ image.bitmap.height // the height of the image

```js
image.getPixelColor(x, y); // returns the colour of that pixel e.g. 0xFFFFFFFF
image.getPixelColor(x, y); // returns the colour of that pixel e.g. 0xFFFFFFFF
image.setPixelColor(hex, x, y); // sets the colour of that pixel

@@ -269,3 +335,3 @@ ```

Jimp.rgbaToInt(r, g, b, a); // e.g. converts 255, 255, 255, 255 to 0xFFFFFFFF
Jimp.intToRGBA(hex); // e.g. converts 0xFFFFFFFF to {r: 255, g: 255, b: 255, a:255}
Jimp.intToRGBA(hex); // e.g. converts 0xFFFFFFFF to {r: 255, g: 255, b: 255, a:255}
```

@@ -360,2 +426,2 @@

Jimp is licensed under the MIT license.
Jimp is licensed under the MIT license. Open Sans is licensed under the Apache license.
browser/browserify-build.sh

Sorry, the diff of this file is not supported yet

browser/lib/jimp.js

Sorry, the diff of this file is too big to display

browser/lib/jimp.min.js

Sorry, the diff of this file is too big to display

index.js

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc