Class MemoryImageSource
- All Implemented Interfaces:
ImageProducer
public class MemoryImageSource extends Object implements ImageProducer
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
Constructor | Description |
---|---|
MemoryImageSource |
Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object. |
MemoryImageSource |
Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object. |
MemoryImageSource |
Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object. |
MemoryImageSource |
Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object. |
MemoryImageSource |
Constructs an ImageProducer object which uses an array of integers to produce data for an Image object. |
MemoryImageSource |
Constructs an ImageProducer object which uses an array of integers to produce data for an Image object. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void |
addConsumer |
Adds an ImageConsumer to the list of consumers interested in data for this image. |
boolean |
isConsumer |
Determines if an ImageConsumer is on the list of consumers currently interested in data for this image. |
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. |
void |
newPixels |
Changes to a new byte array to hold the pixels for this image. |
void |
newPixels |
Changes to a new int array to hold the pixels for this image. |
void |
newPixels |
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 |
Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image. |
void |
removeConsumer |
Removes an ImageConsumer from the list of consumers interested in data for this image. |
void |
requestTopDownLeftRightResend |
Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order. |
void |
setAnimated |
Changes this memory image into a multi-frame animation or a single-frame static image depending on the animated parameter. |
void |
setFullBufferUpdates |
Specifies whether this animated memory image should always be updated by sending the complete buffer of pixels whenever there is a change. |
void |
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. |
Constructor Details
MemoryImageSource
public MemoryImageSource(int w, int h, ColorModel cm, byte[] pix, int off, int scan)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
cm
- the specifiedColorModel
-
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- 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)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
cm
- the specifiedColorModel
-
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- the distance from one row of pixels to the next in the array -
props
- a list of properties that theImageProducer
uses to process an image - See Also:
MemoryImageSource
public MemoryImageSource(int w, int h, ColorModel cm, int[] pix, int off, int scan)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
cm
- the specifiedColorModel
-
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- 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)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
cm
- the specifiedColorModel
-
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- the distance from one row of pixels to the next in the array -
props
- 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)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- the distance from one row of pixels to the next in the array - See Also:
MemoryImageSource
public MemoryImageSource(int w, int h, int[] pix, int off, int scan, Hashtable<?,?> props)
- Parameters:
-
w
- the width of the rectangle of pixels -
h
- the height of the rectangle of pixels -
pix
- an array of pixels -
off
- the offset into the array of where to store the first pixel -
scan
- the distance from one row of pixels to the next in the array -
props
- a list of properties that theImageProducer
uses to process an image - See Also:
Method Details
addConsumer
public void addConsumer(ImageConsumer ic)
- Specified by:
-
addConsumer
in interfaceImageProducer
- Parameters:
-
ic
- the specifiedImageConsumer
- Throws:
-
NullPointerException
- if the specifiedImageConsumer
is null - See Also:
isConsumer
public boolean isConsumer(ImageConsumer ic)
- Specified by:
-
isConsumer
in interfaceImageProducer
- Parameters:
-
ic
- the specifiedImageConsumer
- Returns:
-
true
if theImageConsumer
is on the list;false
otherwise. - See Also:
removeConsumer
public void removeConsumer(ImageConsumer ic)
- Specified by:
-
removeConsumer
in interfaceImageProducer
- Parameters:
-
ic
- the specifiedImageConsumer
- See Also:
startProduction
public void startProduction(ImageConsumer ic)
- Specified by:
-
startProduction
in interfaceImageProducer
- Parameters:
-
ic
- the specifiedImageConsumer
image data through the ImageConsumer interface. - See Also:
requestTopDownLeftRightResend
public void requestTopDownLeftRightResend(ImageConsumer ic)
- Specified by:
-
requestTopDownLeftRightResend
in interfaceImageProducer
- Parameters:
-
ic
- the specifiedImageConsumer
- See Also:
setAnimated
public void setAnimated(boolean animated)
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)
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()
newPixels
public void newPixels(int x, int y, int w, int h)
- Parameters:
-
x
- the x coordinate of the upper left corner of the rectangle of pixels to be sent -
y
- the y coordinate of the upper left corner of the rectangle of pixels to be sent -
w
- the width of the rectangle of pixels to be sent -
h
- 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)
- Parameters:
-
x
- the x coordinate of the upper left corner of the rectangle of pixels to be sent -
y
- the y coordinate of the upper left corner of the rectangle of pixels to be sent -
w
- the width of the rectangle of pixels to be sent -
h
- the height of the rectangle of pixels to be sent -
framenotify
-true
if the consumers should be sent aSINGLEFRAMEDONE
notification - See Also:
newPixels
public void newPixels(byte[] newpix, ColorModel newmodel, int offset, int scansize)
- Parameters:
-
newpix
- the new pixel array -
newmodel
- the specifiedColorModel
-
offset
- the offset into the array -
scansize
- the distance from one row of pixels to the next in the array - See Also:
newPixels
public void newPixels(int[] newpix, ColorModel newmodel, int offset, int scansize)
- Parameters:
-
newpix
- the new pixel array -
newmodel
- the specifiedColorModel
-
offset
- the offset into the array -
scansize
- the distance from one row of pixels to the next in the array - See Also:
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/image/MemoryImageSource.html