public class BufferedImage extends Image implements WritableRenderedImage, Transparency
The BufferedImage subclass describes an Image with an accessible buffer of image data. A BufferedImage is comprised of a ColorModel and a Raster of image data. The number and types of bands in the SampleModel of the Raster must match the number and types required by the ColorModel to represent its color and alpha components. All BufferedImage objects have an upper left corner coordinate of (0, 0). Any Raster used to construct a BufferedImage must therefore have minX=0 and minY=0.
This class relies on the data fetching and setting methods of Raster, and on the color characterization methods of ColorModel.
ColorModel, Raster, WritableRaster
public static final int TYPE_CUSTOM
Image type is not recognized so it must be a customized image. This type is only used as a return value for the getType() method.
public static final int TYPE_INT_RGB
Represents an image with 8-bit RGB color components packed into integer pixels. The image has a DirectColorModel without alpha. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_INT_ARGB
Represents an image with 8-bit RGBA color components packed into integer pixels. The image has a DirectColorModel with alpha. The color data in this image is considered not to be premultiplied with alpha. When this type is used as the imageType argument to a BufferedImage constructor, the created image is consistent with images created in the JDK1.1 and earlier releases.
public static final int TYPE_INT_ARGB_PRE
Represents an image with 8-bit RGBA color components packed into integer pixels. The image has a DirectColorModel with alpha. The color data in this image is considered to be premultiplied with alpha.
public static final int TYPE_INT_BGR
Represents an image with 8-bit RGB color components, corresponding to a Windows- or Solaris- style BGR color model, with the colors Blue, Green, and Red packed into integer pixels. There is no alpha. The image has a DirectColorModel. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_3BYTE_BGR
Represents an image with 8-bit RGB color components, corresponding to a Windows-style BGR color model) with the colors Blue, Green, and Red stored in 3 bytes. There is no alpha. The image has a ComponentColorModel. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_4BYTE_ABGR
Represents an image with 8-bit RGBA color components with the colors Blue, Green, and Red stored in 3 bytes and 1 byte of alpha. The image has a ComponentColorModel with alpha. The color data in this image is considered not to be premultiplied with alpha. The byte data is interleaved in a single byte array in the order A, B, G, R from lower to higher byte addresses within each pixel.
public static final int TYPE_4BYTE_ABGR_PRE
Represents an image with 8-bit RGBA color components with the colors Blue, Green, and Red stored in 3 bytes and 1 byte of alpha. The image has a ComponentColorModel with alpha. The color data in this image is considered to be premultiplied with alpha. The byte data is interleaved in a single byte array in the order A, B, G, R from lower to higher byte addresses within each pixel.
public static final int TYPE_USHORT_565_RGB
Represents an image with 5-6-5 RGB color components (5-bits red, 6-bits green, 5-bits blue) with no alpha. This image has a DirectColorModel. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_USHORT_555_RGB
Represents an image with 5-5-5 RGB color components (5-bits red, 5-bits green, 5-bits blue) with no alpha. This image has a DirectColorModel. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_BYTE_GRAY
Represents a unsigned byte grayscale image, non-indexed. This image has a ComponentColorModel with a CS_GRAY ColorSpace. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_USHORT_GRAY
Represents an unsigned short grayscale image, non-indexed). This image has a ComponentColorModel with a CS_GRAY ColorSpace. When data with non-opaque alpha is stored in an image of this type, the color data must be adjusted to a non-premultiplied form and the alpha discarded, as described in the AlphaComposite documentation.
public static final int TYPE_BYTE_BINARY
Represents an opaque byte-packed 1, 2, or 4 bit image. The image has an IndexColorModel without alpha. When this type is used as the imageType argument to the BufferedImage constructor that takes an imageType argument but no ColorModel argument, a 1-bit image is created with an IndexColorModel with two colors in the default sRGB ColorSpace: {0, 0, 0} and {255, 255, 255}.
Images with 2 or 4 bits per pixel may be constructed via the BufferedImage constructor that takes a ColorModel argument by supplying a ColorModel with an appropriate map size.
Images with 8 bits per pixel should use the image types TYPE_BYTE_INDEXED or TYPE_BYTE_GRAY depending on their ColorModel.
When color data is stored in an image of this type, the closest color in the colormap is determined by the IndexColorModel and the resulting index is stored. Approximation and loss of alpha or color components can result, depending on the colors in the IndexColorModel colormap.
public static final int TYPE_BYTE_INDEXED
Represents an indexed byte image. When this type is used as the imageType argument to the BufferedImage constructor that takes an imageType argument but no ColorModel argument, an IndexColorModel is created with a 256-color 6/6/6 color cube palette with the rest of the colors from 216-255 populated by grayscale values in the default sRGB ColorSpace.
When color data is stored in an image of this type, the closest color in the colormap is determined by the IndexColorModel and the resulting index is stored. Approximation and loss of alpha or color components can result, depending on the colors in the IndexColorModel colormap.
public BufferedImage(int width,
int height,
int imageType) Constructs a BufferedImage of one of the predefined image types. The ColorSpace for the image is the default sRGB space.
width - width of the created imageheight - height of the created imageimageType - type of the created imageColorSpace, TYPE_INT_RGB, TYPE_INT_ARGB, TYPE_INT_ARGB_PRE, TYPE_INT_BGR, TYPE_3BYTE_BGR, TYPE_4BYTE_ABGR, TYPE_4BYTE_ABGR_PRE, TYPE_BYTE_GRAY, TYPE_USHORT_GRAY, TYPE_BYTE_BINARY, TYPE_BYTE_INDEXED, TYPE_USHORT_565_RGB, TYPE_USHORT_555_RGB
public BufferedImage(int width,
int height,
int imageType,
IndexColorModel cm) Constructs a BufferedImage of one of the predefined image types: TYPE_BYTE_BINARY or TYPE_BYTE_INDEXED.
If the image type is TYPE_BYTE_BINARY, the number of entries in the color model is used to determine whether the image should have 1, 2, or 4 bits per pixel. If the color model has 1 or 2 entries, the image will have 1 bit per pixel. If it has 3 or 4 entries, the image with have 2 bits per pixel. If it has between 5 and 16 entries, the image will have 4 bits per pixel. Otherwise, an IllegalArgumentException will be thrown.
width - width of the created imageheight - height of the created imageimageType - type of the created imagecm - IndexColorModel of the created imageIllegalArgumentException - if the imageType is not TYPE_BYTE_BINARY or TYPE_BYTE_INDEXED or if the imageType is TYPE_BYTE_BINARY and the color map has more than 16 entries.TYPE_BYTE_BINARY, TYPE_BYTE_INDEXED
public BufferedImage(ColorModel cm,
WritableRaster raster,
boolean isRasterPremultiplied,
Hashtable<?,?> properties) Constructs a new BufferedImage with a specified ColorModel and Raster. If the number and types of bands in the SampleModel of the Raster do not match the number and types required by the ColorModel to represent its color and alpha components, a RasterFormatException is thrown. This method can multiply or divide the color Raster data by alpha to match the alphaPremultiplied state in the ColorModel. Properties for this BufferedImage can be established by passing in a Hashtable of String/Object pairs.
cm - ColorModel for the new imageraster - Raster for the image dataisRasterPremultiplied - if true, the data in the raster has been premultiplied with alpha.properties - Hashtable of String/Object pairs.RasterFormatException - if the number and types of bands in the SampleModel of the Raster do not match the number and types required by the ColorModel to represent its color and alpha components.IllegalArgumentException - if raster is incompatible with cm
ColorModel, Raster, WritableRaster
public int getType()
Returns the image type. If it is not one of the known types, TYPE_CUSTOM is returned.
BufferedImage.TYPE_INT_RGB, TYPE_INT_ARGB, TYPE_INT_ARGB_PRE, TYPE_INT_BGR, TYPE_3BYTE_BGR, TYPE_4BYTE_ABGR, TYPE_4BYTE_ABGR_PRE, TYPE_BYTE_GRAY, TYPE_BYTE_BINARY, TYPE_BYTE_INDEXED, TYPE_USHORT_GRAY, TYPE_USHORT_565_RGB, TYPE_USHORT_555_RGB, TYPE_CUSTOM
public ColorModel getColorModel()
Returns the ColorModel.
getColorModel in interface RenderedImage
ColorModel of this BufferedImage.public WritableRaster getRaster()
Returns the WritableRaster.
WriteableRaster of this BufferedImage.public WritableRaster getAlphaRaster()
Returns a WritableRaster representing the alpha channel for BufferedImage objects with ColorModel objects that support a separate spatial alpha channel, such as ComponentColorModel and DirectColorModel. Returns null if there is no alpha channel associated with the ColorModel in this image. This method assumes that for all ColorModel objects other than IndexColorModel, if the ColorModel supports alpha, there is a separate alpha channel which is stored as the last band of image data. If the image uses an IndexColorModel that has alpha in the lookup table, this method returns null since there is no spatially discrete alpha channel. This method creates a new WritableRaster, but shares the data array.
WritableRaster or null if this BufferedImage has no alpha channel associated with its ColorModel.public int getRGB(int x,
int y) Returns an integer pixel in the default RGB color model (TYPE_INT_ARGB) and default sRGB colorspace. Color conversion takes place if this default model does not match the image ColorModel. There are only 8-bits of precision for each color component in the returned data when using this method.
An ArrayOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x - the X coordinate of the pixel from which to get the pixel in the default RGB color model and sRGB color spacey - the Y coordinate of the pixel from which to get the pixel in the default RGB color model and sRGB color spacesetRGB(int, int, int), setRGB(int, int, int, int, int[], int, int)
public int[] getRGB(int startX,
int startY,
int w,
int h,
int[] rgbArray,
int offset,
int scansize) Returns an array of integer pixels in the default RGB color model (TYPE_INT_ARGB) and default sRGB color space, from a portion of the image data. Color conversion takes place if the default model does not match the image ColorModel. There are only 8-bits of precision for each color component in the returned data when using this method. With a specified coordinate (x, y) in the image, the ARGB pixel can be accessed in this way:
pixel = rgbArray[offset + (y-startY)*scansize + (x-startX)];
An ArrayOutOfBoundsException may be thrown if the region is not in bounds. However, explicit bounds checking is not guaranteed.
startX - the starting X coordinatestartY - the starting Y coordinatew - width of regionh - height of regionrgbArray - if not null, the rgb pixels are written hereoffset - offset into the rgbArray
scansize - scanline stride for the rgbArray
setRGB(int, int, int), setRGB(int, int, int, int, int[], int, int)
public void setRGB(int x,
int y,
int rgb) Sets a pixel in this BufferedImage to the specified RGB value. The pixel is assumed to be in the default RGB color model, TYPE_INT_ARGB, and default sRGB color space. For images with an IndexColorModel, the index with the nearest color is chosen.
An ArrayOutOfBoundsException may be thrown if the coordinates are not in bounds. However, explicit bounds checking is not guaranteed.
x - the X coordinate of the pixel to sety - the Y coordinate of the pixel to setrgb - the RGB valuegetRGB(int, int), getRGB(int, int, int, int, int[], int, int)
public void setRGB(int startX,
int startY,
int w,
int h,
int[] rgbArray,
int offset,
int scansize) Sets an array of integer pixels in the default RGB color model (TYPE_INT_ARGB) and default sRGB color space, into a portion of the image data. Color conversion takes place if the default model does not match the image ColorModel. There are only 8-bits of precision for each color component in the returned data when using this method. With a specified coordinate (x, y) in the this image, the ARGB pixel can be accessed in this way:
pixel = rgbArray[offset + (y-startY)*scansize + (x-startX)];WARNING: No dithering takes place.
An ArrayOutOfBoundsException may be thrown if the region is not in bounds. However, explicit bounds checking is not guaranteed.
startX - the starting X coordinatestartY - the starting Y coordinatew - width of the regionh - height of the regionrgbArray - the rgb pixelsoffset - offset into the rgbArray
scansize - scanline stride for the rgbArray
getRGB(int, int), getRGB(int, int, int, int, int[], int, int)
public int getWidth()
Returns the width of the BufferedImage.
getWidth in interface RenderedImage
BufferedImage
public int getHeight()
Returns the height of the BufferedImage.
getHeight in interface RenderedImage
BufferedImage
public int getWidth(ImageObserver observer)
Returns the width of the BufferedImage.
getWidth in class Image
observer - ignoredBufferedImage
Image.getHeight(java.awt.image.ImageObserver), ImageObserver
public int getHeight(ImageObserver observer)
Returns the height of the BufferedImage.
getHeight in class Image
observer - ignoredBufferedImage
Image.getWidth(java.awt.image.ImageObserver), ImageObserver
public ImageProducer getSource()
Returns the object that produces the pixels for the image.
getSource in class Image
ImageProducer that is used to produce the pixels for this image.ImageProducerpublic Object getProperty(String name,
ImageObserver observer) Returns a property of the image by name. Individual property names are defined by the various image formats. If a property is not defined for a particular image, this method returns the UndefinedProperty field. If the properties for this image are not yet known, then this method returns null and the ImageObserver object is notified later. The property name "comment" should be used to store an optional comment that can be presented to the user as a description of the image, its source, or its author.
getProperty in class Image
name - the property nameobserver - the ImageObserver that receives notification regarding image informationObject that is the property referred to by the specified name or null if the properties of this image are not yet known.NullPointerException - if the property name is null.ImageObserver, Image.UndefinedProperty
public Object getProperty(String name)
Returns a property of the image by name.
getProperty in interface RenderedImage
name - the property nameObject that is the property referred to by the specified name.NullPointerException - if the property name is null.Image.UndefinedPropertypublic Graphics getGraphics()
This method returns a Graphics2D, but is here for backwards compatibility. createGraphics is more convenient, since it is declared to return a Graphics2D.
getGraphics in class Image
Graphics2D, which can be used to draw into this image.Graphics, Component.createImage(int, int)
public Graphics2D createGraphics()
Creates a Graphics2D, which can be used to draw into this BufferedImage.
Graphics2D, used for drawing into this image.public BufferedImage getSubimage(int x,
int y,
int w,
int h) Returns a subimage defined by a specified rectangular region. The returned BufferedImage shares the same data array as the original image.
x - the X coordinate of the upper-left corner of the specified rectangular regiony - the Y coordinate of the upper-left corner of the specified rectangular regionw - the width of the specified rectangular regionh - the height of the specified rectangular regionBufferedImage that is the subimage of this BufferedImage.RasterFormatException - if the specified area is not contained within this BufferedImage.public boolean isAlphaPremultiplied()
Returns whether or not the alpha has been premultiplied. It returns false if there is no alpha.
true if the alpha has been premultiplied; false otherwise.public void coerceData(boolean isAlphaPremultiplied)
Forces the data to match the state specified in the isAlphaPremultiplied variable. It may multiply or divide the color raster data by alpha, or do nothing if the data is in the correct state.
isAlphaPremultiplied - true if the alpha has been premultiplied; false otherwise.public String toString()
Returns a String representation of this BufferedImage object and its values.
public Vector<RenderedImage> getSources()
Returns a Vector of RenderedImage objects that are the immediate sources, not the sources of these immediate sources, of image data for this BufferedImage. This method returns null if the BufferedImage has no information about its immediate sources. It returns an empty Vector if the BufferedImage has no immediate sources.
getSources in interface RenderedImage
Vector containing immediate sources of this BufferedImage object's image date, or null if this BufferedImage has no information about its immediate sources, or an empty Vector if this BufferedImage has no immediate sources.public String[] getPropertyNames()
Returns an array of names recognized by getProperty(String) or null, if no property names are recognized.
getPropertyNames in interface RenderedImage
String array containing all of the property names that getProperty(String) recognizes; or null if no property names are recognized.public int getMinX()
Returns the minimum x coordinate of this BufferedImage. This is always zero.
getMinX in interface RenderedImage
BufferedImage.public int getMinY()
Returns the minimum y coordinate of this BufferedImage. This is always zero.
getMinY in interface RenderedImage
BufferedImage.public SampleModel getSampleModel()
Returns the SampleModel associated with this BufferedImage.
getSampleModel in interface RenderedImage
SampleModel of this BufferedImage.public int getNumXTiles()
Returns the number of tiles in the x direction. This is always one.
getNumXTiles in interface RenderedImage
public int getNumYTiles()
Returns the number of tiles in the y direction. This is always one.
getNumYTiles in interface RenderedImage
public int getMinTileX()
Returns the minimum tile index in the x direction. This is always zero.
getMinTileX in interface RenderedImage
public int getMinTileY()
Returns the minimum tile index in the y direction. This is always zero.
getMinTileY in interface RenderedImage
public int getTileWidth()
Returns the tile width in pixels.
getTileWidth in interface RenderedImage
public int getTileHeight()
Returns the tile height in pixels.
getTileHeight in interface RenderedImage
public int getTileGridXOffset()
Returns the x offset of the tile grid relative to the origin, For example, the x coordinate of the location of tile (0, 0). This is always zero.
getTileGridXOffset in interface RenderedImage
public int getTileGridYOffset()
Returns the y offset of the tile grid relative to the origin, For example, the y coordinate of the location of tile (0, 0). This is always zero.
getTileGridYOffset in interface RenderedImage
public Raster getTile(int tileX,
int tileY) Returns tile (tileX, tileY). Note that tileX and tileY are indices into the tile array, not pixel locations. The Raster that is returned is live, which means that it is updated if the image is changed.
getTile in interface RenderedImage
tileX - the x index of the requested tile in the tile arraytileY - the y index of the requested tile in the tile arrayRaster that is the tile defined by the arguments tileX and tileY.ArrayIndexOutOfBoundsException - if both tileX and tileY are not equal to 0public Raster getData()
Returns the image as one large tile. The Raster returned is a copy of the image data is not updated if the image is changed.
getData in interface RenderedImage
Raster that is a copy of the image data.setData(Raster)public Raster getData(Rectangle rect)
Computes and returns an arbitrary region of the BufferedImage. The Raster returned is a copy of the image data and is not updated if the image is changed.
getData in interface RenderedImage
rect - the region of the BufferedImage to be returned.Raster that is a copy of the image data of the specified region of the BufferedImage
setData(Raster)public WritableRaster copyData(WritableRaster outRaster)
Computes an arbitrary rectangular region of the BufferedImage and copies it into a specified WritableRaster. The region to be computed is determined from the bounds of the specified WritableRaster. The specified WritableRaster must have a SampleModel that is compatible with this image. If outRaster is null, an appropriate WritableRaster is created.
copyData in interface RenderedImage
outRaster - a WritableRaster to hold the returned part of the image, or null
WritableRaster.public void setData(Raster r)
Sets a rectangular region of the image to the contents of the specified Raster r, which is assumed to be in the same coordinate space as the BufferedImage. The operation is clipped to the bounds of the BufferedImage.
setData in interface WritableRenderedImage
r - the specified Raster
getData(), getData(Rectangle)
public void addTileObserver(TileObserver to)
Adds a tile observer. If the observer is already present, it receives multiple notifications.
addTileObserver in interface WritableRenderedImage
to - the specified TileObserver
public void removeTileObserver(TileObserver to)
Removes a tile observer. If the observer was not registered, nothing happens. If the observer was registered for multiple notifications, it is now registered for one fewer notification.
removeTileObserver in interface WritableRenderedImage
to - the specified TileObserver.public boolean isTileWritable(int tileX,
int tileY) Returns whether or not a tile is currently checked out for writing.
isTileWritable in interface WritableRenderedImage
tileX - the x index of the tile.tileY - the y index of the tile.true if the tile specified by the specified indices is checked out for writing; false otherwise.ArrayIndexOutOfBoundsException - if both tileX and tileY are not equal to 0public Point[] getWritableTileIndices()
Returns an array of Point objects indicating which tiles are checked out for writing. Returns null if none are checked out.
getWritableTileIndices in interface WritableRenderedImage
Point array that indicates the tiles that are checked out for writing, or null if no tiles are checked out for writing.public boolean hasTileWriters()
Returns whether or not any tile is checked out for writing. Semantically equivalent to
(getWritableTileIndices() != null).
hasTileWriters in interface WritableRenderedImage
true if any tile is checked out for writing; false otherwise.public WritableRaster getWritableTile(int tileX,
int tileY) Checks out a tile for writing. All registered TileObservers are notified when a tile goes from having no writers to having one writer.
getWritableTile in interface WritableRenderedImage
tileX - the x index of the tiletileY - the y index of the tileWritableRaster that is the tile, indicated by the specified indices, to be checked out for writing.public void releaseWritableTile(int tileX,
int tileY) Relinquishes permission to write to a tile. If the caller continues to write to the tile, the results are undefined. Calls to this method should only appear in matching pairs with calls to getWritableTile(int, int). Any other leads to undefined results. All registered TileObservers are notified when a tile goes from having one writer to having no writers.
releaseWritableTile in interface WritableRenderedImage
tileX - the x index of the tiletileY - the y index of the tilepublic int getTransparency()
Returns the transparency. Returns either OPAQUE, BITMASK, or TRANSLUCENT.
getTransparency in interface Transparency
BufferedImage.Transparency.OPAQUE, Transparency.BITMASK, Transparency.TRANSLUCENT
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.