java.awt.image

Interface ImageConsumer

public interface ImageConsumer

An object implementing the ImageProducer interface can use objects implementing this interface to deliver the image data.

Field Summary
int	COMPLETESCANLINES The pixel order is in multiples of complete scanlines.
int	IMAGEABORTED Production of the image has been aborted.
int	IMAGEERROR Indicates an error occurred while producing an image.
int	RANDOMPIXELORDER The pixel order may be random.
int	SINGLEFRAME The pixels will be delivered with multiple calls to `setPixels`.
int	SINGLEFRAMEDONE A single frame is complete but more will follow.
int	SINGLEPASS The pixels will be delivered in a single pass.
int	STATICIMAGEDONE The image is complete and no more pixels or frames will follow.
int	TOPDOWNLEFTRIGHT The pixel order is top-down, left-right.

Method Summary
void	imageComplete(int status) The `ImageProducer` calls this method to indicate a single frame or the entire image is complete.
void	setColorModel(ColorModel model) This `ColorModel` should indicate the model used by the majority of calls to `setPixels`.
void	setDimensions(int width, int height) An `ImageProducer` indicates the size of the image being produced using this method.
void	setHints(int flags) The `ImageProducer` should call this method with a bit mask of hints from any of `RANDOMPIXELORDER`, `TOPDOWNLEFTRIGHT`, `COMPLETESCANLINES`, `SINGLEPASS`, `SINGLEFRAME`.
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int offset, int scansize) Deliver a subset of an ImageProducer's pixels to this ImageConsumer.
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int offset, int scansize) Deliver a subset of an ImageProducer's pixels to this ImageConsumer.
void	setProperties(Hashtable<?,?> props) An `ImageProducer` can set a list of properties associated with this image by using this method.

Field Detail

COMPLETESCANLINES

public int COMPLETESCANLINES

The pixel order is in multiples of complete scanlines.

See Also: ImageConsumer

IMAGEABORTED

public int IMAGEABORTED

Production of the image has been aborted.

See Also: ImageConsumer

IMAGEERROR

public int IMAGEERROR

Indicates an error occurred while producing an image.

See Also: ImageConsumer

RANDOMPIXELORDER

public int RANDOMPIXELORDER

The pixel order may be random. This should be the default assumption of the ImageConsumer.

See Also: ImageConsumer

The pixels will be delivered with multiple calls to setPixels. The image contains a single frame which ends when imageComplete is called with the STATICIMAGEDONE flag. If the image is constantly changing such as with video then the end of each frame is marked by a similar call to imageComplete with the SINGLEFRAMEDONE flag.

SINGLEFRAMEDONE

public int SINGLEFRAMEDONE

A single frame is complete but more will follow.

See Also: ImageConsumer

SINGLEPASS

public int SINGLEPASS

The pixels will be delivered in a single pass. There is at most one call to setPixels for any single pixel.

STATICIMAGEDONE

public int STATICIMAGEDONE

The image is complete and no more pixels or frames will follow.

See Also: ImageConsumer

TOPDOWNLEFTRIGHT

public int TOPDOWNLEFTRIGHT

The pixel order is top-down, left-right.

See Also: ImageConsumer

Method Detail

imageComplete

public void imageComplete(int status)

The ImageProducer calls this method to indicate a single frame or the entire image is complete. The method is also used to indicate an error in loading or producing the image.

Parameters: status the status of image production, represented by a bitwise OR of ImageConsumer flags

setColorModel

public void setColorModel(ColorModel model)

This ColorModel should indicate the model used by the majority of calls to setPixels. Each call to setPixels could however indicate a different ColorModel.

Parameters: model the color model to be used most often by setPixels

setDimensions

public void setDimensions(int width, int height)

An ImageProducer indicates the size of the image being produced using this method.

Parameters: width the width of the image height the height of the image

setHints

public void setHints(int flags)

The ImageProducer should call this method with a bit mask of hints from any of RANDOMPIXELORDER, TOPDOWNLEFTRIGHT, COMPLETESCANLINES, SINGLEPASS, SINGLEFRAME.

Parameters: flags a bit mask of hints

setPixels

public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int offset, int scansize)

Deliver a subset of an ImageProducer's pixels to this ImageConsumer. Each element of the pixels array represents one pixel. The pixel data is formatted according to the color model model. The x and y parameters are the coordinates of the block of pixels being delivered to this ImageConsumer. They are specified relative to the top left corner of the image being produced. Likewise, w and h are the pixel block's dimensions.

Parameters: x x coordinate of pixel block y y coordinate of pixel block w width of pixel block h height of pixel block model color model used to interpret pixel data pixels pixel block data offset offset into pixels array scansize width of one row in the pixel block

setPixels

public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int offset, int scansize)

Deliver a subset of an ImageProducer's pixels to this ImageConsumer. Each element of the pixels array represents one pixel. The pixel data is formatted according to the color model model. The x and y parameters are the coordinates of the rectangular region of pixels being delivered to this ImageConsumer, specified relative to the top left corner of the image being produced. Likewise, w and h are the pixel region's dimensions.

setProperties

public void setProperties(Hashtable<?,?> props)

An ImageProducer can set a list of properties associated with this image by using this method.

Parameters: props the list of properties associated with this image