ej.microui.display

Class BufferedImage

java.lang.Object

ej.microui.display.Image

ej.microui.display.ResourceImage

ej.microui.display.BufferedImage

All Implemented Interfaces:

Closeable, AutoCloseable

public class BufferedImage
extends ResourceImage

A BufferedImage represents a mutable image backed by a pixel buffer.

The constructor of this class allows to create an image with given dimensions.

Nested Class Summary

Nested classes/interfaces inherited from class ej.microui.display.ResourceImage

ResourceImage.OutputFormat

Constructor Summary

Constructors

Constructor and Description
BufferedImage(int width, int height) Creates a buffered image.

Method Summary

Modifier and Type	Method and Description
GraphicsContext	getGraphicsContext() Returns the GraphicsContext associated with this image, which may be used in order to draw on the image.

Methods inherited from class ej.microui.display.ResourceImage

canLoadImage, close, isClosed, loadImage, loadImage, loadImage, loadImage

Methods inherited from class ej.microui.display.Image

canGetImage, getHeight, getImage, getSNIContext, getWidth, isTransparent, readPixel, readPixels

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferedImage

public BufferedImage(int width,
                     int height)

Creates a buffered image.

The new image is initialized with unspecified pixel data. The output format of the new image matches the pixel organization (layout, depth, etc.) of the default display.

Creating images is not supported by every MicroUI implementation. If the MicroUI implementation does not support the allocation of memory in order to store the pixel buffer, a MicroUIException is thrown.

Parameters:

width - the width of the new image, in pixels.

height - the height of the new image, in pixels.

Throws:

IllegalArgumentException - if either width or height is negative or zero.

MicroUIException - if the image could not be created.

MicroUIException - if MicroUI is not started.

SecurityException - if a security manager exists and does not allow the caller to create an image.

Method Detail

getGraphicsContext

public GraphicsContext getGraphicsContext()

Returns the GraphicsContext associated with this image, which may be used in order to draw on the image.

This method always returns the same GraphicsContext instance for a specific image. The graphics context has the same dimensions as the image, which allows to modify every pixel of the image.

Returns:

the image's graphics context.

Throws:

MicroUIException - if this image has been closed (see ResourceImage.close()).