ej.microui.display

Interface MicroUIImage

All Known Subinterfaces:

MicroUIGraphicsContext

public interface MicroUIImage

Represents a MicroUI Image.

This interface is used by several drawing methods which use an image as source image. It can be mapped on byte array given as parameter in some MicroUI natives. This byte array is retrieved in MicroEJ application using the method Image.getSNIContext().

See Also:

LLUIDisplay.mapMicroUIImage(byte[]), LLUIDisplay.newMicroUIImage(byte[])

Method Summary

Modifier and Type	Method and Description
MicroUIImageFormat	getFormat() Returns the MicroUI Image format.
int	getHeight() Returns the MicroUI Image height.
int	getIdentifier() Returns an unique identifier for the image.
ej.fp.Image	getImage() Returns the front panel image allocated for the MicroUI Image.
ej.fp.Image	getImage(int color) Returns the front panel image allocated for the MicroUI Image, applying a rendering color.
int	getWidth() Returns the MicroUI Image width.
boolean	isClosed() Returns true when the image has been closed by the MicroEJ application.
boolean	isLCD() Returns true when the image targets the LCD.
boolean	isMutable() Tells whether the MicroUI Image is a mutable image or not.
int	readPixel(int x, int y) Returns the 32-bit ARGB color format (A-R-G-B) of a pixel.
boolean	requestReading() Requests a reading on the graphics context.

Method Detail

getIdentifier

int getIdentifier()

Returns an unique identifier for the image.

The identifier is reserved for this image until it is closed. It can be assimilated to the image buffer address (see LLUI_DISPLAY_getBufferAddress() on emb side).

Returns:

an integer useful to identify an image

getWidth

int getWidth()

Returns the MicroUI Image width.

Returns:

image width in pixels.

getHeight

int getHeight()

Returns the MicroUI Image height.

Returns:

image height in pixels.

getFormat

MicroUIImageFormat getFormat()

Returns the MicroUI Image format.

Returns:

image format.

getImage

ej.fp.Image getImage()

Returns the front panel image allocated for the MicroUI Image.

Returns:

the MicroUI Image representation in front panel framework.

getImage

ej.fp.Image getImage(int color)

Returns the front panel image allocated for the MicroUI Image, applying a rendering color. This color is only useful when the MicroUI Image format is MicroUIImageFormat.MICROUI_IMAGE_FORMAT_A8, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_A4, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_A2 or MicroUIImageFormat.MICROUI_IMAGE_FORMAT_A1. Next calls to getImage() (in same native function) will return the same image with same rendering color until next call to getImage(int). For all other formats, the color is ignored and this call is equivalent than calling getImage().

Parameters:

color - the color to apply on Ax image in 0xRRGGBB format (the alpha component is ignored).

Returns:

the MicroUI Image representation in front panel framework.

isLCD

boolean isLCD()

Returns true when the image targets the LCD.

Returns:

true when the image targets the LCD.

isClosed

boolean isClosed()

Returns true when the image has been closed by the MicroEJ application.

Returns:

true when the image has been closed.

isMutable

boolean isMutable()

Tells whether the MicroUI Image is a mutable image or not. If yes, the SNI context used to map this image can be used to map a MicroUIGraphicsContext.

Returns:

true when the image is mutable.

See Also:

LLUIDisplay.mapMicroUIGraphicsContext(byte[])

readPixel

int readPixel(int x,
              int y)

Returns the 32-bit ARGB color format (A-R-G-B) of a pixel.

Parameters:

x - the x coordinate of the pixel.

y - the y coordinate of the pixel.

Returns:

an ARGB8888 color or 0 if the pixel is out-of-bounds (same behavior as embedded side).

requestReading

boolean requestReading()

Requests a reading on the graphics context.

Returns:

true if reading can be performed, false when the reading does not need to be done for any reason.