Class ImageUtil

java.lang.Object
com.twelvemonkeys.image.ImageUtil
public final class ImageUtil extends Object
This class contains methods for basic image manipulation and conversion.
Version:
$Id: common/common-image/src/main/java/com/twelvemonkeys/image/ImageUtil.java#3 $

  • Field Details

  • Constructor Details

    • ImageUtil

      private ImageUtil()
      Creates an ImageUtil. Private constructor.

  • Method Details

    • getDefaultGraphicsConfiguration

      private static GraphicsConfiguration getDefaultGraphicsConfiguration()

    • toBuffered

      public static BufferedImage toBuffered(RenderedImage pOriginal)
      Converts the RenderedImage to a BufferedImage. The new image will have the same ColorModel, Raster and properties as the original image, if possible.

      If the image is already a BufferedImage, it is simply returned and no conversion takes place.

      Parameters:
      pOriginal - the image to convert.
      Returns:
      a BufferedImage

    • toBuffered

      public static BufferedImage toBuffered(RenderedImage pOriginal, int pType)
      Converts the RenderedImage to a BufferedImage of the given type.

      If the image is already a BufferedImage of the given type, it is simply returned and no conversion takes place.

      Parameters:
      pOriginal - the image to convert.
      pType - the type of buffered image
      Returns:
      a BufferedImage
      Throws:
      IllegalArgumentException - if pOriginal == null or pType is not a valid type for BufferedImage
      See Also:

    • toBuffered

      public static BufferedImage toBuffered(BufferedImage pOriginal, int pType)
      Converts the BufferedImage to a BufferedImage of the given type. The new image will have the same ColorModel, Raster and properties as the original image, if possible.

      If the image is already a BufferedImage of the given type, it is simply returned and no conversion takes place.

      This method simply invokes toBuffered((RenderedImage) pOriginal, pType).

      Parameters:
      pOriginal - the image to convert.
      pType - the type of buffered image
      Returns:
      a BufferedImage
      Throws:
      IllegalArgumentException - if pOriginal == null or if pType is not a valid type for BufferedImage
      See Also:

    • toBuffered

      public static BufferedImage toBuffered(Image pOriginal)
      Converts the Image to a BufferedImage. The new image will have the same ColorModel, Raster and properties as the original image, if possible.

      If the image is already a BufferedImage, it is simply returned and no conversion takes place.

      Parameters:
      pOriginal - the image to convert.
      Returns:
      a BufferedImage
      Throws:
      IllegalArgumentException - if pOriginal == null
      ImageConversionException - if the image cannot be converted

    • createCopy

      public static BufferedImage createCopy(BufferedImage pImage)
      Creates a deep copy of the given image. The image will have the same color model and raster type, but will not share image (pixel) data with the input image.
      Parameters:
      pImage - the image to clone.
      Returns:
      a new BufferedImage
      Throws:
      IllegalArgumentException - if pImage is null

    • createRaster

      static WritableRaster createRaster(int pWidth, int pHeight, Object pPixels, ColorModel pColorModel)
      Creates a WritableRaster for the given ColorModel and pixel data.

      This method is optimized for the most common cases of ColorModel and pixel data combinations. The raster's backing DataBuffer is created directly from the pixel data, as this is faster and more resource-friendly than using ColorModel.createCompatibleWritableRaster(w, h).

      For uncommon combinations, the method will fallback to using ColorModel.createCompatibleWritableRaster(w, h) and WritableRaster.setDataElements(w, h, pixels)

      Note that the ColorModel and pixel data are not cloned (in most cases).

      Parameters:
      pWidth - the requested raster width
      pHeight - the requested raster height
      pPixels - the pixels, as an array, of a type supported by the different DataBuffer
      pColorModel - the color model to use
      Returns:
      a new WritableRaster
      Throws:
      NullPointerException - if either pColorModel or pPixels are null.
      RuntimeException - if pWidth and pHeight does not match the pixel data in pPixels.
      See Also:

    • isIndexedPacked

      private static boolean isIndexedPacked(IndexColorModel pColorModel)

    • createCompatibleWritableRaster

      static WritableRaster createCompatibleWritableRaster(BufferedImage pOriginal, ColorModel pModel, int width, int height)
      Workaround for bug: TYPE_3BYTE_BGR, TYPE_4BYTE_ABGR and TYPE_4BYTE_ABGR_PRE are all converted to TYPE_CUSTOM when using the default createCompatibleWritableRaster from ComponentColorModel.
      Parameters:
      pOriginal - the orignal image
      pModel - the original color model
      width - the requested width of the raster
      height - the requested height of the raster
      Returns:
      a new WritableRaster

    • toBuffered

      public static BufferedImage toBuffered(Image pOriginal, int pType)
      Converts the Image to a BufferedImage of the given type. The new image will have the same ColorModel, Raster and properties as the original image, if possible.

      If the image is already a BufferedImage of the given type, it is simply returned and no conversion takes place.

      Parameters:
      pOriginal - the image to convert.
      pType - the type of buffered image
      Returns:
      a BufferedImage
      Throws:
      IllegalArgumentException - if pOriginal == null or if pType is not a valid type for BufferedImage
      See Also:

    • toBuffered

      private static BufferedImage toBuffered(Image pOriginal, int pType, IndexColorModel pICM)
      Parameters:
      pOriginal - the original image
      pType - the type of BufferedImage to create
      pICM - the optional IndexColorModel to use. If not null the pType must be compatible with the color model
      Returns:
      a BufferedImage
      Throws:
      IllegalArgumentException - if pType is not compatible with the color model

    • drawOnto

      static void drawOnto(BufferedImage pDestination, Image pSource)
      Draws the source image onto the buffered image, using AlphaComposite.Src and coordinates 0, 0.
      Parameters:
      pDestination - the image to draw on
      pSource - the source image to draw
      Throws:
      NullPointerException - if pDestination or pSource is null

    • createFlipped

      public static BufferedImage createFlipped(Image pImage, int pAxis)
      Creates a flipped version of the given image.
      Parameters:
      pImage - the image to flip
      pAxis - the axis to flip around
      Returns:
      a new BufferedImage

    • createRotated

      public static BufferedImage createRotated(Image pImage, int pDirection)
      Rotates the image 90 degrees, clockwise (aka "rotate right"), counter-clockwise (aka "rotate left") or 180 degrees, depending on the pDirection argument.

      The new image will be completely covered with pixels from the source image.

      Parameters:
      pImage - the source image.
      pDirection - the direction, must be either ROTATE_90_CW, ROTATE_90_CCW or ROTATE_180
      Returns:
      a new BufferedImage

    • createRotated

      public static BufferedImage createRotated(Image pImage, double pAngle)
      Rotates the image to the given angle. Areas not covered with pixels from the source image will be left transparent, if possible.
      Parameters:
      pImage - the source image
      pAngle - the angle of rotation, in radians
      Returns:
      a new BufferedImage, unless pAngle == 0.0

    • createRotated0

      private static BufferedImage createRotated0(BufferedImage pSource, double pAngle)

    • createScaled

      public static BufferedImage createScaled(Image pImage, int pWidth, int pHeight, int pHints)
      Creates a scaled instance of the given Image, and converts it to a BufferedImage if needed. If the original image is a BufferedImage the result will have same type and color model. Note that this implies overhead, and is probably not useful for anything but IndexColorModel images.
      Parameters:
      pImage - the Image to scale
      pWidth - width in pixels
      pHeight - height in pixels
      pHints - scaling ints
      Returns:
      a BufferedImage
      Throws:
      NullPointerException - if pImage is null.
      See Also:

    • equals

      private static boolean equals(ColorModel pLeft, ColorModel pRight)

    • createResampled

      public static BufferedImage createResampled(Image pImage, int pWidth, int pHeight, int pHints)
      Creates a scaled instance of the given Image, and converts it to a BufferedImage if needed.
      Parameters:
      pImage - the Image to scale
      pWidth - width in pixels
      pHeight - height in pixels
      pHints - scaling mHints
      Returns:
      a BufferedImage
      Throws:
      NullPointerException - if pImage is null.
      See Also:

    • createResampled

      public static BufferedImage createResampled(RenderedImage pImage, int pWidth, int pHeight, int pHints)
      Creates a scaled instance of the given RenderedImage, and converts it to a BufferedImage if needed.
      Parameters:
      pImage - the RenderedImage to scale
      pWidth - width in pixels
      pHeight - height in pixels
      pHints - scaling mHints
      Returns:
      a BufferedImage
      Throws:
      NullPointerException - if pImage is null.
      See Also:

    • createResampled

      public static BufferedImage createResampled(BufferedImage pImage, int pWidth, int pHeight, int pHints)
      Creates a scaled instance of the given BufferedImage.
      Parameters:
      pImage - the BufferedImage to scale
      pWidth - width in pixels
      pHeight - height in pixels
      pHints - scaling mHints
      Returns:
      a BufferedImage
      Throws:
      NullPointerException - if pImage is null.
      See Also:

    • convertAWTHints

      private static int convertAWTHints(int pHints)

    • getIndexColorModel

      public static IndexColorModel getIndexColorModel(Image pImage, int pColors, int pHints)
      Extracts an IndexColorModel from the given image.
      Parameters:
      pImage - the image to get the color model from
      pColors - the maximum number of colors in the resulting color model
      pHints - hints controlling transparency and color selection
      Returns:
      the extracted IndexColorModel
      See Also:

    • createIndexed

      public static BufferedImage createIndexed(Image pImage)
      Creates an indexed version of the given image (a BufferedImage with an IndexColorModel. The resulting image will have a maximum of 256 different colors. Transparent parts of the original will be replaced with solid black. Default (possibly HW accelerated) dither will be used.
      Parameters:
      pImage - the image to convert
      Returns:
      an indexed version of the given image

    • createIndexed

      public static BufferedImage createIndexed(Image pImage, int pColors, Color pMatte, int pHints)
      Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
      Parameters:
      pImage - the image to convert
      pColors - number of colors in the resulting image
      pMatte - color to replace transparent parts of the original.
      pHints - hints controlling dither, transparency and color selection
      Returns:
      an indexed version of the given image
      See Also:

    • createIndexed

      public static BufferedImage createIndexed(Image pImage, IndexColorModel pColors, Color pMatte, int pHints)
      Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
      Parameters:
      pImage - the image to convert
      pColors - the IndexColorModel to be used in the resulting image.
      pMatte - color to replace transparent parts of the original.
      pHints - hints controlling dither, transparency and color selection
      Returns:
      an indexed version of the given image
      See Also:

    • createIndexed

      public static BufferedImage createIndexed(Image pImage, Image pColors, Color pMatte, int pHints)
      Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
      Parameters:
      pImage - the image to convert
      pColors - an Image used to get colors from. If the image is has an IndexColorModel, it will be uesd, otherwise an IndexColorModel is created from the image.
      pMatte - color to replace transparent parts of the original.
      pHints - hints controlling dither, transparency and color selection
      Returns:
      an indexed version of the given image
      See Also:

    • sharpen

      public static BufferedImage sharpen(BufferedImage pOriginal)
      Sharpens an image using a convolution matrix. The sharpen kernel used, is defined by the following 3 by 3 matrix:
      Sharpen Kernel Matrix
      0.0-0.30.0
      -0.32.2-0.3
      0.0-0.30.0

      This is the same result returned as sharpen(pOriginal, 0.3f).

      Parameters:
      pOriginal - the BufferedImage to sharpen
      Returns:
      a new BufferedImage, containing the sharpened image.

    • sharpen

      public static BufferedImage sharpen(BufferedImage pOriginal, float pAmount)
      Sharpens an image using a convolution matrix. The sharpen kernel used, is defined by the following 3 by 3 matrix:
      Sharpen Kernel Matrix
      0.0-pAmount0.0
      -pAmount 4.0 * pAmount + 1.0 -pAmount
      0.0-pAmount0.0
      Parameters:
      pOriginal - the BufferedImage to sharpen
      pAmount - the amount of sharpening
      Returns:
      a BufferedImage, containing the sharpened image.

    • blur

      public static BufferedImage blur(BufferedImage pOriginal)
      Creates a blurred version of the given image.
      Parameters:
      pOriginal - the original image
      Returns:
      a new BufferedImage with a blurred version of the given image

    • blur

      public static BufferedImage blur(BufferedImage pOriginal, float pRadius)
      Creates a blurred version of the given image.
      Parameters:
      pOriginal - the original image
      pRadius - the amount to blur
      Returns:
      a new BufferedImage with a blurred version of the given image

    • makeKernel

      private static Kernel makeKernel(float radius)
      Make a Gaussian blur Kernel.
      Parameters:
      radius - the blur radius
      Returns:
      a new blur Kernel

    • convolve

      public static BufferedImage convolve(BufferedImage pOriginal, Kernel pKernel, int pEdgeOperation)
      Convolves an image, using a convolution matrix.
      Parameters:
      pOriginal - the BufferedImage to sharpen
      pKernel - the kernel
      pEdgeOperation - the edge operation. Must be one of EDGE_NO_OP, EDGE_ZERO_FILL, EDGE_REFLECT or EDGE_WRAP
      Returns:
      a new BufferedImage, containing the sharpened image.

    • addBorder

      private static BufferedImage addBorder(BufferedImage pOriginal, int pBorderX, int pBorderY, int pEdgeOperation)

    • contrast

      public static Image contrast(Image pOriginal)
      Adds contrast
      Parameters:
      pOriginal - the BufferedImage to add contrast to
      Returns:
      an Image, containing the contrasted image.

    • contrast

      public static Image contrast(Image pOriginal, float pAmount)
      Changes the contrast of the image
      Parameters:
      pOriginal - the Image to change
      pAmount - the amount of contrast in the range [-1.0..1.0].
      Returns:
      an Image, containing the contrasted image.

    • brightness

      public static Image brightness(Image pOriginal, float pAmount)
      Changes the brightness of the original image.
      Parameters:
      pOriginal - the Image to change
      pAmount - the amount of brightness in the range [-2.0..2.0].
      Returns:
      an Image

    • grayscale

      public static Image grayscale(Image pOriginal)
      Converts an image to grayscale.
      Parameters:
      pOriginal - the image to convert.
      Returns:
      a new Image, containing the gray image data.
      See Also:

    • filter

      public static Image filter(Image pOriginal, ImageFilter pFilter)
      Filters an image, using the given ImageFilter.
      Parameters:
      pOriginal - the original image
      pFilter - the filter to apply
      Returns:
      the new Image

    • accelerate

      public static BufferedImage accelerate(Image pImage)
      Tries to use H/W-accelerated code for an image for display purposes. Note that transparent parts of the image might be replaced by solid color. Additional image information not used by the current diplay hardware may be discarded, like extra bith depth etc.
      Parameters:
      pImage - any Image
      Returns:
      a BufferedImage

    • accelerate

      public static BufferedImage accelerate(Image pImage, GraphicsConfiguration pConfiguration)
      Tries to use H/W-accelerated code for an image for display purposes. Note that transparent parts of the image might be replaced by solid color. Additional image information not used by the current diplay hardware may be discarded, like extra bith depth etc.
      Parameters:
      pImage - any Image
      pConfiguration - the GraphicsConfiguration to accelerate for
      Returns:
      a BufferedImage

    • accelerate

      static BufferedImage accelerate(Image pImage, Color pBackgroundColor, GraphicsConfiguration pConfiguration)
      Tries to use H/W-accelerated code for an image for display purposes. Note that transparent parts of the image will be replaced by solid color. Additional image information not used by the current diplay hardware may be discarded, like extra bith depth etc.
      Parameters:
      pImage - any Image
      pBackgroundColor - the background color to replace any transparent parts of the image. May be null, in such case the color is undefined.
      pConfiguration - the graphics configuration May be null, in such case the color is undefined.
      Returns:
      a BufferedImage

    • getTransparency

      private static int getTransparency(Image pImage)

    • createTransparent

      public static BufferedImage createTransparent(int pWidth, int pHeight)
      Creates a transparent image.
      Parameters:
      pWidth - the requested width of the image
      pHeight - the requested height of the image
      Returns:
      the new image
      Throws:
      IllegalArgumentException - if pType is not a valid type for BufferedImage

    • createTransparent

      public static BufferedImage createTransparent(int pWidth, int pHeight, int pType)
      Creates a transparent image.
      Parameters:
      pWidth - the requested width of the image
      pHeight - the requested height of the image
      pType - the type of BufferedImage to create
      Returns:
      the new image
      Throws:
      IllegalArgumentException - if pType is not a valid type for BufferedImage
      See Also:

    • createClear

      public static BufferedImage createClear(int pWidth, int pHeight, Color pBackground)
      Creates a clear image with the given background color.
      Parameters:
      pWidth - the requested width of the image
      pHeight - the requested height of the image
      pBackground - the background color. The color may be translucent. May be null, in such case the color is undefined.
      Returns:
      the new image
      Throws:
      IllegalArgumentException - if pType is not a valid type for BufferedImage
      See Also:

    • createClear

      public static BufferedImage createClear(int pWidth, int pHeight, int pType, Color pBackground)
      Creates a clear image with the given background color.
      Parameters:
      pWidth - the width of the image to create
      pHeight - the height of the image to create
      pType - the type of image to create (one of the constants from BufferedImage or BI_TYPE_ANY)
      pBackground - the background color. The color may be translucent. May be null, in such case the color is undefined.
      Returns:
      the new image
      Throws:
      IllegalArgumentException - if pType is not a valid type for BufferedImage
      See Also:

    • createClear

      static BufferedImage createClear(int pWidth, int pHeight, int pType, int pTransparency, Color pBackground, GraphicsConfiguration pConfiguration)

    • createBuffered

      private static BufferedImage createBuffered(int pWidth, int pHeight, int pType, int pTransparency)
      Creates a BufferedImage of the given size and type. If possible, uses accelerated versions of BufferedImage from GraphicsConfiguration.
      Parameters:
      pWidth - the width of the image to create
      pHeight - the height of the image to create
      pType - the type of image to create (one of the constants from BufferedImage or BI_TYPE_ANY)
      pTransparency - the transparency type (from Transparency)
      Returns:
      a BufferedImage

    • createBuffered

      static BufferedImage createBuffered(int pWidth, int pHeight, int pType, int pTransparency, GraphicsConfiguration pConfiguration)

    • getConfiguration

      private static GraphicsConfiguration getConfiguration(GraphicsConfiguration pConfiguration)

    • getImageType

      private static int getImageType(int pType, int pTransparency)

    • supportsAcceleration

      private static boolean supportsAcceleration(GraphicsEnvironment pEnv)
      Tests if the given GraphicsEnvironment supports accelleration
      Parameters:
      pEnv - the environment
      Returns:
      true if the GraphicsEnvironment supports acceleration

    • getWidth

      public static int getWidth(Image pImage)
      Gets the width of an Image. This method has the side-effect of completely loading the image.
      Parameters:
      pImage - an image.
      Returns:
      the width of the image, or -1 if the width could not be determined (i.e. an error occured while waiting for the image to load).

    • getHeight

      public static int getHeight(Image pImage)
      Gets the height of an Image. This method has the side-effect of completely loading the image.
      Parameters:
      pImage - an image.
      Returns:
      the height of the image, or -1 if the height could not be determined (i.e. an error occured while waiting for the image to load).

    • waitForImage

      public static boolean waitForImage(Image pImage)
      Waits for an image to load completely. Will wait forever.
      Parameters:
      pImage - an Image object to wait for.
      Returns:
      true if the image was loaded successfully, false if an error occured, or the wait was interrupted.
      See Also:

    • waitForImage

      public static boolean waitForImage(Image pImage, long pTimeOut)
      Waits for an image to load completely. Will wait the specified time.
      Parameters:
      pImage - an Image object to wait for.
      pTimeOut - the time to wait, in milliseconds.
      Returns:
      true if the image was loaded successfully, false if an error occurred, or the wait was interrupted.
      See Also:

    • waitForImages

      public static boolean waitForImages(Image[] pImages)
      Waits for a number of images to load completely. Will wait forever.
      Parameters:
      pImages - an array of Image objects to wait for.
      Returns:
      true if the images was loaded successfully, false if an error occurred, or the wait was interrupted.
      See Also:

    • waitForImages

      public static boolean waitForImages(Image[] pImages, long pTimeOut)
      Waits for a number of images to load completely. Will wait the specified time.
      Parameters:
      pImages - an array of Image objects to wait for
      pTimeOut - the time to wait, in milliseconds
      Returns:
      true if the images was loaded successfully, false if an error occurred, or the wait was interrupted.

    • hasTransparentPixels

      public static boolean hasTransparentPixels(RenderedImage pImage, boolean pFast)
      Tests whether the image has any transparent or semi-transparent pixels.
      Parameters:
      pImage - the image
      pFast - if true, the method tests maximum 10 x 10 pixels, evenly spaced out in the image.
      Returns:
      true if transparent pixels are found, otherwise false.

    • createTranslucent

      public static Color createTranslucent(Color pColor, int pTransparency)
      Creates a translucent version of the given color.
      Parameters:
      pColor - the original color
      pTransparency - the transparency level (0 - 255)
      Returns:
      a translucent color
      Throws:
      NullPointerException - if pColor is null

    • blend

      static int blend(int pRGB1, int pRGB2)
      Blends two ARGB values half and half, to create a tone in between.
      Parameters:
      pRGB1 - color 1
      pRGB2 - color 2
      Returns:
      the new rgb value

    • blend

      public static Color blend(Color pColor, Color pOther)
      Blends two colors half and half, to create a tone in between.
      Parameters:
      pColor - color 1
      pOther - color 2
      Returns:
      a new Color

    • blend

      public static Color blend(Color pColor, Color pOther, float pBlendFactor)
      Blends two colors, controlled by the blending factor. A factor of 0.0 will return the first color, a factor of 1.0 will return the second.
      Parameters:
      pColor - color 1
      pOther - color 2
      pBlendFactor - [0...1]
      Returns:
      a new Color

    • clamp

      private static int clamp(float f)