lv_font.h
Enums
Functions
-
const void *lv_font_get_glyph_bitmap(lv_font_glyph_dsc_t *g_dsc, uint32_t letter, lv_draw_buf_t *draw_buf)
Return with the bitmap of a font.
- Parameters:
g_dsc -- the glyph descriptor including which font to use etc.
letter -- a UNICODE character code
draw_buf -- a draw buffer that can be used to store the bitmap of the glyph, it's OK not to use it.
- Returns:
pointer to the glyph's data. It can be a draw buffer for bitmap fonts or an image source for imgfonts.
-
bool lv_font_get_glyph_dsc(const lv_font_t *font, lv_font_glyph_dsc_t *dsc_out, uint32_t letter, uint32_t letter_next)
Get the descriptor of a glyph
- Parameters:
font -- pointer to font
dsc_out -- store the result descriptor here
letter -- a UNICODE letter code
letter_next -- the next letter after
letter. Used for kerning
- Returns:
true: descriptor is successfully loaded into
dsc_out. false: the letter was not found, no data is loaded todsc_out
-
void lv_font_glyph_release_draw_data(lv_font_glyph_dsc_t *g_dsc)
Release the bitmap of a font.
Note
You must call @lv_font_get_glyph_dsc to get @g_dsc (@lv_font_glyph_dsc_t) before you can call this function.
- Parameters:
g_dsc -- the glyph descriptor including which font to use, which supply the glyph_index and the format.
-
uint16_t lv_font_get_glyph_width(const lv_font_t *font, uint32_t letter, uint32_t letter_next)
Get the width of a glyph with kerning
- Parameters:
font -- pointer to a font
letter -- a UNICODE letter
letter_next -- the next letter after
letter. Used for kerning
- Returns:
the width of the glyph
-
static inline int32_t lv_font_get_line_height(const lv_font_t *font)
Get the line height of a font. All characters fit into this height
- Parameters:
font -- pointer to a font
- Returns:
the height of a font
-
void lv_font_set_kerning(lv_font_t *font, lv_font_kerning_t kerning)
Configure the use of kerning information stored in a font
- Parameters:
font -- pointer to a font
kerning --
LV_FONT_KERNING_NORMAL(default) orLV_FONT_KERNING_NONE
-
struct lv_font_glyph_dsc_t
- #include <lv_font.h>
Describes the properties of a glyph.
Public Members
-
const lv_font_t *resolved_font
Pointer to a font where the glyph was actually found after handling fallbacks
-
uint16_t adv_w
The glyph needs this space. Draw the next glyph after this width.
-
uint16_t box_w
Width of the glyph's bounding box
-
uint16_t box_h
Height of the glyph's bounding box
-
int16_t ofs_x
x offset of the bounding box
-
int16_t ofs_y
y offset of the bounding box
-
uint8_t bpp
Bit-per-pixel: 1, 2, 4, 8
-
uint8_t is_placeholder
-
uint32_t glyph_index
Glyph is missing. But placeholder will still be displayed The index of the glyph in the font file. Used by the font cache
-
lv_cache_entry_t *entry
The cache entry of the glyph draw data. Used by the font cache
-
const lv_font_t *resolved_font
-
struct _lv_font_t
- #include <lv_font.h>
Describe the properties of a font
Public Members
-
bool (*get_glyph_dsc)(const lv_font_t*, lv_font_glyph_dsc_t*, uint32_t letter, uint32_t letter_next)
Get a glyph's descriptor from a font
-
const void *(*get_glyph_bitmap)(lv_font_glyph_dsc_t*, uint32_t, lv_draw_buf_t*)
Get a glyph's bitmap from a font
-
void (*release_glyph)(const lv_font_t*, lv_font_glyph_dsc_t*)
Release a glyph
-
int32_t line_height
The real line height where any text fits
-
int32_t base_line
Base line measured from the top of the line_height
-
uint8_t subpx
An element of
lv_font_subpx_t
-
uint8_t kerning
An element of
lv_font_kerning_t
-
int8_t underline_position
Distance between the top of the underline and base line (< 0 means below the base line)
-
int8_t underline_thickness
Thickness of the underline
-
const void *dsc
Store implementation specific or run_time data or caching here
-
void *user_data
Custom user data for font.
-
bool (*get_glyph_dsc)(const lv_font_t*, lv_font_glyph_dsc_t*, uint32_t letter, uint32_t letter_next)