java.lang.Object | ||
↳ | java.awt.Image | |
↳ | java.awt.image.BufferedImage |
Known Direct Subclasses |
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
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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. | |||||||||
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. | |||||||||
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. | |||||||||
int | TYPE_BYTE_BINARY | Represents an opaque byte-packed 1, 2, or 4 bit image. | |||||||||
int | TYPE_BYTE_GRAY | Represents a unsigned byte grayscale image, non-indexed. | |||||||||
int | TYPE_BYTE_INDEXED | Represents an indexed byte image. | |||||||||
int | TYPE_CUSTOM | Image type is not recognized so it must be a customized image. | |||||||||
int | TYPE_INT_ARGB | Represents an image with 8-bit RGBA color components packed into integer pixels. | |||||||||
int | TYPE_INT_ARGB_PRE | Represents an image with 8-bit RGBA color components packed into integer pixels. | |||||||||
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. | |||||||||
int | TYPE_INT_RGB | Represents an image with 8-bit RGB color components packed into integer pixels. | |||||||||
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. | |||||||||
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. | |||||||||
int | TYPE_USHORT_GRAY | Represents an unsigned short grayscale image, non-indexed). |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.Image
| |||||||||||
From interface
java.awt.Transparency
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.Image
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a
BufferedImage of one of the predefined
image types. | |||||||||||
Constructs a
BufferedImage of one of the predefined
image types:
TYPE_BYTE_BINARY or TYPE_BYTE_INDEXED. | |||||||||||
Constructs a new
BufferedImage with a specified
ColorModel and Raster . |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a tile observer.
| |||||||||||
Forces the data to match the state specified in the
isAlphaPremultiplied variable. | |||||||||||
Computes an arbitrary rectangular region of the
BufferedImage and copies it into a specified
WritableRaster . | |||||||||||
Creates a
Graphics2D , which can be used to draw into
this BufferedImage . | |||||||||||
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 the
ColorModel . | |||||||||||
Computes and returns an arbitrary region of the
BufferedImage . | |||||||||||
Returns the image as one large tile.
| |||||||||||
This method returns a
Graphics2D , but is here
for backwards compatibility. | |||||||||||
Returns the height of the
BufferedImage . | |||||||||||
Returns the height of the
BufferedImage . | |||||||||||
Returns the minimum tile index in the x direction.
| |||||||||||
Returns the minimum tile index in the y direction.
| |||||||||||
Returns the minimum x coordinate of this
BufferedImage . | |||||||||||
Returns the minimum y coordinate of this
BufferedImage . | |||||||||||
Returns the number of tiles in the x direction.
| |||||||||||
Returns the number of tiles in the y direction.
| |||||||||||
Returns a property of the image by name.
| |||||||||||
Returns a property of the image by name.
| |||||||||||
Returns an array of names recognized by
getProperty(String)
or null , if no property names are recognized. | |||||||||||
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 an integer pixel in the default RGB color model
(TYPE_INT_ARGB) and default sRGB colorspace.
| |||||||||||
Returns the
WritableRaster . | |||||||||||
Returns the
SampleModel associated with this
BufferedImage . | |||||||||||
Returns the object that produces the pixels for the image.
| |||||||||||
Returns a
Vector of RenderedImage objects that are
the immediate sources, not the sources of these immediate sources,
of image data for this BufferedImage . | |||||||||||
Returns a subimage defined by a specified rectangular region.
| |||||||||||
Returns tile (
tileX , tileY ). | |||||||||||
Returns the x offset of the tile grid relative to the origin,
For example, the x coordinate of the location of tile
(0, 0).
| |||||||||||
Returns the y offset of the tile grid relative to the origin,
For example, the y coordinate of the location of tile
(0, 0).
| |||||||||||
Returns the tile height in pixels.
| |||||||||||
Returns the tile width in pixels.
| |||||||||||
Returns the transparency.
| |||||||||||
Returns the image type.
| |||||||||||
Returns the width of the
BufferedImage . | |||||||||||
Returns the width of the
BufferedImage . | |||||||||||
Checks out a tile for writing.
| |||||||||||
Returns an array of
Point objects indicating which tiles
are checked out for writing. | |||||||||||
Returns whether or not any tile is checked out for writing.
| |||||||||||
Returns whether or not the alpha has been premultiplied.
| |||||||||||
Returns whether or not a tile is currently checked out for writing.
| |||||||||||
Relinquishes permission to write to a tile.
| |||||||||||
Removes a tile observer.
| |||||||||||
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 . | |||||||||||
Sets a pixel in this
BufferedImage to the specified
RGB value. | |||||||||||
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.
| |||||||||||
Returns a
String representation of this
BufferedImage object and its values. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.Image
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.awt.Transparency
| |||||||||||
From interface
java.awt.image.RenderedImage
| |||||||||||
From interface
java.awt.image.WritableRenderedImage
|
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 image |
---|---|
height | height of the created image |
imageType | type of the created image |
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 image |
---|---|
height | height of the created image |
imageType | type of the created image |
cm | IndexColorModel of the created image |
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. |
---|
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 image |
---|---|
raster | Raster for the image data |
isRasterPremultiplied | if true , the data in
the raster has been premultiplied with alpha. |
properties | Hashtable of
String /Object pairs. |
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. |
|
if
raster is incompatible with cm |
Adds a tile observer. If the observer is already present, it receives multiple notifications.
to | the specified TileObserver
|
---|
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.
|
---|
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.
outRaster | a WritableRaster to hold the returned
part of the image, or null |
---|
WritableRaster
.
Creates a Graphics2D
, which can be used to draw into
this BufferedImage
.
Graphics2D
, used for drawing into this
image.
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
.
Returns the ColorModel
.
ColorModel
of this
BufferedImage
.
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.
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
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.
Raster
that is a copy of the image data.This method returns a Graphics2D
, but is here
for backwards compatibility. createGraphics
is more
convenient, since it is declared to return a
Graphics2D
.
Graphics2D
, which can be used to draw into
this image.
Returns the height of the BufferedImage
.
BufferedImage
Returns the height of the BufferedImage
.
observer | ignored |
---|
BufferedImage
Returns the minimum tile index in the x direction. This is always zero.
Returns the minimum tile index in the y direction. This is always zero.
Returns the minimum x coordinate of this
BufferedImage
. This is always zero.
BufferedImage
.
Returns the minimum y coordinate of this
BufferedImage
. This is always zero.
BufferedImage
.
Returns the number of tiles in the x direction. This is always one.
Returns the number of tiles in the y direction. This is always one.
Returns a property of the image by name.
name | the property name |
---|
Object
that is the property referred to by
the specified name
.if the property name is null. |
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.
name | the property name |
---|---|
observer | the ImageObserver that receives
notification regarding image information |
Object
that is the property referred to by the
specified name
or null
if the
properties of this image are not yet known.if the property name is null. |
Returns an array of names recognized by
getProperty(String)
or null
, if no property names are recognized.
String
array containing all of the property
names that getProperty(String)
recognizes;
or null
if no property names are recognized.
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 coordinate |
---|---|
startY | the starting Y coordinate |
w | width of region |
h | height of region |
rgbArray | if not null , the rgb pixels are
written here |
offset | offset into the rgbArray |
scansize | scanline stride for the rgbArray |
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 space |
---|---|
y | the Y coordinate of the pixel from which to get the pixel in the default RGB color model and sRGB color space |
Returns the WritableRaster
.
WriteableRaster
of this
BufferedImage
.
Returns the SampleModel
associated with this
BufferedImage
.
SampleModel
of this
BufferedImage
.
Returns the object that produces the pixels for the image.
ImageProducer
that is used to produce the
pixels for this image.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.
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.
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 region |
---|---|
y | the Y coordinate of the upper-left corner of the specified rectangular region |
w | the width of the specified rectangular region |
h | the height of the specified rectangular region |
BufferedImage
that is the subimage of this
BufferedImage
.if the specified
area is not contained within this BufferedImage .
|
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.
tileX | the x index of the requested tile in the tile array |
---|---|
tileY | the y index of the requested tile in the tile array |
Raster
that is the tile defined by the
arguments tileX
and tileY
.if both
tileX and tileY are not
equal to 0
|
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.
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.
Returns the tile height in pixels.
Returns the tile width in pixels.
Returns the transparency. Returns either OPAQUE, BITMASK, or TRANSLUCENT.
BufferedImage
.Returns the image type. If it is not one of the known types, TYPE_CUSTOM is returned.
BufferedImage
.Returns the width of the BufferedImage
.
BufferedImage
Returns the width of the BufferedImage
.
observer | ignored |
---|
BufferedImage
Checks out a tile for writing. All registered
TileObservers
are notified when a tile goes from having
no writers to having one writer.
tileX | the x index of the tile |
---|---|
tileY | the y index of the tile |
WritableRaster
that is the tile, indicated by
the specified indices, to be checked out for writing.
Returns an array of Point
objects indicating which tiles
are checked out for writing. Returns null
if none are
checked out.
Point
array that indicates the tiles that
are checked out for writing, or null
if no
tiles are checked out for writing.
Returns whether or not any tile is checked out for writing. Semantically equivalent to
(getWritableTileIndices() != null).
true
if any tile is checked out for writing;
false
otherwise.
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.
Returns whether or not a tile is currently checked out for writing.
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.if both
tileX and tileY are not equal
to 0
|
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.
tileX | the x index of the tile |
---|---|
tileY | the y index of the tile |
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.
to | the specified TileObserver .
|
---|
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
.
r | the specified Raster |
---|
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 set |
---|---|
y | the Y coordinate of the pixel to set |
rgb | the RGB value |
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 coordinate |
---|---|
startY | the starting Y coordinate |
w | width of the region |
h | height of the region |
rgbArray | the rgb pixels |
offset | offset into the rgbArray |
scansize | scanline stride for the rgbArray |
Returns a String
representation of this
BufferedImage
object and its values.
String
representing this
BufferedImage
.