com.twelvemonkeys.image
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 $

Author:

Harald Kuhr, last modified by $Author: haku $

Field Summary

static int	COLOR_SELECTION_DEFAULT Default color selection
static int	COLOR_SELECTION_FAST Prioritize speed
static int	COLOR_SELECTION_QUALITY Prioritize quality
static int	DITHER_DEFAULT Java default dither
static int	DITHER_DIFFUSION Error diffusion dither
static int	DITHER_DIFFUSION_ALTSCANS Error diffusion dither with alternating scans
static int	DITHER_NONE No dither
static int	EDGE_NO_OP Alias for ConvolveOp.EDGE_NO_OP.
static int	EDGE_REFLECT Adds a border to the image while convolving.
static int	EDGE_WRAP Adds a border to the image while convolving.
static int	EDGE_ZERO_FILL Alias for ConvolveOp.EDGE_ZERO_FILL.
static int	FLIP_HORIZONTAL
static int	FLIP_VERTICAL
protected static AffineTransform	IDENTITY_TRANSFORM
protected static Point	LOCATION_UPPER_LEFT
static int	ROTATE_180
static int	ROTATE_90_CCW
static int	ROTATE_90_CW
static int	TRANSPARENCY_BITMASK Convert alpha to bitmask
static int	TRANSPARENCY_DEFAULT Default transparency (none)
static int	TRANSPARENCY_OPAQUE Discard any alpha information
protected static int	TRANSPARENCY_TRANSLUCENT Keep original alpha (not supported yet)

Method Summary

