java.awt.image.PixelGrabber Maven / Gradle / Ivy
/*
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 217: Personal Basis
Profile 1.1. In the event of a discrepency between this work and the
JSR 217 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence.
*/
package java.awt.image;
import java.util.Hashtable;
import java.awt.image.ImageProducer;
import java.awt.image.ImageConsumer;
import java.awt.image.ColorModel;
import java.awt.Image;
/**
* The PixelGrabber class implements an ImageConsumer which can be attached
* to an Image or ImageProducer object to retrieve a subset of the pixels
* in that image. Here is an example:
*
*
* public void handlesinglepixel(int x, int y, int pixel) {
* int alpha = (pixel >> 24) & 0xff;
* int red = (pixel >> 16) & 0xff;
* int green = (pixel >> 8) & 0xff;
* int blue = (pixel ) & 0xff;
* // Deal with the pixel as necessary...
* }
*
* public void handlepixels(Image img, int x, int y, int w, int h) {
* int[] pixels = new int[w * h];
* PixelGrabber pg = new PixelGrabber(img, x, y, w, h, pixels, 0, w);
* try {
* pg.grabPixels();
* } catch (InterruptedException e) {
* System.err.println("interrupted waiting for pixels!");
* return;
* }
* if ((pg.getStatus() & ImageObserver.ABORT) != 0) {
* System.err.println("image fetch aborted or errored");
* return;
* }
* for (int j = 0; j < h; j++) {
* for (int i = 0; i < w; i++) {
* handlesinglepixel(x+i, y+j, pixels[j * w + i]);
* }
* }
* }
*
*
*
* @see ColorModel#getRGBdefault
*
* @version 1.22, 01/23/03
* @author Jim Graham
*/
public class PixelGrabber implements java.awt.image.ImageConsumer
{
/**
* Create a PixelGrabber object to grab the (x, y, w, h) rectangular
* section of pixels from the specified image into the given array.
* The pixels are stored into the array in the default RGB ColorModel.
* The RGB data for pixel (i, j) where (i, j) is inside the rectangle
* (x, y, w, h) is stored in the array at
* pix[(j - y) * scansize + (i - x) + off].
* @see ColorModel#getRGBdefault
* @param img the image to retrieve pixels from
* @param x the x coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image, relative to the default
* (unscaled) size of the image
* @param y the y coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image
* @param w the width of the rectangle of pixels to retrieve
* @param h the height of the rectangle of pixels to retrieve
* @param pix the array of integers which are to be used to hold the
* RGB pixels retrieved from the image
* @param off the offset into the array of where to store the first pixel
* @param scansize the distance from one row of pixels to the next in
* the array
*/
public PixelGrabber(Image img, int x, int y, int w, int h, int[] pix, int
off, int scansize)
{ }
/**
* Create a PixelGrabber object to grab the (x, y, w, h) rectangular
* section of pixels from the image produced by the specified
* ImageProducer into the given array.
* The pixels are stored into the array in the default RGB ColorModel.
* The RGB data for pixel (i, j) where (i, j) is inside the rectangle
* (x, y, w, h) is stored in the array at
* pix[(j - y) * scansize + (i - x) + off].
* @param ip the ImageProducer that produces the
* image from which to retrieve pixels
* @param x the x coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image, relative to the default
* (unscaled) size of the image
* @param y the y coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image
* @param w the width of the rectangle of pixels to retrieve
* @param h the height of the rectangle of pixels to retrieve
* @param pix the array of integers which are to be used to hold the
* RGB pixels retrieved from the image
* @param off the offset into the array of where to store the first pixel
* @param scansize the distance from one row of pixels to the next in
* the array
* @see ColorModel#getRGBdefault
*/
public PixelGrabber(java.awt.image.ImageProducer ip, int x, int y, int w,
int h, int[] pix, int off, int scansize)
{ }
/**
* Create a PixelGrabber object to grab the (x, y, w, h) rectangular
* section of pixels from the specified image. The pixels are
* accumulated in the original ColorModel if the same ColorModel
* is used for every call to setPixels, otherwise the pixels are
* accumulated in the default RGB ColorModel. If the forceRGB
* parameter is true, then the pixels will be accumulated in the
* default RGB ColorModel anyway. A buffer is allocated by the
* PixelGrabber to hold the pixels in either case. If (w < 0) or
* (h < 0), then they will default to the remaining width and
* height of the source data when that information is delivered.
* @param img the image to retrieve the image data from
* @param x the x coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image, relative to the default
* (unscaled) size of the image
* @param y the y coordinate of the upper left corner of the rectangle
* of pixels to retrieve from the image
* @param w the width of the rectangle of pixels to retrieve
* @param h the height of the rectangle of pixels to retrieve
* @param forceRGB true if the pixels should always be converted to
* the default RGB ColorModel
*/
public PixelGrabber(Image img, int x, int y, int w, int h, boolean forceRGB)
{ }
/**
* Request the PixelGrabber to start fetching the pixels.
*/
public synchronized void startGrabbing() { }
/**
* Request the PixelGrabber to abort the image fetch.
*/
public synchronized void abortGrabbing() { }
/**
* Request the Image or ImageProducer to start delivering pixels and
* wait for all of the pixels in the rectangle of interest to be
* delivered.
* @return true if the pixels were successfully grabbed, false on
* abort, error or timeout
* @exception InterruptedException
* Another thread has interrupted this thread.
*/
public boolean grabPixels() throws InterruptedException { return false; }
/**
* Request the Image or ImageProducer to start delivering pixels and
* wait for all of the pixels in the rectangle of interest to be
* delivered or until the specified timeout has elapsed. This method
* behaves in the following ways, depending on the value of
* ms:
*
* - If
ms == 0, waits until all pixels are delivered
* - If
ms > 0, waits until all pixels are delivered
* as timeout expires.
* - If
ms < 0, returns true if all pixels
* are grabbed, false otherwise and does not wait.
*
* @param ms the number of milliseconds to wait for the image pixels
* to arrive before timing out
* @return true if the pixels were successfully grabbed, false on
* abort, error or timeout
* @exception InterruptedException
* Another thread has interrupted this thread.
*/
public synchronized boolean grabPixels(long ms) throws InterruptedException
{ return false; }
/**
* Return the status of the pixels. The ImageObserver flags
* representing the available pixel information are returned.
* @return the bitwise OR of all relevant ImageObserver flags
* @see ImageObserver
*/
public synchronized int getStatus() { return 0; }
/**
* Get the width of the pixel buffer (after adjusting for image width).
* If no width was specified for the rectangle of pixels to grab then
* then this information will only be available after the image has
* delivered the dimensions.
* @return the final width used for the pixel buffer or -1 if the width
* is not yet known
* @see #getStatus
*/
public synchronized int getWidth() { return 0; }
/**
* Get the height of the pixel buffer (after adjusting for image height).
* If no width was specified for the rectangle of pixels to grab then
* then this information will only be available after the image has
* delivered the dimensions.
* @return the final height used for the pixel buffer or -1 if the height
* is not yet known
* @see #getStatus
*/
public synchronized int getHeight() { return 0; }
/**
* Get the pixel buffer. If the PixelGrabber was not constructed
* with an explicit pixel buffer to hold the pixels then this method
* will return null until the size and format of the image data is
* known.
* Since the PixelGrabber may fall back on accumulating the data
* in the default RGB ColorModel at any time if the source image
* uses more than one ColorModel to deliver the data, the array
* object returned by this method may change over time until the
* image grab is complete.
* @return either a byte array or an int array
* @see #getStatus
* @see #setPixels(int, int, int, int, ColorModel, byte[], int, int)
* @see #setPixels(int, int, int, int, ColorModel, int[], int, int)
*/
public synchronized Object getPixels() { return null; }
/**
* Get the ColorModel for the pixels stored in the array. If the
* PixelGrabber was constructed with an explicit pixel buffer then
* this method will always return the default RGB ColorModel,
* otherwise it may return null until the ColorModel used by the
* ImageProducer is known.
* Since the PixelGrabber may fall back on accumulating the data
* in the default RGB ColorModel at any time if the source image
* uses more than one ColorModel to deliver the data, the ColorModel
* object returned by this method may change over time until the
* image grab is complete and may not reflect any of the ColorModel
* objects that was used by the ImageProducer to deliver the pixels.
* @return the ColorModel object used for storing the pixels
* @see #getStatus
* @see ColorModel#getRGBdefault
* @see #setColorModel(ColorModel)
*/
public synchronized java.awt.image.ColorModel getColorModel() { return null; }
/**
* The setDimensions method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param width the width of the dimension
* @param height the height of the dimension
*/
public void setDimensions(int width, int height) { }
/**
* The setHints method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param hints a set of hints used to process the pixels
*/
public void setHints(int hints) { }
/**
* The setProperties method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param props the list of properties
*/
public void setProperties(Hashtable props) { }
/**
* The setColorModel method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param model the specified ColorModel
* @see #getColorModel
*/
public void setColorModel(java.awt.image.ColorModel model) { }
/**
* The setPixels method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param srcX, srcY the coordinates of the upper-left corner
* of the area of pixels to be set
* @param srcW the width of the area of pixels
* @param srcH the height of the area of pixels
* @param model the specified ColorModel
* @param pixels the array of pixels
* @param srcOff the offset into the pixels array
* @param srcScan the distance from one row of pixels to the next
* in the pixels array
* @see #getPixels
*/
public void setPixels(int srcX, int srcY, int srcW, int srcH,
java.awt.image.ColorModel model, byte[] pixels, int srcOff, int srcScan)
{ }
/**
* The setPixels method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param srcX, srcY the coordinates of the upper-left corner
* of the area of pixels to be set
* @param srcW the width of the area of pixels
* @param srcH the height of the area of pixels
* @param model the specified ColorModel
* @param pixels the array of pixels
* @param srcOff the offset into the pixels array
* @param srcScan the distance from one row of pixels to the next
* in the pixels array
* @see #getPixels
*/
public void setPixels(int srcX, int srcY, int srcW, int srcH,
java.awt.image.ColorModel model, int[] pixels, int srcOff, int srcScan)
{ }
/**
* The imageComplete method is part of the ImageConsumer API which
* this class must implement to retrieve the pixels.
*
* Note: This method is intended to be called by the ImageProducer
* of the Image whose pixels are being grabbed. Developers using
* this class to retrieve pixels from an image should avoid calling
* this method directly since that operation could result in problems
* with retrieving the requested pixels.
* @param status the status of image loading
*/
public synchronized void imageComplete(int status) { }
/**
* Returns the status of the pixels. The ImageObserver flags
* representing the available pixel information are returned.
* This method and {@link #getStatus() getStatus} have the
* same implementation, but getStatus is the
* preferred method because it conforms to the convention of
* naming information-retrieval methods with the form
* "getXXX".
* @return the bitwise OR of all relevant ImageObserver flags
* @see ImageObserver
* @see #getStatus()
*/
public synchronized int status() { return 0; }
}