OpenJDK 27 · sun.awt.image.ToolkitImage · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private int	availinfo
private int	height
pack-priv ImageRepresentation	imagerep
private Hashtable<?, ?>	properties
pack-priv ImageProducer	source The object which is used to reconstruct the original image data as needed.
pack-priv InputStreamImageSource	src
private int	width

Access	Constructor and Description
protected	ToolkitImage()
public	ToolkitImage(ImageProducer is) Construct an image from an ImageProducer object.

Method Summary

Modifier and Type	Method and Description
pack-priv synchronized void	addInfo(int newinfo)
private synchronized void	addWatcher(ImageObserver iw, boolean load)
public int	check(ImageObserver iw)
public void	flush() Overrides java.awt.Image.flush. Flushes all reconstructable resources being used by this Image object.
public BufferedImage	getBufferedImage()
public ColorModel	getColorModel()
public Graphics	getGraphics() Implements abstract java.awt.Image.getGraphics. Creates a graphics context for drawing to an off-screen image.
public int	getHeight() Return the height of the original image source.
public synchronized int	getHeight(ImageObserver iw) Implements abstract java.awt.Image.getHeight. Return the height of the original image source.
public synchronized ImageRepresentation	getImageRep()
public Object	getProperty(String name, ImageObserver observer) Implements abstract java.awt.Image.getProperty. Return a property of the image by name.
public ImageProducer	getSource() Implements abstract java.awt.Image.getSource. Gets the object that produces the pixels for the image.
public int	getWidth() Return the width of the original image source.
public synchronized int	getWidth(ImageObserver iw) Implements abstract java.awt.Image.getWidth. Return the width of the original image source.
public boolean	hasError()
pack-priv synchronized void	infoDone(int status)
protected ImageRepresentation	makeImageRep()
public void	preload(ImageObserver iw)
private synchronized void	reconstruct(int flags)
public void	setAccelerationPriority(float priority) Overrides java.awt.Image.setAccelerationPriority. Sets a hint for this image about how important acceleration is.
pack-priv void	setDimensions(int w, int h)
pack-priv void	setProperties(Hashtable<?, ?> props)

Inherited from java.awt.Image:: getAccelerationPriority getCapabilities getScaledInstance

availinfo	back to summary
private int availinfo

height	back to summary
private int height

imagerep	back to summary
pack-priv ImageRepresentation imagerep

properties	back to summary
private Hashtable<?, ?> properties

source	back to summary
pack-priv ImageProducer source The object which is used to reconstruct the original image data as needed.

src	back to summary
pack-priv InputStreamImageSource src

width	back to summary
private int width

ToolkitImage	back to summary
protected ToolkitImage()

ToolkitImage	back to summary
public ToolkitImage(ImageProducer is) Construct an image from an ImageProducer object.

Method Detail

addInfo	back to summary
pack-priv synchronized void addInfo(int newinfo)

addWatcher	back to summary
private synchronized void addWatcher(ImageObserver iw, boolean load)

check	back to summary
public int check(ImageObserver iw)

flush back to summary

flush	back to summary
public void flush() Overrides java.awt.Image.flush. Doc from java.awt.Image.flush. Flushes all reconstructable resources being used by this Image object. This includes any pixel data that is being cached for rendering to the screen as well as any system resources that are being used to store data or pixels for the image if they can be recreated. The image is reset to a state similar to when it was first created so that if it is again rendered, the image data will have to be recreated or fetched again from its source. Examples of how this method affects specific types of Image object: BufferedImage objects leave the primary Raster which stores their pixels untouched, but flush any information cached about those pixels such as copies uploaded to the display hardware for accelerated blits. Image objects created by the Component methods which take a width and height leave their primary buffer of pixels untouched, but have all cached information released much like is done for BufferedImage objects. VolatileImage objects release all of their pixel resources including their primary copy which is typically stored on the display hardware where resources are scarce. These objects can later be restored using their `validate` method. Image objects created by the Toolkit and Component classes which are loaded from files, URLs or produced by an `ImageProducer` are unloaded and all local resources are released. These objects can later be reloaded from their original source as needed when they are rendered, just as when they were first created.

public void flush()

Overrides java.awt.Image.flush.

Doc from java.awt.Image.flush.

Flushes all reconstructable resources being used by this Image object. This includes any pixel data that is being cached for rendering to the screen as well as any system resources that are being used to store data or pixels for the image if they can be recreated. The image is reset to a state similar to when it was first created so that if it is again rendered, the image data will have to be recreated or fetched again from its source.

Examples of how this method affects specific types of Image object:

BufferedImage objects leave the primary Raster which stores their pixels untouched, but flush any information cached about those pixels such as copies uploaded to the display hardware for accelerated blits.
Image objects created by the Component methods which take a width and height leave their primary buffer of pixels untouched, but have all cached information released much like is done for BufferedImage objects.
VolatileImage objects release all of their pixel resources including their primary copy which is typically stored on the display hardware where resources are scarce. These objects can later be restored using their validate method.
Image objects created by the Toolkit and Component classes which are loaded from files, URLs or produced by an ImageProducer are unloaded and all local resources are released. These objects can later be reloaded from their original source as needed when they are rendered, just as when they were first created.

