ej.microui.display

Interface UIFontDrawing

public interface UIFontDrawing

This interface provides all the drawing methods that use a font.

This interface can be fully implemented by a dedicated class in front panel project. This allows to draw and decode fonts with a custom format.

Method Summary

Modifier and Type	Method and Description
default void	draw(MicroUIGraphicsContext gc, char[] string, MicroUIFont font, int x, int y) Draws a string.
default void	draw(MicroUIGraphicsContext gc, char c, MicroUIFont font, int x, int y) Draws a character.
default void	drawCharWithRotationBilinear(MicroUIGraphicsContext gc, char c, MicroUIFont font, int destX, int destY, int xRotation, int yRotation, float angle, int alpha) Draws a string applying a rotation and an alpha value.
default void	drawCharWithRotationNearestNeighbor(MicroUIGraphicsContext gc, char c, MicroUIFont font, int destX, int destY, int xRotation, int yRotation, float angle, int alpha) Draws a string applying a rotation and an alpha value.
default void	drawRenderableString(MicroUIGraphicsContext gc, char[] string, MicroUIFont font, int charsWidth, MicroUIRenderableString renderableString, int x, int y) Draws a renderable string.
default void	drawScaledRenderableStringBilinear(MicroUIGraphicsContext gc, char[] string, MicroUIFont font, int charsWidth, MicroUIRenderableString renderableString, int x, int y, float xRatio, float yRatio) Draws a renderable string applying a scaling.
default void	drawScaledStringBilinear(MicroUIGraphicsContext gc, char[] string, MicroUIFont font, int x, int y, float xRatio, float yRatio) Draws a string applying a scaling.
MicroUIFontFormat	handledFormat() Gets the supported custom font format.
default int	initializeRenderableStringSNIContext(char[] string, MicroUIFont font, MicroUIRenderableString renderableString) Computes the rendered width of a string and fills the SNI context.
default int	stringWidth(char[] string, MicroUIFont font) Computes the rendered width of a string.

Method Detail

handledFormat

MicroUIFontFormat handledFormat()

Gets the supported custom font format.

Returns:

the supported custom font format

stringWidth

default int stringWidth(char[] string,
                        MicroUIFont font)

Computes the rendered width of a string.

Parameters:

string - a string of characters

font - the MicroUI Font to use

Returns:

the width in pixels

draw

default void draw(MicroUIGraphicsContext gc,
                  char[] string,
                  MicroUIFont font,
                  int x,
                  int y)

Draws a string.

Parameters:

gc - the targeted MicroUI GraphicsContext

string - a string of characters

font - the MicroUI Font to use

x - the left coordinate

y - the top coordinate

draw

default void draw(MicroUIGraphicsContext gc,
                  char c,
                  MicroUIFont font,
                  int x,
                  int y)

Draws a character.

Parameters:

gc - the targeted MicroUI GraphicsContext

c - a character

font - the MicroUI Font to use

x - the left coordinate

y - the top coordinate

initializeRenderableStringSNIContext

default int initializeRenderableStringSNIContext(char[] string,
                                                 MicroUIFont font,
                                                 MicroUIRenderableString renderableString)

Computes the rendered width of a string and fills the SNI context.

Parameters:

string - a string of characters

font - the MicroUI Font to use

renderableString - the renderable string

Returns:

the width in pixels

drawRenderableString

default void drawRenderableString(MicroUIGraphicsContext gc,
                                  char[] string,
                                  MicroUIFont font,
                                  int charsWidth,
                                  MicroUIRenderableString renderableString,
                                  int x,
                                  int y)

Draws a renderable string.

Parameters:

gc - the targeted MicroUI GraphicsContext

string - a string of characters

font - the MicroUI Font to use

charsWidth - the string width

renderableString - the renderable string

x - the left coordinate

y - the top coordinate

drawCharWithRotationBilinear

default void drawCharWithRotationBilinear(MicroUIGraphicsContext gc,
                                          char c,
                                          MicroUIFont font,
                                          int destX,
                                          int destY,
                                          int xRotation,
                                          int yRotation,
                                          float angle,
                                          int alpha)

Draws a string applying a rotation and an alpha value. This method uses the bilinear algorithm to render the character. This algorithm performs better rendering than nearest neighbor algorithm but it is slower to apply.

Parameters:

gc - the targeted MicroUI GraphicsContext

c - a character

font - the MicroUI Font to use

destX - the left coordinate

destY - the top coordinate

xRotation - the horizontal coordinate of the rotation center

yRotation - the vertical coordinate of the rotation center

angle - the rotation angle, in degrees

alpha - the alpha value to use

fontData - the MicroUI font to use

drawCharWithRotationNearestNeighbor

default void drawCharWithRotationNearestNeighbor(MicroUIGraphicsContext gc,
                                                 char c,
                                                 MicroUIFont font,
                                                 int destX,
                                                 int destY,
                                                 int xRotation,
                                                 int yRotation,
                                                 float angle,
                                                 int alpha)

Draws a string applying a rotation and an alpha value. This method uses the nearest neighbor algorithm to render the character. This algorithm performs faster rendering than nearest neighbor algorithm but gives a rougher result.

Parameters:

gc - the targeted MicroUI GraphicsContext

c - a character

font - the MicroUI Font to use

destX - the left coordinate

destY - the top coordinate

xRotation - the horizontal coordinate of the rotation center

yRotation - the vertical coordinate of the rotation center

angle - the rotation angle, in degrees

alpha - the alpha value to use

fontData - the MicroUI font to use

drawScaledStringBilinear

default void drawScaledStringBilinear(MicroUIGraphicsContext gc,
                                      char[] string,
                                      MicroUIFont font,
                                      int x,
                                      int y,
                                      float xRatio,
                                      float yRatio)

Draws a string applying a scaling. This method uses the bilinear algorithm to render the characters. This algorithm performs better rendering than nearest neighbor algorithm but it is slower to apply.

Parameters:

gc - the targeted MicroUI GraphicsContext

string - a string of characters

font - the MicroUI Font to use

x - the left coordinate

y - the top coordinate

xRatio - the horizontal scaling ratio (1.0f meaning no scaling)

yRatio - the vertical scaling ratio (1.0f meaning no scaling)

drawScaledRenderableStringBilinear

default void drawScaledRenderableStringBilinear(MicroUIGraphicsContext gc,
                                                char[] string,
                                                MicroUIFont font,
                                                int charsWidth,
                                                MicroUIRenderableString renderableString,
                                                int x,
                                                int y,
                                                float xRatio,
                                                float yRatio)

Draws a renderable string applying a scaling. This method uses the bilinear algorithm to render the characters. This algorithm performs better rendering than nearest neighbor algorithm but it is slower to apply.

Parameters:

gc - the targeted MicroUI GraphicsContext

string - a string of characters

font - the MicroUI Font to use

charsWidth - the string width

renderableString - the renderable string

x - the left coordinate

y - the top coordinate

xRatio - the horizontal scaling ratio (1.0f meaning no scaling)

yRatio - the vertical scaling ratio (1.0f meaning no scaling)