All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Interface java.awt.image.RenderedImage

public interface RenderedImage

getColorModel()

Return the ColorModel associated with this image.

getData()

Return the image as one large tile (for tile based images this will require fetching the whole image and copying the image data over).

getHeight()

Return the height of the RenderedImage.

getMaxTileX()

Return the index of the maximum tile in the X direction.

getMaxTileY()

Return the index of the maximum tile in the Y direction.

getMaxXCoord()

Return the maximum X coordinate (inclusive) of the rendered image.

getMaxYCoord()

Return the minimum Y coordinate (inclusive) of the rendered image.

getMinTileX()

Return the index of the minimum tile in the X direction.

getMinTileY()

Return the index of the minimum tile in the Y direction.

getMinXCoord()

Return the minimum X coordinate (inclusive) of the rendered image.

getMinYCoord()

Return the minimum Y coordinate (inclusive) of the rendered image.

getProperty(String)

Get a property from the property set of this image.

getPropertyNames()

Return a list of names recognized by getProperty(String).

getRect(Rectangle)

Compute and return an arbitrary region of the RenderedImage.

getRect(WritableRaster)

Compute an arbitrary rectangular region of the RenderedImage and copy it into a caller-supplied WritableRaster.

getSampleModel()

Return the SampleModel associated with this image.

getSources()

Return a vector of RenderedImages that are the sources of image data for this RenderedImage.

getTile(int, int)

Return tile (X, Y).

getTileGridXOffset()

Return the X offset of the tile grid relative to the origin, i.e., the X coordinate of the upper-left pixel of tile (0, 0).

getTileGridYOffset()

Return the Y offset of the tile grid relative to the origin, i.e., the Y coordinate of the upper-left pixel of tile (0, 0).

getTileHeight()

Return the tile height in pixels.

getTileWidth()

Return the tile width in pixels.

getWidth()

Return the width of the RenderedImage.

tilesAcross()

Return the number of tiles across the image.

tilesDown()

Return the number of tiles down the image.

public abstract Vector getSources()

Return a vector of RenderedImages that are the sources of image data for this RenderedImage. This method may return null.

public abstract Object getProperty(String name)

Get a property from the property set of this image. The set of properties is determined at construction time and is immutable.

public abstract String[] getPropertyNames()

Return a list of names recognized by getProperty(String).

public abstract ColorModel getColorModel()

Return the ColorModel associated with this image. All Rasters returned from this image will have this as their ColorModel.

public abstract SampleModel getSampleModel()

Return the SampleModel associated with this image. All Rasters returned from this image will have this as their SampleModel.

public abstract int getWidth()

Return the width of the RenderedImage. Equivalent to getMaxXCoord() - getMinXCoord() + 1.

public abstract int getHeight()

Return the height of the RenderedImage. Equivalent to getMaxYCoord() - getMinYCoord() + 1.

public abstract int getMinXCoord()

Return the minimum X coordinate (inclusive) of the rendered image. For an image with infinite extent, it could be Integer.MIN_VALUE.

public abstract int getMaxXCoord()

Return the maximum X coordinate (inclusive) of the rendered image. For an image with infinite extent, it could be Integer.MAX_VALUE.

public abstract int getMinYCoord()

Return the minimum Y coordinate (inclusive) of the rendered image. For an image with infinite extent, it could be Integer.MIN_VALUE.

public abstract int getMaxYCoord()

Return the minimum Y coordinate (inclusive) of the rendered image. For an image with infinite extent, it could be Integer.MAX_VALUE.

public abstract int tilesAcross()

Return the number of tiles across the image. Equivalent to getMaxTileX() - getMinTileX() + 1.

public abstract int tilesDown()

Return the number of tiles down the image. Equivalent to getMaxTileY() - getMinTileY() + 1.

public abstract int getMinTileX()

Return the index of the minimum tile in the X direction.

public abstract int getMaxTileX()

Return the index of the maximum tile in the X direction.

public abstract int getMinTileY()

Return the index of the minimum tile in the Y direction.

public abstract int getMaxTileY()

Return the index of the maximum tile in the Y direction.

public abstract int getTileWidth()

Return the tile width in pixels. All tiles must have the same width.

public abstract int getTileHeight()

Return the tile height in pixels. All tiles must have the same height.

public abstract int getTileGridXOffset()

Return the X offset of the tile grid relative to the origin, i.e., the X coordinate of the upper-left pixel of tile (0, 0).

public abstract int getTileGridYOffset()

Return the Y offset of the tile grid relative to the origin, i.e., the Y coordinate of the upper-left pixel of tile (0, 0).

public abstract Raster getTile(int x,
                               int y)

Return tile (X, Y). Note that X and Y are indices into the tile array, not pixel locations. The Raster that is returned is live and will be updated if the image is changed.

Parameters:

x - the X index of the requested tile in the tile array.

y - the Y index of the requested tile in the tile array.

public abstract Raster getData()

Return the image as one large tile (for tile based images this will require fetching the whole image and copying the image data over). The Raster returned is semantically a copy.

public abstract Raster getRect(Rectangle rect)

Compute and return an arbitrary region of the RenderedImage. Note that in general this may involve copying image data. The Raster returned is semantically a copy.

Parameters:

rect - the region of the RenderedImage to be returned.

public abstract WritableRaster getRect(WritableRaster raster)

Compute an arbitrary rectangular region of the RenderedImage and copy it into a caller-supplied WritableRaster. The region to be computed is determined from the bounds of the supplied WritableRaster. The supplied WritableRaster must have a ColorModel and SampleModel that are compatible with those of this image.

Parameters:

raster - a WritableRaster to hold the returned portion of the image.

Returns:

a reference to the supplied WritableRaster.

All Packages  Class Hierarchy  This Package  Previous  Next  Index