ej.microvg

Interface LLVGEngine

public interface LLVGEngine

Equivalent of LLUIDisplay for MicroVG: it provides some methods to map MicroVG byte arrays in MicroVG Graphics Context objects, to manipulate MicroVG linear gradient, etc.

An instance of this framework is available via the Instance field. To use the framework methods, caller must synchronize its calls on this Instance field.

Field Summary

Fields

Modifier and Type	Field and Description
static ej.microui.display.MicroUIImageFormat	BUFFERED_VECTOR_IMAGE_FORMAT Buffered Vector Image RAW format (same format is used in application library).
static int	DEFAULT_LETTER_SPACING Defines the letter spacing to use to let the vector font engine use the internal vector font's letter spacing.
static LLVGEngine	Instance Unique instance of MicroVG Engine.
static ej.microui.display.MicroUIFontFormat	VECTOR_FONT_FORMAT Vector Font format (same format is used in application library).

Method Summary

Modifier and Type	Method and Description
default void	convertColorToColorToDraw(ej.microui.display.MicroUIGraphicsContext gc, java.awt.geom.Rectangle2D bounds) Truncates the pixels' colors of the given region to take in consideration the hardware display pixel representation constraints.
int	drawString(ej.microui.display.MicroUIGraphicsContext gc, char[] string, int face, float size, float x, float y, float[] matrix, int blendMode, VGPaint p, float letterSpacing, float radius, int direction) Decomposes a string in glyphs and draws them using the drawer for the given graphics context (VGDrawing.drawPath(MicroUIGraphicsContext, GeneralPath, float, float, float[], int, int, VGPaint).
BufferedVectorImageDrawer	getBufferedVectorImageDrawer() Gets the buffered vector image drawer that can be used to draw in a buffered vector image.
java.awt.Composite	getComposite(int blend) Gets the AWT composite according to the MicroVG blend mode.
int	getFillRule(int fillRule) Gets the AWT fill rule according to the MicroVG fill rule.
VGDrawing	getVGDrawer(ej.microui.display.MicroUIGraphicsContext gc) Gets the drawer used to draw on the given graphics context.
VGDrawing	getVGDrawer(ej.microui.display.MicroUIImageFormat format) Gets the drawer used to draw with the given format.
VGPaint	mapGradient(int[] gradient, float[] gradientMatrix, float[] globalMatrix, int globalAlpha) Maps a VGPaint from the gradient's array, applying the gradient's transformation, the drawing's transformation and the drawing's opacity.
java.awt.geom.GeneralPath	mapPath(byte[] path) Maps an AWT general path on the MicroVG path array.
MicroVGImage	mapVectorImage(byte[] sniContext) Gets the unique image identifier from the SNI context.
void	registerVGDrawer(VGDrawing drawer) Registers a drawer that supports a specific format.
void	setClip(java.awt.Graphics2D g2d, ej.microui.display.MicroUIGraphicsContext gc, java.awt.geom.GeneralPath path, java.awt.geom.AffineTransform at) Sets a clip; cannot be higher than master clip.
void	unregisterVGDrawer(ej.microui.display.MicroUIImageFormat format) Unregisters the drawer registered for the given format.

Field Detail

BUFFERED_VECTOR_IMAGE_FORMAT

static final ej.microui.display.MicroUIImageFormat BUFFERED_VECTOR_IMAGE_FORMAT

Buffered Vector Image RAW format (same format is used in application library).

VECTOR_FONT_FORMAT

static final ej.microui.display.MicroUIFontFormat VECTOR_FONT_FORMAT

Vector Font format (same format is used in application library).

DEFAULT_LETTER_SPACING

static final int DEFAULT_LETTER_SPACING

Defines the letter spacing to use to let the vector font engine use the internal vector font's letter spacing.

See Also:

Constant Field Values

Instance

static final LLVGEngine Instance

Unique instance of MicroVG Engine. It provides some methods to to map MicroVG byte arrays in MicroVG Graphics Context objects, to manipulate MicroVG linear gradient etc.

To use the framework methods, caller must synchronize its calls on this Instance field.

Method Detail

registerVGDrawer

void registerVGDrawer(VGDrawing drawer)

Registers a drawer that supports a specific format.

Parameters:

drawer - the drawer

See Also:

VGDrawing.handledFormat()

unregisterVGDrawer

void unregisterVGDrawer(ej.microui.display.MicroUIImageFormat format)

Unregisters the drawer registered for the given format.

Parameters:

format - the now unsupported format

See Also:

VGDrawing.handledFormat()

getVGDrawer

VGDrawing getVGDrawer(ej.microui.display.MicroUIGraphicsContext gc)

Gets the drawer used to draw on the given graphics context.

Parameters:

gc - the graphics context to draw on

Returns:

the drawer registered for the format of the graphics context or a stub if none

getVGDrawer

VGDrawing getVGDrawer(ej.microui.display.MicroUIImageFormat format)

Gets the drawer used to draw with the given format.

Parameters:

format - the format

Returns:

the drawer registered for the format or a stub if none

mapPath

java.awt.geom.GeneralPath mapPath(byte[] path)

Maps an AWT general path on the MicroVG path array.

Parameters:

path - the MicroVG path

Returns:

an AWT path

mapGradient

VGPaint mapGradient(int[] gradient,
                    float[] gradientMatrix,
                    float[] globalMatrix,
                    int globalAlpha)

Maps a VGPaint from the gradient's array, applying the gradient's transformation, the drawing's transformation and the drawing's opacity.

Parameters:

gradient - the gradient's array

gradientMatrix - the gradient's transformation

globalMatrix - the drawing's transformation

globalAlpha - the drawing's opacity

Returns:

an AWT paint object

mapVectorImage

MicroVGImage mapVectorImage(byte[] sniContext)

Gets the unique image identifier from the SNI context.

Parameters:

sniContext - the representation of the MicroVG image

Returns:

the expected raw image or null if the image has been closed

setClip

void setClip(java.awt.Graphics2D g2d,
             ej.microui.display.MicroUIGraphicsContext gc,
             java.awt.geom.GeneralPath path,
             java.awt.geom.AffineTransform at)

Sets a clip; cannot be higher than master clip.

Parameters:

g2d - Graphics2D drawing object

gc - MicroUI GraphicsContext where performing the drawing

path - the path to clip.

at - the path transformation

getFillRule

int getFillRule(int fillRule)

Gets the AWT fill rule according to the MicroVG fill rule.

Parameters:

fillRule - a MicroVG fill rule (example: LLVGConstants.FILLTYPE_EVEN_ODD

Returns:

a AWT fill rule (example: Path2D.WIND_EVEN_ODD

getComposite

java.awt.Composite getComposite(int blend)

Gets the AWT composite according to the MicroVG blend mode.

Parameters:

blend - a MicroVG blend mode (example: LLVGConstants.BLEND_SRC

Returns:

a AWT composite that fits the MicroVG blend mode specification

drawString

int drawString(ej.microui.display.MicroUIGraphicsContext gc,
               char[] string,
               int face,
               float size,
               float x,
               float y,
               float[] matrix,
               int blendMode,
               VGPaint p,
               float letterSpacing,
               float radius,
               int direction)

Decomposes a string in glyphs and draws them using the drawer for the given graphics context (VGDrawing.drawPath(MicroUIGraphicsContext, GeneralPath, float, float, float[], int, int, VGPaint).

Parameters:

gc - the destination

string - the array of characters to draw

face - the font face to use

size - the font size, in pixels

x - the destination X coordinate

y - the destination Y coordinate

matrix - the deformation to apply

blendMode - the blend mode

p - the color representation to use

letterSpacing - the extra letter spacing to use

radius - the radius of the circle

direction - the direction of the text along the circle

Returns:

LLVGPainter.RETURN_SUCCESS on success or LLVGPainter.RESOURCE_CLOSED if the font is closed

convertColorToColorToDraw

default void convertColorToColorToDraw(ej.microui.display.MicroUIGraphicsContext gc,
                                       java.awt.geom.Rectangle2D bounds)

Truncates the pixels' colors of the given region to take in consideration the hardware display pixel representation constraints.

Parameters:

gc - the target to update

bounds - the region to update

getBufferedVectorImageDrawer

BufferedVectorImageDrawer getBufferedVectorImageDrawer()

Gets the buffered vector image drawer that can be used to draw in a buffered vector image.

Returns:

the buffered vector image drawer