com.microej.tool.ui.generator

Interface MicroUIRawImageGeneratorExtension

All Known Implementing Classes:

BufferedImageLoader

public interface MicroUIRawImageGeneratorExtension

An implementation of this interface is required to convert an image in a binary format compatible with MicroUI Image API. The input image must be pixel addressable.

The MicroUI Image RAW format accepts some optional characteristics: an optional header (most of hardware decoders are MicroUI Image RAW format compatible but can require a header to be able to recognize the image itself) and / or a row stride different than the image width in pixels.

When the image output format is "DISPLAY" and the LCD pixel format is "CUSTOM" (that means not standard like ARGB8888 or RGB565 for instance), image generator requires the extension to encode each pixel in LCD pixel format (see convertARGBColorToDisplayColor(int)).

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Image image) Tells if the extension is able to read the given image.
default int	convertARGBColorToDisplayColor(int color) Called only when converting an image in same format than LCD format (image output format is "DISPLAY") and when this LCD format is not standard (like RGB565 or ARGB8888 for instance).
int	get(int x, int y) Gets the ARGB8888 pixel color at given position.
int	getHeight() Gets the current source image height in pixels.
default byte[]	getOptionalHeader() Returns a header the image generator has to store just before the pixels data.
default int	getStride(int defaultStride) Returns the preferred row stride in pixels to respect in output image.
int	getWidth() Gets the current source image width in pixels.

Method Detail

canRead

boolean canRead(Image image)

Tells if the extension is able to read the given image. If true, the extension should keep a reference on the image.

Parameters:

image - the source image.

Returns:

true when the extension is able to read the source image.

getWidth

int getWidth()

Gets the current source image width in pixels.

Returns:

the image width.

getHeight

int getHeight()

Gets the current source image height in pixels.

Returns:

the image height.

get

int get(int x,
        int y)

Gets the ARGB8888 pixel color at given position.

Parameters:

x - the pixel X-coordinate

y - the pixel Y-coordinate

Returns:

the ARGB8888 color.

getStride

default int getStride(int defaultStride)

Returns the preferred row stride in pixels to respect in output image. Default implementation returns the default stride calculated by the image generator. If returned stride is lower than default stride, default stride is used.

Parameters:

defaultStride - the stride calculated by the image generator (in pixels).

Returns:

the preferred row stride (in pixels).

getOptionalHeader

default byte[] getOptionalHeader()

Returns a header the image generator has to store just before the pixels data. This header is often used when image is used at runtime by a hardware accelerator.

No padding is added between this header and the pixels array. If some padding is required, the returned array must contain it.

Image generator ensures header address will be aligned on header size itself.

By default, no header is added.

Returns:

null or a specific image header.

convertARGBColorToDisplayColor

default int convertARGBColorToDisplayColor(int color)

Called only when converting an image in same format than LCD format (image output format is "DISPLAY") and when this LCD format is not standard (like RGB565 or ARGB8888 for instance).

Converts the ARGB color into the LCD color format.

ARGB value is interpreted as a 32-bit ARGB color, where the eight less significant bits matches the blue component, the next eight bits matches the green component, the next eight bits matches the red component and the next eight bits matches the alpha level.

Note: the alpha level may be ignored if the display pixel representation does not hold the alpha level information.

Parameters:

color - the ARGB color to convert

Returns:

the converted color