Class BufferedImage
- All Implemented Interfaces:
RenderedImage
,WritableRenderedImage
,Transparency
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
.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
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.static final int
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.static final int
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.static final int
Represents an opaque byte-packed 1, 2, or 4 bit image.static final int
Represents a unsigned byte grayscale image, non-indexed.static final int
Represents an indexed byte image.static final int
Image type is not recognized so it must be a customized image.static final int
Represents an image with 8-bit RGBA color components packed into integer pixels.static final int
Represents an image with 8-bit RGBA color components packed into integer pixels.static final int
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.static final int
Represents an image with 8-bit RGB color components packed into integer pixels.static final int
Represents an image with 5-5-5 RGB color components (5-bits red, 5-bits green, 5-bits blue) with no alpha.static final int
Represents an image with 5-6-5 RGB color components (5-bits red, 6-bits green, 5-bits blue) with no alpha.static final int
Represents an unsigned short grayscale image, non-indexed).Fields declared in class java.awt.Image
accelerationPriority, SCALE_AREA_AVERAGING, SCALE_DEFAULT, SCALE_FAST, SCALE_REPLICATE, SCALE_SMOOTH, UndefinedProperty
Fields declared in interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
Constructor Summary
ConstructorDescriptionBufferedImage
(int width, int height, int imageType) Constructs aBufferedImage
of one of the predefined image types.BufferedImage
(int width, int height, int imageType, IndexColorModel cm) Constructs aBufferedImage
of one of the predefined image types: TYPE_BYTE_BINARY or TYPE_BYTE_INDEXED.BufferedImage
(ColorModel cm, WritableRaster raster, boolean isRasterPremultiplied, Hashtable<?, ?> properties) Constructs a newBufferedImage
with a specifiedColorModel
andRaster
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a tile observer.void
coerceData
(boolean isAlphaPremultiplied) Forces the data to match the state specified in theisAlphaPremultiplied
variable.copyData
(WritableRaster outRaster) Computes an arbitrary rectangular region of theBufferedImage
and copies it into a specifiedWritableRaster
.Creates aGraphics2D
, which can be used to draw into thisBufferedImage
.Returns aWritableRaster
representing the alpha channel forBufferedImage
objects withColorModel
objects that support a separate spatial alpha channel, such asComponentColorModel
andDirectColorModel
.Returns theColorModel
.getData()
Returns the image as one large tile.Computes and returns an arbitrary region of theBufferedImage
.This method returns aGraphics2D
, but is here for backwards compatibility.int
Returns the height of theBufferedImage
.int
getHeight
(ImageObserver observer) Returns the height of theBufferedImage
.int
Returns the minimum tile index in the x direction.int
Returns the minimum tile index in the y direction.int
getMinX()
Returns the minimum x coordinate of thisBufferedImage
.int
getMinY()
Returns the minimum y coordinate of thisBufferedImage
.int
Returns the number of tiles in the x direction.int
Returns the number of tiles in the y direction.getProperty
(String name) Returns a property of the image by name.getProperty
(String name, ImageObserver observer) Returns a property of the image by name.String[]
Returns an array of names recognized bygetProperty(String)
ornull
, if no property names are recognized.Returns theWritableRaster
.int
getRGB
(int x, int y) Returns an integer pixel in the default RGB color model (TYPE_INT_ARGB) and default sRGB colorspace.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.Returns theSampleModel
associated with thisBufferedImage
.Returns the object that produces the pixels for the image.Returns aVector
ofRenderedImage
objects that are the immediate sources, not the sources of these immediate sources, of image data for thisBufferedImage
.getSubimage
(int x, int y, int w, int h) Returns a subimage defined by a specified rectangular region.getTile
(int tileX, int tileY) Returns tile (tileX
,tileY
).int
Returns the x offset of the tile grid relative to the origin, For example, the x coordinate of the location of tile (0, 0).int
Returns the y offset of the tile grid relative to the origin, For example, the y coordinate of the location of tile (0, 0).int
Returns the tile height in pixels.int
Returns the tile width in pixels.int
Returns the transparency.int
getType()
Returns the image type.int
getWidth()
Returns the width of theBufferedImage
.int
getWidth
(ImageObserver observer) Returns the width of theBufferedImage
.getWritableTile
(int tileX, int tileY) Checks out a tile for writing.Point[]
Returns an array ofPoint
objects indicating which tiles are checked out for writing.boolean
Returns whether or not any tile is checked out for writing.boolean
Returns whether or not the alpha has been premultiplied.boolean
isTileWritable
(int tileX, int tileY) Returns whether or not a tile is currently checked out for writing.void
releaseWritableTile
(int tileX, int tileY) Relinquishes permission to write to a tile.void
Removes a tile observer.void
Sets a rectangular region of the image to the contents of the specifiedRaster r
, which is assumed to be in the same coordinate space as theBufferedImage
.void
setRGB
(int x, int y, int rgb) Sets a pixel in thisBufferedImage
to the specified RGB value.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.toString()
Returns aString
representation of thisBufferedImage
object and its values.Methods declared in class java.awt.Image
flush, getAccelerationPriority, getCapabilities, getScaledInstance, setAccelerationPriority
-
Field Details
-
TYPE_CUSTOM
public static final int TYPE_CUSTOMImage type is not recognized so it must be a customized image. This type is only used as a return value for the getType() method.- See Also:
-
TYPE_INT_RGB
public static final int TYPE_INT_RGBRepresents an image with 8-bit RGB color components packed into integer pixels. The image has aDirectColorModel
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 theAlphaComposite
documentation.- See Also:
-
TYPE_INT_ARGB
public static final int TYPE_INT_ARGBRepresents an image with 8-bit RGBA color components packed into integer pixels. The image has aDirectColorModel
with alpha. The color data in this image is considered not to be premultiplied with alpha. When this type is used as theimageType
argument to aBufferedImage
constructor, the created image is consistent with images created in the JDK1.1 and earlier releases.- See Also:
-
TYPE_INT_ARGB_PRE
public static final int TYPE_INT_ARGB_PRERepresents an image with 8-bit RGBA color components packed into integer pixels. The image has aDirectColorModel
with alpha. The color data in this image is considered to be premultiplied with alpha.- See Also:
-
TYPE_INT_BGR
public static final int TYPE_INT_BGRRepresents 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 aDirectColorModel
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_3BYTE_BGR
public static final int TYPE_3BYTE_BGRRepresents 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 aComponentColorModel
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_4BYTE_ABGR
public static final int TYPE_4BYTE_ABGRRepresents 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 aComponentColorModel
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.- See Also:
-
TYPE_4BYTE_ABGR_PRE
public static final int TYPE_4BYTE_ABGR_PRERepresents 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 aComponentColorModel
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.- See Also:
-
TYPE_USHORT_565_RGB
public static final int TYPE_USHORT_565_RGBRepresents an image with 5-6-5 RGB color components (5-bits red, 6-bits green, 5-bits blue) with no alpha. This image has aDirectColorModel
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_USHORT_555_RGB
public static final int TYPE_USHORT_555_RGBRepresents an image with 5-5-5 RGB color components (5-bits red, 5-bits green, 5-bits blue) with no alpha. This image has aDirectColorModel
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_BYTE_GRAY
public static final int TYPE_BYTE_GRAYRepresents a unsigned byte grayscale image, non-indexed. This image has aComponentColorModel
with a CS_GRAYColorSpace
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_USHORT_GRAY
public static final int TYPE_USHORT_GRAYRepresents an unsigned short grayscale image, non-indexed). This image has aComponentColorModel
with a CS_GRAYColorSpace
. 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 theAlphaComposite
documentation.- See Also:
-
TYPE_BYTE_BINARY
public static final int TYPE_BYTE_BINARYRepresents an opaque byte-packed 1, 2, or 4 bit image. The image has anIndexColorModel
without alpha. When this type is used as theimageType
argument to theBufferedImage
constructor that takes animageType
argument but noColorModel
argument, a 1-bit image is created with anIndexColorModel
with two colors in the default sRGBColorSpace
: {0, 0, 0} and {255, 255, 255}.Images with 2 or 4 bits per pixel may be constructed via the
BufferedImage
constructor that takes aColorModel
argument by supplying aColorModel
with an appropriate map size.Images with 8 bits per pixel should use the image types
TYPE_BYTE_INDEXED
orTYPE_BYTE_GRAY
depending on theirColorModel
.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 theIndexColorModel
colormap.- See Also:
-
TYPE_BYTE_INDEXED
public static final int TYPE_BYTE_INDEXEDRepresents an indexed byte image. When this type is used as theimageType
argument to theBufferedImage
constructor that takes animageType
argument but noColorModel
argument, anIndexColorModel
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 theIndexColorModel
colormap.- See Also:
-
-
Constructor Details
-
BufferedImage
public BufferedImage(int width, int height, int imageType) Constructs aBufferedImage
of one of the predefined image types. TheColorSpace
for the image is the default sRGB space.- Parameters:
width
- width of the created imageheight
- height of the created imageimageType
- type of the created image- See Also:
-
BufferedImage
Constructs aBufferedImage
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.
- Parameters:
width
- width of the created imageheight
- height of the created imageimageType
- type of the created imagecm
-IndexColorModel
of the created image- Throws:
IllegalArgumentException
- 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.- See Also:
-
BufferedImage
public BufferedImage(ColorModel cm, WritableRaster raster, boolean isRasterPremultiplied, Hashtable<?, ?> properties) Constructs a newBufferedImage
with a specifiedColorModel
andRaster
. If the number and types of bands in theSampleModel
of theRaster
do not match the number and types required by theColorModel
to represent its color and alpha components, aRasterFormatException
is thrown. This method can multiply or divide the colorRaster
data by alpha to match thealphaPremultiplied
state in theColorModel
. Properties for thisBufferedImage
can be established by passing in aHashtable
ofString
/Object
pairs.- Parameters:
cm
-ColorModel
for the new imageraster
-Raster
for the image dataisRasterPremultiplied
- iftrue
, the data in the raster has been premultiplied with alpha.properties
-Hashtable
ofString
/Object
pairs.- Throws:
RasterFormatException
- if the number and types of bands in theSampleModel
of theRaster
do not match the number and types required by theColorModel
to represent its color and alpha components.IllegalArgumentException
- ifraster
is incompatible withcm
- See Also:
-
-
Method Details
-
getType
public int getType()Returns the image type. If it is not one of the known types, TYPE_CUSTOM is returned.- Returns:
- the image type of this
BufferedImage
. - See Also:
-
getColorModel
Returns theColorModel
.- Specified by:
getColorModel
in interfaceRenderedImage
- Returns:
- the
ColorModel
of thisBufferedImage
.
-
getRaster
Returns theWritableRaster
.- Returns:
- the
WritableRaster
of thisBufferedImage
.
-
getAlphaRaster
Returns aWritableRaster
representing the alpha channel forBufferedImage
objects withColorModel
objects that support a separate spatial alpha channel, such asComponentColorModel
andDirectColorModel
. Returnsnull
if there is no alpha channel associated with theColorModel
in this image. This method assumes that for allColorModel
objects other thanIndexColorModel
, if theColorModel
supports alpha, there is a separate alpha channel which is stored as the last band of image data. If the image uses anIndexColorModel
that has alpha in the lookup table, this method returnsnull
since there is no spatially discrete alpha channel. This method creates a newWritableRaster
, but shares the data array.- Returns:
- a
WritableRaster
ornull
if thisBufferedImage
has no alpha channel associated with itsColorModel
.
-
getRGB
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 imageColorModel
. 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.- Parameters:
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 space- Returns:
- an integer pixel in the default RGB color model and default sRGB colorspace.
- See Also:
-
getRGB
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 imageColorModel
. 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.- Parameters:
startX
- the starting X coordinatestartY
- the starting Y coordinatew
- width of regionh
- height of regionrgbArray
- if notnull
, the rgb pixels are written hereoffset
- offset into thergbArray
scansize
- scanline stride for thergbArray
- Returns:
- array of RGB pixels.
- See Also:
-
setRGB
public void setRGB(int x, int y, int rgb) Sets a pixel in thisBufferedImage
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 anIndexColorModel
, 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.- Parameters:
x
- the X coordinate of the pixel to sety
- the Y coordinate of the pixel to setrgb
- the RGB value- See Also:
-
setRGB
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 imageColorModel
. 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.- Parameters:
startX
- the starting X coordinatestartY
- the starting Y coordinatew
- width of the regionh
- height of the regionrgbArray
- the rgb pixelsoffset
- offset into thergbArray
scansize
- scanline stride for thergbArray
- See Also:
-
getWidth
public int getWidth()Returns the width of theBufferedImage
.- Specified by:
getWidth
in interfaceRenderedImage
- Returns:
- the width of this
BufferedImage
-
getHeight
public int getHeight()Returns the height of theBufferedImage
.- Specified by:
getHeight
in interfaceRenderedImage
- Returns:
- the height of this
BufferedImage
-
getWidth
Returns the width of theBufferedImage
. -
getHeight
Returns the height of theBufferedImage
. -
getSource
Returns the object that produces the pixels for the image.- Specified by:
getSource
in classImage
- Returns:
- the
ImageProducer
that is used to produce the pixels for this image. - See Also:
-
getProperty
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 theUndefinedProperty
field. If the properties for this image are not yet known, then this method returnsnull
and theImageObserver
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.- Specified by:
getProperty
in classImage
- Parameters:
name
- the property nameobserver
- theImageObserver
that receives notification regarding image information- Returns:
- an
Object
that is the property referred to by the specifiedname
ornull
if the properties of this image are not yet known. - Throws:
NullPointerException
- if the property name is null.- See Also:
-
getProperty
Returns a property of the image by name.- Specified by:
getProperty
in interfaceRenderedImage
- Parameters:
name
- the property name- Returns:
- an
Object
that is the property referred to by the specifiedname
. - Throws:
NullPointerException
- if the property name is null.- See Also:
-
getGraphics
This method returns aGraphics2D
, but is here for backwards compatibility.createGraphics
is more convenient, since it is declared to return aGraphics2D
.- Specified by:
getGraphics
in classImage
- Returns:
- a
Graphics2D
, which can be used to draw into this image. - See Also:
-
createGraphics
Creates aGraphics2D
, which can be used to draw into thisBufferedImage
.- Returns:
- a
Graphics2D
, used for drawing into this image.
-
getSubimage
Returns a subimage defined by a specified rectangular region. The returnedBufferedImage
shares the same data array as the original image.- Parameters:
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 region- Returns:
- a
BufferedImage
that is the subimage of thisBufferedImage
. - Throws:
RasterFormatException
- if the specified area is not contained within thisBufferedImage
.
-
isAlphaPremultiplied
public boolean isAlphaPremultiplied()Returns whether or not the alpha has been premultiplied. It returnsfalse
if there is no alpha.- Returns:
true
if the alpha has been premultiplied;false
otherwise.
-
coerceData
public void coerceData(boolean isAlphaPremultiplied) Forces the data to match the state specified in theisAlphaPremultiplied
variable. It may multiply or divide the color raster data by alpha, or do nothing if the data is in the correct state.- Parameters:
isAlphaPremultiplied
-true
if the alpha has been premultiplied;false
otherwise.
-
toString
-
getSources
Returns aVector
ofRenderedImage
objects that are the immediate sources, not the sources of these immediate sources, of image data for thisBufferedImage
. This method returnsnull
if theBufferedImage
has no information about its immediate sources. It returns an emptyVector
if theBufferedImage
has no immediate sources.- Specified by:
getSources
in interfaceRenderedImage
- Returns:
- a
Vector
containing immediate sources of thisBufferedImage
object's image date, ornull
if thisBufferedImage
has no information about its immediate sources, or an emptyVector
if thisBufferedImage
has no immediate sources.
-
getPropertyNames
Returns an array of names recognized bygetProperty(String)
ornull
, if no property names are recognized.- Specified by:
getPropertyNames
in interfaceRenderedImage
- Returns:
- a
String
array containing all of the property names thatgetProperty(String)
recognizes; ornull
if no property names are recognized.
-
getMinX
public int getMinX()Returns the minimum x coordinate of thisBufferedImage
. This is always zero.- Specified by:
getMinX
in interfaceRenderedImage
- Returns:
- the minimum x coordinate of this
BufferedImage
.
-
getMinY
public int getMinY()Returns the minimum y coordinate of thisBufferedImage
. This is always zero.- Specified by:
getMinY
in interfaceRenderedImage
- Returns:
- the minimum y coordinate of this
BufferedImage
.
-
getSampleModel
Returns theSampleModel
associated with thisBufferedImage
.- Specified by:
getSampleModel
in interfaceRenderedImage
- Returns:
- the
SampleModel
of thisBufferedImage
.
-
getNumXTiles
public int getNumXTiles()Returns the number of tiles in the x direction. This is always one.- Specified by:
getNumXTiles
in interfaceRenderedImage
- Returns:
- the number of tiles in the x direction.
-
getNumYTiles
public int getNumYTiles()Returns the number of tiles in the y direction. This is always one.- Specified by:
getNumYTiles
in interfaceRenderedImage
- Returns:
- the number of tiles in the y direction.
-
getMinTileX
public int getMinTileX()Returns the minimum tile index in the x direction. This is always zero.- Specified by:
getMinTileX
in interfaceRenderedImage
- Returns:
- the minimum tile index in the x direction.
-
getMinTileY
public int getMinTileY()Returns the minimum tile index in the y direction. This is always zero.- Specified by:
getMinTileY
in interfaceRenderedImage
- Returns:
- the minimum tile index in the y direction.
-
getTileWidth
public int getTileWidth()Returns the tile width in pixels.- Specified by:
getTileWidth
in interfaceRenderedImage
- Returns:
- the tile width in pixels.
-
getTileHeight
public int getTileHeight()Returns the tile height in pixels.- Specified by:
getTileHeight
in interfaceRenderedImage
- Returns:
- the tile height in pixels.
-
getTileGridXOffset
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.- Specified by:
getTileGridXOffset
in interfaceRenderedImage
- Returns:
- the x offset of the tile grid.
-
getTileGridYOffset
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.- Specified by:
getTileGridYOffset
in interfaceRenderedImage
- Returns:
- the y offset of the tile grid.
-
getTile
Returns tile (tileX
,tileY
). Note thattileX
andtileY
are indices into the tile array, not pixel locations. TheRaster
that is returned is live, which means that it is updated if the image is changed.- Specified by:
getTile
in interfaceRenderedImage
- Parameters:
tileX
- the x index of the requested tile in the tile arraytileY
- the y index of the requested tile in the tile array- Returns:
- a
Raster
that is the tile defined by the argumentstileX
andtileY
. - Throws:
ArrayIndexOutOfBoundsException
- if bothtileX
andtileY
are not equal to 0
-
getData
Returns the image as one large tile. TheRaster
returned is a copy of the image data is not updated if the image is changed.- Specified by:
getData
in interfaceRenderedImage
- Returns:
- a
Raster
that is a copy of the image data. - See Also:
-
getData
Computes and returns an arbitrary region of theBufferedImage
. TheRaster
returned is a copy of the image data and is not updated if the image is changed.- Specified by:
getData
in interfaceRenderedImage
- Parameters:
rect
- the region of theBufferedImage
to be returned.- Returns:
- a
Raster
that is a copy of the image data of the specified region of theBufferedImage
- See Also:
-
copyData
Computes an arbitrary rectangular region of theBufferedImage
and copies it into a specifiedWritableRaster
. The region to be computed is determined from the bounds of the specifiedWritableRaster
. The specifiedWritableRaster
must have aSampleModel
that is compatible with this image. IfoutRaster
isnull
, an appropriateWritableRaster
is created.- Specified by:
copyData
in interfaceRenderedImage
- Parameters:
outRaster
- aWritableRaster
to hold the returned part of the image, ornull
- Returns:
- a reference to the supplied or created
WritableRaster
.
-
setData
Sets a rectangular region of the image to the contents of the specifiedRaster r
, which is assumed to be in the same coordinate space as theBufferedImage
. The operation is clipped to the bounds of theBufferedImage
.- Specified by:
setData
in interfaceWritableRenderedImage
- Parameters:
r
- the specifiedRaster
- See Also:
-
addTileObserver
Adds a tile observer. If the observer is already present, it receives multiple notifications.This method ignores its parameters and does nothing, since
BufferedImage
is always checked out for writing and cannot be made read-only, so there can never be events to dispatch.- Specified by:
addTileObserver
in interfaceWritableRenderedImage
- Parameters:
to
- the specifiedTileObserver
-
removeTileObserver
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.This method ignores the given observer, since
addTileObserver(TileObserver)
adds none.- Specified by:
removeTileObserver
in interfaceWritableRenderedImage
- Parameters:
to
- the specifiedTileObserver
.
-
isTileWritable
public boolean isTileWritable(int tileX, int tileY) Returns whether or not a tile is currently checked out for writing. The only tile in aBufferedImage
is at (0,0) and it is always writable, so calling this method with (0,0) will always returntrue
, and any other coordinate will cause an exception to be thrown.- Specified by:
isTileWritable
in interfaceWritableRenderedImage
- Parameters:
tileX
- the x index of the tile.tileY
- the y index of the tile.- Returns:
true
if the tile specified by the specified indices is checked out for writing;false
otherwise.- Throws:
IllegalArgumentException
- if eithertileX
ortileY
is not equal to 0
-
getWritableTileIndices
Returns an array ofPoint
objects indicating which tiles are checked out for writing. Returnsnull
if none are checked out.Since a
BufferedImage
consists of a single tile, and that tile is always checked out for writing, this method returns an array of one point. Further, the offset shall be consistent withgetMinTileX()
andgetMinTileY()
, which are always (0,0) inBufferedImage
. That will always be the coordinates of the single returnedPoint
.- Specified by:
getWritableTileIndices
in interfaceWritableRenderedImage
- Returns:
- a
Point
array that indicates the tiles that are checked out for writing, ornull
if no tiles are checked out for writing.
-
hasTileWriters
public boolean hasTileWriters()Returns whether or not any tile is checked out for writing. Semantically equivalent to(getWritableTileIndices() != null).
- Specified by:
hasTileWriters
in interfaceWritableRenderedImage
- Returns:
true
if any tile is checked out for writing;false
otherwise.
-
getWritableTile
Checks out a tile for writing. All registeredTileObservers
are notified when a tile goes from having no writers to having one writer.This method unconditionally returns the single tile without checking the passed values. No listeners are notified since the returned tile is always checked out for writing.
- Specified by:
getWritableTile
in interfaceWritableRenderedImage
- Parameters:
tileX
- the x index of the tiletileY
- the y index of the tile- Returns:
- a
WritableRaster
that is the tile, indicated by the specified indices, to be checked out for writing.
-
releaseWritableTile
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 togetWritableTile(int, int)
. Any other leads to undefined results. All registeredTileObservers
are notified when a tile goes from having one writer to having no writers.This method immediately returns without checking the passed values. No listeners are notified since the single tile is always checked out for writing.
- Specified by:
releaseWritableTile
in interfaceWritableRenderedImage
- Parameters:
tileX
- the x index of the tiletileY
- the y index of the tile
-
getTransparency
public int getTransparency()Returns the transparency. Returns either OPAQUE, BITMASK, or TRANSLUCENT.- Specified by:
getTransparency
in interfaceTransparency
- Returns:
- the transparency of this
BufferedImage
. - Since:
- 1.5
- See Also:
-