static BufferedImage	accelerate(Image pImage) Tries to use H/W-accelerated code for an image for display purposes.
static BufferedImage	accelerate(Image pImage, GraphicsConfiguration pConfiguration) Tries to use H/W-accelerated code for an image for display purposes.
static Color	blend(Color pColor, Color pOther) Blends two colors half and half, to create a tone in between.
static Color	blend(Color pColor, Color pOther, float pBlendFactor) Blends two colors, controlled by the blending factor.
static BufferedImage	blur(BufferedImage pOriginal) Creates a blurred version of the given image.
static BufferedImage	blur(BufferedImage pOriginal, float pRadius) Creates a blurred version of the given image.
static Image	brightness(Image pOriginal, float pAmount) Changes the brightness of the original image.
static Image	contrast(Image pOriginal) Adds contrast
static Image	contrast(Image pOriginal, float pAmount) Changes the contrast of the image
static BufferedImage	convolve(BufferedImage pOriginal, Kernel pKernel, int pEdgeOperation) Convolves an image, using a convolution matrix.
static BufferedImage	createClear(int pWidth, int pHeight, Color pBackground) Creates a clear image with the given background color.
static BufferedImage	createClear(int pWidth, int pHeight, int pType, Color pBackground) Creates a clear image with the given background color.
static BufferedImage	createCopy(BufferedImage pImage) Creates a copy of the given image.
static BufferedImage	createFlipped(Image pImage, int pAxis) Creates a flipped version of the given image.
static BufferedImage	createIndexed(Image pImage) Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
static BufferedImage	createIndexed(Image pImage, Image pColors, Color pMatte, int pHints) Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
static BufferedImage	createIndexed(Image pImage, IndexColorModel pColors, Color pMatte, int pHints) Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
static BufferedImage	createIndexed(Image pImage, int pColors, Color pMatte, int pHints) Creates an indexed version of the given image (a BufferedImage with an IndexColorModel.
static BufferedImage	createResampled(BufferedImage pImage, int pWidth, int pHeight, int pHints) Creates a scaled instance of the given BufferedImage.
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.
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.
static BufferedImage	createRotated(Image pImage, double pAngle) Rotates the image to the given angle.
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.
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.
static Color	createTranslucent(Color pColor, int pTransparency) Creates a translucent version of the given color.
static BufferedImage	createTransparent(int pWidth, int pHeight) Creates a transparent image.
static BufferedImage	createTransparent(int pWidth, int pHeight, int pType) Creates a transparent image.
static Image	filter(Image pOriginal, ImageFilter pFilter) Filters an image, using the given ImageFilter.
static int	getHeight(Image pImage) Gets the height of an Image.
static IndexColorModel	getIndexColorModel(Image pImage, int pColors, int pHints) Extracts an IndexColorModel from the given image.
static int	getWidth(Image pImage) Gets the width of an Image.
static Image	grayscale(Image pOriginal) Converts an image to grayscale.
static boolean	hasTransparentPixels(RenderedImage pImage, boolean pFast) Tests whether the image has any transparent or semi-transparent pixels.
static BufferedImage	sharpen(BufferedImage pOriginal) Sharpens an image using a convolution matrix.
static BufferedImage	sharpen(BufferedImage pOriginal, float pAmount) Sharpens an image using a convolution matrix.
static BufferedImage	toBuffered(BufferedImage pOriginal, int pType) Converts the BufferedImage to a BufferedImage of the given type.
static BufferedImage	toBuffered(Image pOriginal) Converts the Image to a BufferedImage.
static BufferedImage	toBuffered(Image pOriginal, int pType) Converts the Image to a BufferedImage of the given type.
static BufferedImage	toBuffered(RenderedImage pOriginal) Converts the RenderedImage to a BufferedImage.
static BufferedImage	toBuffered(RenderedImage pOriginal, int pType) Converts the RenderedImage to a BufferedImage of the given type.
static boolean	waitForImage(Image pImage) Waits for an image to load completely.
static boolean	waitForImage(Image pImage, long pTimeOut) Waits for an image to load completely.
static boolean	waitForImages(Image[] pImages) Waits for a number of images to load completely.
static boolean	waitForImages(Image[] pImages, long pTimeOut) Waits for a number of images to load completely.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROTATE_90_CCW

public static final int ROTATE_90_CCW

See Also:

Constant Field Values

ROTATE_90_CW

public static final int ROTATE_90_CW

See Also:

Constant Field Values

ROTATE_180

public static final int ROTATE_180

See Also:

Constant Field Values

FLIP_VERTICAL

public static final int FLIP_VERTICAL

See Also:

Constant Field Values

FLIP_HORIZONTAL

public static final int FLIP_HORIZONTAL

See Also:

Constant Field Values

EDGE_ZERO_FILL

public static final int EDGE_ZERO_FILL

Alias for ConvolveOp.EDGE_ZERO_FILL.

See Also:

convolve(java.awt.image.BufferedImage, java.awt.image.Kernel, int), EDGE_REFLECT, Constant Field Values

EDGE_NO_OP

public static final int EDGE_NO_OP

Alias for ConvolveOp.EDGE_NO_OP.

See Also:

convolve(java.awt.image.BufferedImage, java.awt.image.Kernel, int), EDGE_REFLECT, Constant Field Values

EDGE_REFLECT

public static final int EDGE_REFLECT

Adds a border to the image while convolving. The border will reflect the edges of the original image. This is usually a good default. Note that while this mode typically provides better quality than the standard modes EDGE_ZERO_FILL and EDGE_NO_OP, it does so at the expense of higher memory consumption and considerable more computation.

See Also:

convolve(java.awt.image.BufferedImage, java.awt.image.Kernel, int), Constant Field Values

EDGE_WRAP

public static final int EDGE_WRAP

Adds a border to the image while convolving. The border will wrap the edges of the original image. This is usually the best choice for tiles. Note that while this mode typically provides better quality than the standard modes EDGE_ZERO_FILL and EDGE_NO_OP, it does so at the expense of higher memory consumption and considerable more computation.

See Also:

convolve(java.awt.image.BufferedImage, java.awt.image.Kernel, int), EDGE_REFLECT, Constant Field Values

DITHER_DEFAULT

public static final int DITHER_DEFAULT

Java default dither

See Also:

Constant Field Values

DITHER_NONE

public static final int DITHER_NONE

No dither

See Also:

Constant Field Values

DITHER_DIFFUSION

public static final int DITHER_DIFFUSION

Error diffusion dither

See Also:

Constant Field Values

DITHER_DIFFUSION_ALTSCANS

public static final int DITHER_DIFFUSION_ALTSCANS

Error diffusion dither with alternating scans

See Also:

Constant Field Values

COLOR_SELECTION_DEFAULT

public static final int COLOR_SELECTION_DEFAULT

Default color selection

See Also:

Constant Field Values

COLOR_SELECTION_FAST

public static final int COLOR_SELECTION_FAST

Prioritize speed

See Also:

Constant Field Values

COLOR_SELECTION_QUALITY

public static final int COLOR_SELECTION_QUALITY

Prioritize quality

See Also:

Constant Field Values

TRANSPARENCY_DEFAULT

public static final int TRANSPARENCY_DEFAULT

Default transparency (none)

See Also:

Constant Field Values

TRANSPARENCY_OPAQUE

public static final int TRANSPARENCY_OPAQUE

Discard any alpha information

See Also:

Constant Field Values

TRANSPARENCY_BITMASK

public static final int TRANSPARENCY_BITMASK

Convert alpha to bitmask

See Also:

Constant Field Values

TRANSPARENCY_TRANSLUCENT

protected static final int TRANSPARENCY_TRANSLUCENT

Keep original alpha (not supported yet)

See Also:

Constant Field Values

IDENTITY_TRANSFORM

protected static final AffineTransform IDENTITY_TRANSFORM

LOCATION_UPPER_LEFT

protected static final Point LOCATION_UPPER_LEFT

Method Detail

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:

BufferedImage.getType()

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:

BufferedImage.getType()

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 copy of the given image. The image will have the same color model and raster type, but will not share image (pixel) data.

Parameters:

pImage - the image to clone.

Returns:

a new BufferedImage

Throws:

IllegalArgumentException - if pImage is null

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:

BufferedImage.getType()

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

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:

createResampled(java.awt.Image, int, int, int), Image.getScaledInstance(int,int,int), Image.SCALE_AREA_AVERAGING, Image.SCALE_DEFAULT, Image.SCALE_FAST, Image.SCALE_REPLICATE, Image.SCALE_SMOOTH

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:

Image.SCALE_AREA_AVERAGING, Image.SCALE_DEFAULT, Image.SCALE_FAST, Image.SCALE_REPLICATE, Image.SCALE_SMOOTH, ResampleOp

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:

Image.SCALE_AREA_AVERAGING, Image.SCALE_DEFAULT, Image.SCALE_FAST, Image.SCALE_REPLICATE, Image.SCALE_SMOOTH, ResampleOp

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:

Image.SCALE_AREA_AVERAGING, Image.SCALE_DEFAULT, Image.SCALE_FAST, Image.SCALE_REPLICATE, Image.SCALE_SMOOTH, ResampleOp

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:

COLOR_SELECTION_DEFAULT, COLOR_SELECTION_FAST, COLOR_SELECTION_QUALITY, TRANSPARENCY_DEFAULT, TRANSPARENCY_OPAQUE, TRANSPARENCY_BITMASK, TRANSPARENCY_TRANSLUCENT

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:

COLOR_SELECTION_DEFAULT, COLOR_SELECTION_FAST, COLOR_SELECTION_QUALITY, DITHER_NONE, DITHER_DEFAULT, DITHER_DIFFUSION, DITHER_DIFFUSION_ALTSCANS, TRANSPARENCY_DEFAULT, TRANSPARENCY_OPAQUE, TRANSPARENCY_BITMASK, TRANSPARENCY_TRANSLUCENT

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:

COLOR_SELECTION_DEFAULT, COLOR_SELECTION_FAST, COLOR_SELECTION_QUALITY, DITHER_NONE, DITHER_DEFAULT, DITHER_DIFFUSION, DITHER_DIFFUSION_ALTSCANS, TRANSPARENCY_DEFAULT, TRANSPARENCY_OPAQUE, TRANSPARENCY_BITMASK, TRANSPARENCY_TRANSLUCENT

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:

COLOR_SELECTION_DEFAULT, COLOR_SELECTION_FAST, COLOR_SELECTION_QUALITY, DITHER_NONE, DITHER_DEFAULT, DITHER_DIFFUSION, DITHER_DIFFUSION_ALTSCANS, TRANSPARENCY_DEFAULT, TRANSPARENCY_OPAQUE, TRANSPARENCY_BITMASK, TRANSPARENCY_TRANSLUCENT

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:

0.0	-0.3	0.0
-0.3	2.2	-0.3
0.0	-0.3	0.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:

0.0	-pAmount	0.0
-pAmount	4.0 * pAmount + 1.0	-pAmount
0.0	-pAmount	0.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

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.

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:

GrayFilter, RGBImageFilter

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

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:

BufferedImage.BufferedImage(int,int,int)

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:

BufferedImage.BufferedImage(int,int,int)

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:

BufferedImage.BufferedImage(int,int,int)

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(Image,long)

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(Image[],long)

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(Image[],long)

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

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