FileDocCategorySizeDatePackage
RenderedImage.javaAPI DocJava SE 5 API7158Fri Aug 26 14:56:54 BST 2005java.awt.image

RenderedImage

public interface RenderedImage
RenderedImage is a common interface for objects which contain or can produce image data in the form of Rasters. The image data may be stored/produced as a single tile or a regular array of tiles.

Fields Summary
Constructors Summary
Methods Summary
public java.awt.image.WritableRastercopyData(java.awt.image.WritableRaster raster)
Computes an arbitrary rectangular region of the RenderedImage and copies 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 SampleModel that is compatible with this image. If raster is null, an appropriate WritableRaster is created.

param
raster a WritableRaster to hold the returned portion of the image, or null.
return
a reference to the supplied or created WritableRaster.

public java.awt.image.ColorModelgetColorModel()
Returns the ColorModel associated with this image. All Rasters returned from this image will have this as their ColorModel. This can return null.

return
the ColorModel of this image.

public java.awt.image.RastergetData()
Returns 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 a copy of the image data and will not be updated if the image is changed.

return
the image as one large tile.

public java.awt.image.RastergetData(java.awt.Rectangle rect)
Computes and returns an arbitrary region of the RenderedImage. The Raster returned is a copy of the image data and will not be updated if the image is changed.

param
rect the region of the RenderedImage to be returned.
return
the region of the RenderedImage indicated by the specified Rectangle.

public intgetHeight()
Returns the height of the RenderedImage.

return
the height of this RenderedImage.

public intgetMinTileX()
Returns the minimum tile index in the X direction.

return
the minimum tile index in the X direction.

public intgetMinTileY()
Returns the minimum tile index in the Y direction.

return
the minimum tile index in the X direction.

public intgetMinX()
Returns the minimum X coordinate (inclusive) of the RenderedImage.

return
the X coordinate of this RenderedImage.

public intgetMinY()
Returns the minimum Y coordinate (inclusive) of the RenderedImage.

return
the Y coordinate of this RenderedImage.

public intgetNumXTiles()
Returns the number of tiles in the X direction.

return
the number of tiles in the X direction.

public intgetNumYTiles()
Returns the number of tiles in the Y direction.

return
the number of tiles in the Y direction.

public java.lang.ObjectgetProperty(java.lang.String name)
Gets a property from the property set of this image. The set of properties and whether it is immutable is determined by the implementing class. This method returns java.awt.Image.UndefinedProperty if the specified property is not defined for this RenderedImage.

param
name the name of the property
return
the property indicated by the specified name.
see
java.awt.Image#UndefinedProperty

public java.lang.String[]getPropertyNames()
Returns an array of names recognized by {@link #getProperty(String) getProperty(String)} or null, if no property names are recognized.

return
a String array containing all of the property names that getProperty(String) recognizes; or null if no property names are recognized.

public java.awt.image.SampleModelgetSampleModel()
Returns the SampleModel associated with this image. All Rasters returned from this image will have this as their SampleModel.

return
the SampleModel of this image.

public java.util.VectorgetSources()
Returns a vector of RenderedImages that are the immediate sources of image data for this RenderedImage. This method returns null if the RenderedImage object has no information about its immediate sources. It returns an empty Vector if the RenderedImage object has no immediate sources.

return
a Vector of RenderedImage objects.

public java.awt.image.RastergetTile(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 and will be updated if the image is changed.

param
tileX the X index of the requested tile in the tile array
param
tileY the Y index of the requested tile in the tile array
return
the tile given the specified indices.

public intgetTileGridXOffset()
Returns 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). (Note that tile (0, 0) may not actually exist.)

return
the X offset of the tile grid relative to the origin.

public intgetTileGridYOffset()
Returns 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). (Note that tile (0, 0) may not actually exist.)

return
the Y offset of the tile grid relative to the origin.

public intgetTileHeight()
Returns the tile height in pixels. All tiles must have the same height.

return
the tile height in pixels.

public intgetTileWidth()
Returns the tile width in pixels. All tiles must have the same width.

return
the tile width in pixels.

public intgetWidth()
Returns the width of the RenderedImage.

return
the width of this RenderedImage.