lvgl.h

Go to the documentation of this file.

 
 
#ifndef _LVGL_H
#define _LVGL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      DEFINES
 *********************/
/*Current version of LVGL*/
#define LVGL_VERSION_MAJOR   7
#define LVGL_VERSION_MINOR   0
#define LVGL_VERSION_PATCH   1
#define LVGL_VERSION_INFO    "dev"
 
 
#ifndef NULL
   #define NULL ((void*) 0)
#endif
 
#include <stdbool.h>
 
#define FALSE   0
#define TRUE    1
//#define false   0
//#define true    1
 
//typedef unsigned char   u8, bool, BOOL, bit1, uint8_t, BaseType_t;
 
typedef signed char    int8_t;
//typedef unsigned char   bool;
typedef unsigned char   u8,  uint8_t;
typedef unsigned short  u16, uint16_t;
typedef signed short    s16, int16_t;
typedef unsigned int    u32, tu8, tu16, tbool, tu32, uint32_t;
typedef signed int      s32,int32_t;
/* -------------------------------------------------------------------------------- */
/* -- TYPEDEFS                                                                   -- */
/* -------------------------------------------------------------------------------- */
 
typedef int16_t lv_coord_t;
typedef uint32_t lv_uintptr_t;
 
//lv_font_fmt_txt.h
typedef struct {
    uint32_t bitmap_index : 20;     
    uint32_t adv_w : 12;            
    uint8_t box_w;                  
    uint8_t box_h;                  
    int8_t ofs_x;                   
    int8_t ofs_y;                  
} lv_font_fmt_txt_glyph_dsc_t;
 
 
enum {
    LV_FONT_FMT_TXT_CMAP_FORMAT0_TINY,
    LV_FONT_FMT_TXT_CMAP_FORMAT0_FULL,
    LV_FONT_FMT_TXT_CMAP_SPARSE_TINY,
    LV_FONT_FMT_TXT_CMAP_SPARSE_FULL,
};
 
typedef uint8_t lv_font_fmt_txt_cmap_type_t;
 
/* Map codepoints to a `glyph_dsc`s
 * Several formats are supported to optimize memory usage
 * See https://github.com/lvgl/lv_font_conv/blob/master/doc/font_spec.md
 */
typedef struct {
    uint32_t range_start;
 
    uint16_t range_length;
 
    uint16_t glyph_id_start;
 
    const uint16_t * unicode_list;
 
    const void * glyph_id_ofs_list;
 
    uint16_t list_length;
 
    lv_font_fmt_txt_cmap_type_t type;
} lv_font_fmt_txt_cmap_t;
 
 
//lv_font_fmt_txt.h
/*Describe store additional data for fonts */
typedef struct {
    /*The bitmaps os all glyphs*/
    const uint8_t * glyph_bitmap;
 
    /*Describe the glyphs*/
    const lv_font_fmt_txt_glyph_dsc_t * glyph_dsc;
 
    /* Map the glyphs to Unicode characters.
     * Array of `lv_font_cmap_fmt_txt_t` variables*/
    const lv_font_fmt_txt_cmap_t * cmaps;
 
    /* Store kerning values.
     * Can be  `lv_font_fmt_txt_kern_pair_t *  or `lv_font_kern_classes_fmt_txt_t *`
     * depending on `kern_classes`
     */
    const void * kern_dsc;
 
    /*Scale kern values in 12.4 format*/
    uint16_t kern_scale;
 
    /*Number of cmap tables*/
    uint16_t cmap_num       : 10;
 
    /*Bit per pixel: 1, 2, 3, 4, 8*/
    uint16_t bpp            : 4;
 
    /*Type of `kern_dsc`*/
    uint16_t kern_classes   : 1;
 
    /*
     * storage format of the bitmap
     * from `lv_font_fmt_txt_bitmap_format_t`
     */
    uint16_t bitmap_format  : 2;
 
    /*Cache the last letter and is glyph id*/
    uint32_t last_letter;
    uint32_t last_glyph_id;
 
} lv_font_fmt_txt_dsc_t;
 
typedef struct {
    uint16_t adv_w; 
    uint16_t box_w;  
    uint16_t box_h;  
    int16_t ofs_x;   
    int16_t ofs_y;   
    uint8_t bpp;    
} lv_font_glyph_dsc_t;
 
//lv_font.h
typedef struct _lv_font_struct {
    bool (*get_glyph_dsc)(const struct _lv_font_struct *, lv_font_glyph_dsc_t *, uint32_t letter, uint32_t letter_next);
 
    const uint8_t * (*get_glyph_bitmap)(const struct _lv_font_struct *, uint32_t);
 
    /*Pointer to the font in a font pack (must have the same line height)*/
    lv_coord_t line_height;         
    lv_coord_t base_line;           
    uint8_t subpx  : 2;             
    void * dsc;                     
} lv_font_t;
/**********************
 *      TYPEDEFS
 **********************/
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
/**********************
 *      MACROS
 **********************/
 
#define LV_VERSION_CHECK(x,y,z) (x == LVGL_VERSION_MAJOR && (y < LVGL_VERSION_MINOR || (y == LVGL_VERSION_MINOR && z <= LVGL_VERSION_PATCH)))
 
 
#ifdef __cplusplus
 
}
#endif
 
#endif /*LVGL_H*/