getBufferedImage	back to summary
public BufferedImage getBufferedImage()

getColorModel	back to summary
public ColorModel getColorModel()

getGraphics	back to summary
public Graphics getGraphics() Implements abstract java.awt.Image.getGraphics. Doc from java.awt.Image.getGraphics. Creates a graphics context for drawing to an off-screen image. This method can only be called for off-screen images.

getGraphics

back to summary

public Graphics getGraphics()

Implements abstract java.awt.Image.getGraphics.

Doc from java.awt.Image.getGraphics.

Creates a graphics context for drawing to an off-screen image. This method can only be called for off-screen images.

getHeight	back to summary
public int getHeight() Return the height of the original image source. If the height isn't known, then the image is reconstructed.

getHeight	back to summary
public synchronized int getHeight(ImageObserver iw) Implements abstract java.awt.Image.getHeight. Return the height of the original image source. If the height isn't known, then the ImageObserver object will be notified when the data is available.

getHeight

back to summary

public synchronized int getHeight(ImageObserver iw)

Implements abstract java.awt.Image.getHeight.

Return the height of the original image source. If the height isn't known, then the ImageObserver object will be notified when the data is available.

getImageRep	back to summary
public synchronized ImageRepresentation getImageRep()

getProperty	back to summary
public Object getProperty(String name, ImageObserver observer) Implements abstract java.awt.Image.getProperty. Return a property of the image by name. Individual property names are defined by the various image formats. If a property is not defined for a particular image, then this method will return the UndefinedProperty object. If the properties for this image are not yet known, then this method will return null and the ImageObserver object will be notified later. The property name "comment" should be used to store an optional comment which can be presented to the user as a description of the image, its source, or its author.

getProperty

back to summary

public Object getProperty(String name, ImageObserver observer)

Implements abstract java.awt.Image.getProperty.

Return a property of the image by name. Individual property names are defined by the various image formats. If a property is not defined for a particular image, then this method will return the UndefinedProperty object. If the properties for this image are not yet known, then this method will return null and the ImageObserver object will be notified later. The property name "comment" should be used to store an optional comment which can be presented to the user as a description of the image, its source, or its author.

getSource	back to summary
public ImageProducer getSource() Implements abstract java.awt.Image.getSource. Doc from java.awt.Image.getSource. Gets the object that produces the pixels for the image. This method is called by the image filtering classes and by methods that perform image conversion and scaling.

getSource

back to summary

public ImageProducer getSource()

Implements abstract java.awt.Image.getSource.

Doc from java.awt.Image.getSource.

Gets the object that produces the pixels for the image. This method is called by the image filtering classes and by methods that perform image conversion and scaling.

getWidth	back to summary
public int getWidth() Return the width of the original image source. If the width isn't known, then the image is reconstructed.

getWidth	back to summary
public synchronized int getWidth(ImageObserver iw) Implements abstract java.awt.Image.getWidth. Return the width of the original image source. If the width isn't known, then the ImageObserver object will be notified when the data is available.

getWidth

back to summary

public synchronized int getWidth(ImageObserver iw)

Implements abstract java.awt.Image.getWidth.

Return the width of the original image source. If the width isn't known, then the ImageObserver object will be notified when the data is available.

hasError	back to summary
public boolean hasError()

infoDone	back to summary
pack-priv synchronized void infoDone(int status)

makeImageRep	back to summary
protected ImageRepresentation makeImageRep()

preload	back to summary
public void preload(ImageObserver iw)

reconstruct	back to summary
private synchronized void reconstruct(int flags)

setAccelerationPriority	back to summary
public void setAccelerationPriority(float priority) Overrides java.awt.Image.setAccelerationPriority. Doc from java.awt.Image.setAccelerationPriority. Sets a hint for this image about how important acceleration is. This priority hint is used to compare to the priorities of other Image objects when determining how to use scarce acceleration resources such as video memory. When and if it is possible to accelerate this Image, if there are not enough resources available to provide that acceleration but enough can be freed up by de-accelerating some other image of lower priority, then that other Image may be de-accelerated in deference to this one. Images that have the same priority take up resources on a first-come, first-served basis.

setAccelerationPriority

back to summary

public void setAccelerationPriority(float priority)

Overrides java.awt.Image.setAccelerationPriority.

Doc from java.awt.Image.setAccelerationPriority.

Sets a hint for this image about how important acceleration is. This priority hint is used to compare to the priorities of other Image objects when determining how to use scarce acceleration resources such as video memory. When and if it is possible to accelerate this Image, if there are not enough resources available to provide that acceleration but enough can be freed up by de-accelerating some other image of lower priority, then that other Image may be de-accelerated in deference to this one. Images that have the same priority take up resources on a first-come, first-served basis.

setDimensions	back to summary
pack-priv void setDimensions(int w, int h)

setProperties	back to summary
pack-priv void setProperties(Hashtable<?, ?> props)

public Class ToolkitImage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail