lv_disp.h

Go to the documentation of this file.

 
#ifndef LV_DISP_H
#define LV_DISP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../hal/lv_hal.h"
#include "lv_obj.h"
#include "lv_theme.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef enum {
    LV_SCR_LOAD_ANIM_NONE,
    LV_SCR_LOAD_ANIM_OVER_LEFT,
    LV_SCR_LOAD_ANIM_OVER_RIGHT,
    LV_SCR_LOAD_ANIM_OVER_TOP,
    LV_SCR_LOAD_ANIM_OVER_BOTTOM,
    LV_SCR_LOAD_ANIM_MOVE_LEFT,
    LV_SCR_LOAD_ANIM_MOVE_RIGHT,
    LV_SCR_LOAD_ANIM_MOVE_TOP,
    LV_SCR_LOAD_ANIM_MOVE_BOTTOM,
    LV_SCR_LOAD_ANIM_FADE_IN,
    LV_SCR_LOAD_ANIM_FADE_ON = LV_SCR_LOAD_ANIM_FADE_IN, /*For backward compatibility*/
    LV_SCR_LOAD_ANIM_FADE_OUT,
    LV_SCR_LOAD_ANIM_OUT_LEFT,
    LV_SCR_LOAD_ANIM_OUT_RIGHT,
    LV_SCR_LOAD_ANIM_OUT_TOP,
    LV_SCR_LOAD_ANIM_OUT_BOTTOM,
} lv_scr_load_anim_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_disp_get_scr_act(lv_disp_t * disp);
 
lv_obj_t * lv_disp_get_scr_prev(lv_disp_t * disp);
 
void lv_disp_load_scr(lv_obj_t * scr);
 
lv_obj_t * lv_disp_get_layer_top(lv_disp_t * disp);
 
lv_obj_t * lv_disp_get_layer_sys(lv_disp_t * disp);
 
void lv_disp_set_theme(lv_disp_t * disp, lv_theme_t * th);
 
lv_theme_t * lv_disp_get_theme(lv_disp_t * disp);
 
void lv_disp_set_bg_color(lv_disp_t * disp, lv_color_t color);
 
void lv_disp_set_bg_image(lv_disp_t * disp, const void  * img_src);
 
void lv_disp_set_bg_opa(lv_disp_t * disp, lv_opa_t opa);
 
void lv_scr_load_anim(lv_obj_t * scr, lv_scr_load_anim_t anim_type, uint32_t time, uint32_t delay, bool auto_del);
 
uint32_t lv_disp_get_inactive_time(const lv_disp_t * disp);
 
void lv_disp_trig_activity(lv_disp_t * disp);
 
void lv_disp_clean_dcache(lv_disp_t * disp);
 
void lv_disp_enable_invalidation(lv_disp_t * disp, bool en);
 
bool lv_disp_is_invalidation_enabled(lv_disp_t * disp);
 
lv_timer_t * _lv_disp_get_refr_timer(lv_disp_t * disp);
 
/*------------------------------------------------
 * To improve backward compatibility
 * Recommended only if you have one display
 *------------------------------------------------*/
 
static inline lv_obj_t * lv_scr_act(void)
{
    return lv_disp_get_scr_act(lv_disp_get_default());
}
 
static inline lv_obj_t * lv_layer_top(void)
{
    return lv_disp_get_layer_top(lv_disp_get_default());
}
 
static inline lv_obj_t * lv_layer_sys(void)
{
    return lv_disp_get_layer_sys(lv_disp_get_default());
}
 
static inline void lv_scr_load(lv_obj_t * scr)
{
    lv_disp_load_scr(scr);
}
 
/**********************
 *      MACROS
 **********************/
 
/*------------------------------------------------
 * To improve backward compatibility
 * Recommended only if you have one display
 *------------------------------------------------*/
 
#ifndef LV_HOR_RES
#define LV_HOR_RES lv_disp_get_hor_res(lv_disp_get_default())
#endif
 
#ifndef LV_VER_RES
#define LV_VER_RES lv_disp_get_ver_res(lv_disp_get_default())
#endif
 
static inline lv_coord_t lv_dpx(lv_coord_t n)
{
    return LV_DPX(n);
}
 
static inline lv_coord_t lv_disp_dpx(const lv_disp_t * disp, lv_coord_t n)
{
    return _LV_DPX_CALC(lv_disp_get_dpi(disp), n);
}
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_DISP_H*/