api documentation for jimp (v0.2.27)

An image processing library written entirely in JavaScript (i.e. zero external or native dependencies).

table of contents

  1. module jimp
    1. function jimp.diff (img1, img2, threshold)
    2. function jimp.distance (img1, img2)
    3. function jimp.intToRGBA (i, cb)
    4. function jimp.limit255 (n)
    5. function jimp.loadFont (file, cb)
    6. function jimp.phash (size, smallerSize)
    7. function jimp.read (src, cb)
    8. function jimp.resize (widthOriginal, heightOriginal, targetWidth, targetHeight, blendAlpha, interpolationPass, resizeCallback)
    9. function jimp.rgbaToInt (r, g, b, a, cb)
    10. number jimp.AUTO
    11. number jimp.HORIZONTAL_ALIGN_CENTER
    12. number jimp.HORIZONTAL_ALIGN_LEFT
    13. number jimp.HORIZONTAL_ALIGN_RIGHT
    14. number jimp.PNG_FILTER_AUTO
    15. number jimp.PNG_FILTER_AVERAGE
    16. number jimp.PNG_FILTER_NONE
    17. number jimp.PNG_FILTER_PAETH
    18. number jimp.PNG_FILTER_SUB
    19. number jimp.PNG_FILTER_UP
    20. number jimp.VERTICAL_ALIGN_BOTTOM
    21. number jimp.VERTICAL_ALIGN_MIDDLE
    22. number jimp.VERTICAL_ALIGN_TOP
    23. object jimp.phash.prototype
    24. object jimp.resize.prototype
    25. object jimp.resize2
    26. string jimp.FONT_SANS_128_BLACK
    27. string jimp.FONT_SANS_128_WHITE
    28. string jimp.FONT_SANS_16_BLACK
    29. string jimp.FONT_SANS_16_WHITE
    30. string jimp.FONT_SANS_32_BLACK
    31. string jimp.FONT_SANS_32_WHITE
    32. string jimp.FONT_SANS_64_BLACK
    33. string jimp.FONT_SANS_64_WHITE
    34. string jimp.FONT_SANS_8_BLACK
    35. string jimp.FONT_SANS_8_WHITE
    36. string jimp.MIME_BMP
    37. string jimp.MIME_JPEG
    38. string jimp.MIME_PNG
    39. string jimp.RESIZE_BEZIER
    40. string jimp.RESIZE_BICUBIC
    41. string jimp.RESIZE_BILINEAR
    42. string jimp.RESIZE_HERMITE
    43. string jimp.RESIZE_NEAREST_NEIGHBOR
  2. module jimp.phash
    1. function jimp.phash (size, smallerSize)
  3. module jimp.phash.prototype
    1. function jimp.phash.prototype.distance (s1, s2)
    2. function jimp.phash.prototype.getHash (img)
    3. number jimp.phash.prototype.size
    4. number jimp.phash.prototype.smallerSize
  4. module jimp.resize
    1. function jimp.resize (widthOriginal, heightOriginal, targetWidth, targetHeight, blendAlpha, interpolationPass, resizeCallback)
  5. module jimp.resize.prototype
    1. function jimp.resize.prototype.bypassResizer (buffer)
    2. function jimp.resize.prototype.configurePasses ()
    3. function jimp.resize.prototype.generateFloatBuffer (bufferLength)
    4. function jimp.resize.prototype.generateUint8Buffer (bufferLength)
    5. function jimp.resize.prototype.initialize ()
    6. function jimp.resize.prototype.initializeFirstPassBuffers (BILINEARAlgo)
    7. function jimp.resize.prototype.initializeSecondPassBuffers (BILINEARAlgo)
    8. function jimp.resize.prototype.resize (buffer)
    9. function jimp.resize.prototype.resizeHeightInterpolated (buffer)
    10. function jimp.resize.prototype.resizeHeightRGB (buffer)
    11. function jimp.resize.prototype.resizeHeightRGBA (buffer)
    12. function jimp.resize.prototype.resizeWidthInterpolatedRGB (buffer)
    13. function jimp.resize.prototype.resizeWidthInterpolatedRGBA (buffer)
    14. function jimp.resize.prototype.resizeWidthRGB (buffer)
    15. function jimp.resize.prototype.resizeWidthRGBA (buffer)
  6. module jimp.resize2
    1. function jimp.resize2._interpolate2D (src, dst, options, interpolate)
    2. function jimp.resize2.bezierInterpolation (src, dst, options)
    3. function jimp.resize2.bicubicInterpolation (src, dst, options)
    4. function jimp.resize2.bilinearInterpolation (src, dst, options)
    5. function jimp.resize2.hermiteInterpolation (src, dst, options)
    6. function jimp.resize2.nearestNeighbor (src, dst, options)

module jimp

function jimp.diff (img1, img2, threshold)

function jimp.distance (img1, img2)

function jimp.intToRGBA (i, cb)

function jimp.limit255 (n)

function jimp.loadFont (file, cb)

function jimp.phash (size, smallerSize)

function jimp.read (src, cb)

function jimp.resize (widthOriginal, heightOriginal, targetWidth, targetHeight, blendAlpha, interpolationPass, resizeCallback)

function jimp.rgbaToInt (r, g, b, a, cb)

module jimp.phash

function jimp.phash (size, smallerSize)

module jimp.phash.prototype

function jimp.phash.prototype.distance (s1, s2)

function jimp.phash.prototype.getHash (img)

module jimp.resize

function jimp.resize (widthOriginal, heightOriginal, targetWidth, targetHeight, blendAlpha, interpolationPass, resizeCallback)

module jimp.resize.prototype

function jimp.resize.prototype.bypassResizer (buffer)

function jimp.resize.prototype.configurePasses ()

function jimp.resize.prototype.generateFloatBuffer (bufferLength)

function jimp.resize.prototype.generateUint8Buffer (bufferLength)

function jimp.resize.prototype.initialize ()

function jimp.resize.prototype.initializeFirstPassBuffers (BILINEARAlgo)

function jimp.resize.prototype.initializeSecondPassBuffers (BILINEARAlgo)

function jimp.resize.prototype.resize (buffer)

function jimp.resize.prototype.resizeHeightInterpolated (buffer)

function jimp.resize.prototype.resizeHeightRGB (buffer)

function jimp.resize.prototype.resizeHeightRGBA (buffer)

function jimp.resize.prototype.resizeWidthInterpolatedRGB (buffer)

function jimp.resize.prototype.resizeWidthInterpolatedRGBA (buffer)

function jimp.resize.prototype.resizeWidthRGB (buffer)

function jimp.resize.prototype.resizeWidthRGBA (buffer)

module jimp.resize2

function jimp.resize2._interpolate2D (src, dst, options, interpolate)

function jimp.resize2.bezierInterpolation (src, dst, options)

function jimp.resize2.bicubicInterpolation (src, dst, options)

function jimp.resize2.bilinearInterpolation (src, dst, options)

function jimp.resize2.hermiteInterpolation (src, dst, options)

function jimp.resize2.nearestNeighbor (src, dst, options)

[ this document was created with utility2 ]