lv_img.h

Go to the documentation of this file.

 
#ifndef LV_IMG_H
#define LV_IMG_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_IMG != 0
 
/*Testing of dependencies*/
#if LV_USE_LABEL == 0
#error "lv_img: lv_label is required. Enable it in lv_conf.h (LV_USE_LABEL 1)"
#endif
 
#include "../core/lv_obj.h"
#include "../misc/lv_fs.h"
#include "../draw/lv_draw.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef struct {
    lv_obj_t obj;
    const void * src; /*Image source: Pointer to an array or a file or a symbol*/
    lv_point_t offset;
    lv_coord_t w;          /*Width of the image (Handled by the library)*/
    lv_coord_t h;          /*Height of the image (Handled by the library)*/
    uint16_t angle;    /*rotation angle of the image*/
    lv_point_t pivot;     /*rotation center of the image*/
    uint16_t zoom;         /*256 means no zoom, 512 double size, 128 half size*/
    uint8_t src_type : 2;  /*See: lv_img_src_t*/
    uint8_t cf : 5;        /*Color format from `lv_img_color_format_t`*/
    uint8_t antialias : 1; /*Apply anti-aliasing in transformations (rotate, zoom)*/
    uint8_t obj_size_mode: 2; /*Image size mode when image size and object size is different.*/
} lv_img_t;
 
extern const lv_obj_class_t lv_img_class;
 
enum {
    LV_IMG_SIZE_MODE_VIRTUAL = 0,
 
    LV_IMG_SIZE_MODE_REAL,
};
 
typedef uint8_t lv_img_size_mode_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_img_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_img_set_src(lv_obj_t * obj, const void * src);
 
void lv_img_set_offset_x(lv_obj_t * obj, lv_coord_t x);
 
void lv_img_set_offset_y(lv_obj_t * obj, lv_coord_t y);
 
 
void lv_img_set_angle(lv_obj_t * obj, int16_t angle);
 
void lv_img_set_pivot(lv_obj_t * obj, lv_coord_t x, lv_coord_t y);
 
 
void lv_img_set_zoom(lv_obj_t * obj, uint16_t zoom);
 
void lv_img_set_antialias(lv_obj_t * obj, bool antialias);
 
void lv_img_set_size_mode(lv_obj_t * obj, lv_img_size_mode_t mode);
/*=====================
 * Getter functions
 *====================*/
 
const void * lv_img_get_src(lv_obj_t * obj);
 
lv_coord_t lv_img_get_offset_x(lv_obj_t * obj);
 
lv_coord_t lv_img_get_offset_y(lv_obj_t * obj);
 
uint16_t lv_img_get_angle(lv_obj_t * obj);
 
void lv_img_get_pivot(lv_obj_t * obj, lv_point_t * pivot);
 
uint16_t lv_img_get_zoom(lv_obj_t * obj);
 
bool lv_img_get_antialias(lv_obj_t * obj);
 
lv_img_size_mode_t lv_img_get_size_mode(lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
#define LV_IMG_DECLARE(var_name) extern const lv_img_dsc_t var_name;
 
#endif /*LV_USE_IMG*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_IMG_H*/