Class MemoryImageSource
java.lang.Object
java.awt.image.MemoryImageSource
- All Implemented Interfaces:
ImageProducer
This class is an implementation of the ImageProducer interface which
uses an array to produce pixel values for an Image. Here is an example
which calculates a 100x100 image representing a fade from black to blue
along the X axis and a fade from black to red along the Y axis:
int w = 100;
int h = 100;
int pix[] = new int[w * h];
int index = 0;
for (int y = 0; y < h; y++) {
int red = (y * 255) / (h - 1);
for (int x = 0; x < w; x++) {
int blue = (x * 255) / (w - 1);
pix[index++] = (255 << 24) | (red << 16) | blue;
}
}
Image img = createImage(new MemoryImageSource(w, h, pix, 0, w));
The MemoryImageSource is also capable of managing a memory image which
varies over time to allow animation or custom rendering. Here is an
example showing how to set up the animation source and signal changes
in the data (adapted from the MemoryAnimationSourceDemo by Garth Dickie):
int pixels[];
MemoryImageSource source;
public void init() {
int width = 50;
int height = 50;
int size = width * height;
pixels = new int[size];
int value = getBackground().getRGB();
for (int i = 0; i < size; i++) {
pixels[i] = value;
}
source = new MemoryImageSource(width, height, pixels, 0, width);
source.setAnimated(true);
image = createImage(source);
}
public void run() {
Thread me = Thread.currentThread( );
me.setPriority(Thread.MIN_PRIORITY);
while (true) {
try {
Thread.sleep(10);
} catch( InterruptedException e ) {
return;
}
// Modify the values in the pixels array at (x, y, w, h)
// Send the new data to the interested ImageConsumers
source.newPixels(x, y, w, h);
}
}
- See Also:
-
Constructor Summary
ConstructorDescriptionMemoryImageSource
(int w, int h, int[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object.MemoryImageSource
(int w, int h, int[] pix, int off, int scan, Hashtable<?, ?> props) Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object.MemoryImageSource
(int w, int h, ColorModel cm, byte[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object.MemoryImageSource
(int w, int h, ColorModel cm, byte[] pix, int off, int scan, Hashtable<?, ?> props) Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object.MemoryImageSource
(int w, int h, ColorModel cm, int[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of integers to produce data for an Image object.MemoryImageSource
(int w, int h, ColorModel cm, int[] pix, int off, int scan, Hashtable<?, ?> props) Constructs an ImageProducer object which uses an array of integers to produce data for an Image object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds an ImageConsumer to the list of consumers interested in data for this image.boolean
Determines if an ImageConsumer is on the list of consumers currently interested in data for this image.void
Sends a whole new buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete.void
newPixels
(byte[] newpix, ColorModel newmodel, int offset, int scansize) Changes to a new byte array to hold the pixels for this image.void
newPixels
(int[] newpix, ColorModel newmodel, int offset, int scansize) Changes to a new int array to hold the pixels for this image.void
newPixels
(int x, int y, int w, int h) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete.void
newPixels
(int x, int y, int w, int h, boolean framenotify) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image.void
Removes an ImageConsumer from the list of consumers interested in data for this image.void
Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order.void
setAnimated
(boolean animated) Changes this memory image into a multi-frame animation or a single-frame static image depending on the animated parameter.void
setFullBufferUpdates
(boolean fullbuffers) Specifies whether this animated memory image should always be updated by sending the complete buffer of pixels whenever there is a change.void
Adds an ImageConsumer to the list of consumers interested in data for this image and immediately starts delivery of the image data through the ImageConsumer interface.
-
Constructor Details
-
MemoryImageSource
Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelscm
- the specifiedColorModel
pix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the array- See Also:
-
MemoryImageSource
public MemoryImageSource(int w, int h, ColorModel cm, byte[] pix, int off, int scan, Hashtable<?, ?> props) Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelscm
- the specifiedColorModel
pix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the arrayprops
- a list of properties that theImageProducer
uses to process an image- See Also:
-
MemoryImageSource
Constructs an ImageProducer object which uses an array of integers to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelscm
- the specifiedColorModel
pix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the array- See Also:
-
MemoryImageSource
public MemoryImageSource(int w, int h, ColorModel cm, int[] pix, int off, int scan, Hashtable<?, ?> props) Constructs an ImageProducer object which uses an array of integers to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelscm
- the specifiedColorModel
pix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the arrayprops
- a list of properties that theImageProducer
uses to process an image- See Also:
-
MemoryImageSource
public MemoryImageSource(int w, int h, int[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelspix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the array- See Also:
-
MemoryImageSource
Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object.- Parameters:
w
- the width of the rectangle of pixelsh
- the height of the rectangle of pixelspix
- an array of pixelsoff
- the offset into the array of where to store the first pixelscan
- the distance from one row of pixels to the next in the arrayprops
- a list of properties that theImageProducer
uses to process an image- See Also:
-
-
Method Details
-
addConsumer
Adds an ImageConsumer to the list of consumers interested in data for this image.- Specified by:
addConsumer
in interfaceImageProducer
- Parameters:
ic
- the specifiedImageConsumer
- Throws:
NullPointerException
- if the specifiedImageConsumer
is null- See Also:
-
isConsumer
Determines if an ImageConsumer is on the list of consumers currently interested in data for this image.- Specified by:
isConsumer
in interfaceImageProducer
- Parameters:
ic
- the specifiedImageConsumer
- Returns:
true
if theImageConsumer
is on the list;false
otherwise.- See Also:
-
removeConsumer
Removes an ImageConsumer from the list of consumers interested in data for this image.- Specified by:
removeConsumer
in interfaceImageProducer
- Parameters:
ic
- the specifiedImageConsumer
- See Also:
-
startProduction
Adds an ImageConsumer to the list of consumers interested in data for this image and immediately starts delivery of the image data through the ImageConsumer interface.- Specified by:
startProduction
in interfaceImageProducer
- Parameters:
ic
- the specifiedImageConsumer
image data through the ImageConsumer interface.- See Also:
-
requestTopDownLeftRightResend
Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order.- Specified by:
requestTopDownLeftRightResend
in interfaceImageProducer
- Parameters:
ic
- the specifiedImageConsumer
- See Also:
-
setAnimated
public void setAnimated(boolean animated) Changes this memory image into a multi-frame animation or a single-frame static image depending on the animated parameter.This method should be called immediately after the MemoryImageSource is constructed and before an image is created with it to ensure that all ImageConsumers will receive the correct multi-frame data. If an ImageConsumer is added to this ImageProducer before this flag is set then that ImageConsumer will see only a snapshot of the pixel data that was available when it connected.
- Parameters:
animated
-true
if the image is a multi-frame animation
-
setFullBufferUpdates
public void setFullBufferUpdates(boolean fullbuffers) Specifies whether this animated memory image should always be updated by sending the complete buffer of pixels whenever there is a change. This flag is ignored if the animation flag is not turned on through the setAnimated() method.This method should be called immediately after the MemoryImageSource is constructed and before an image is created with it to ensure that all ImageConsumers will receive the correct pixel delivery hints.
- Parameters:
fullbuffers
-true
if the complete pixel buffer should always be sent- See Also:
-
newPixels
public void newPixels()Sends a whole new buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method.- See Also:
-
newPixels
public void newPixels(int x, int y, int w, int h) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method. If the full buffer update flag was turned on with the setFullBufferUpdates() method then the rectangle parameters will be ignored and the entire buffer will always be sent.- Parameters:
x
- the x coordinate of the upper left corner of the rectangle of pixels to be senty
- the y coordinate of the upper left corner of the rectangle of pixels to be sentw
- the width of the rectangle of pixels to be senth
- the height of the rectangle of pixels to be sent- See Also:
-
newPixels
public void newPixels(int x, int y, int w, int h, boolean framenotify) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image. If the framenotify parameter is true then the consumers are also notified that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method. If the full buffer update flag was turned on with the setFullBufferUpdates() method then the rectangle parameters will be ignored and the entire buffer will always be sent.- Parameters:
x
- the x coordinate of the upper left corner of the rectangle of pixels to be senty
- the y coordinate of the upper left corner of the rectangle of pixels to be sentw
- the width of the rectangle of pixels to be senth
- the height of the rectangle of pixels to be sentframenotify
-true
if the consumers should be sent aSINGLEFRAMEDONE
notification- See Also:
-
newPixels
Changes to a new byte array to hold the pixels for this image. If the animation flag has been turned on through the setAnimated() method, then the new pixels will be immediately delivered to any ImageConsumers that are currently interested in the data for this image.- Parameters:
newpix
- the new pixel arraynewmodel
- the specifiedColorModel
offset
- the offset into the arrayscansize
- the distance from one row of pixels to the next in the array- See Also:
-
newPixels
Changes to a new int array to hold the pixels for this image. If the animation flag has been turned on through the setAnimated() method, then the new pixels will be immediately delivered to any ImageConsumers that are currently interested in the data for this image.- Parameters:
newpix
- the new pixel arraynewmodel
- the specifiedColorModel
offset
- the offset into the arrayscansize
- the distance from one row of pixels to the next in the array- See Also:
-