lv_rlottie.h
API reference for lv_rlottie.h
Functions
lv_rlottie_set_play_mode
Set how the animation is played.
> Deprecated: rlottie is deprecated. Use the lv_lottie widget instead.
void lv_rlottie_set_play_mode(lv_obj_t *rlottie, const lv_rlottie_ctrl_t ctrl)| Name | Type | Description |
|---|---|---|
rlottie | lv_obj_t * | pointer to an rlottie widget |
ctrl | const lv_rlottie_ctrl_t | OR-ed values of lv_rlottie_ctrl_t, e.g. `LV_RLOTTIE_CTRL_BACKWARD |
lv_rlottie_set_current_frame
Jump to a given frame of the animation.
> Deprecated: rlottie is deprecated. Use the lv_lottie widget instead.
void lv_rlottie_set_current_frame(lv_obj_t *rlottie, const size_t goto_frame)| Name | Type | Description |
|---|---|---|
rlottie | lv_obj_t * | pointer to an rlottie widget |
goto_frame | const size_t | zero based index of the frame to show. Values not smaller than the total frame count select the last frame. |
lv_rlottie_create_from_file
Create an rlottie animation from a JSON file. The animation starts playing forward in a loop right away.
rlottie doesn't use LVGL's File System API.
> Deprecated: rlottie is deprecated. Use the lv_lottie widget instead.
lv_obj_t * lv_rlottie_create_from_file(lv_obj_t *parent, int32_t width, int32_t height, const char *path)| Name | Type | Description |
|---|---|---|
parent | lv_obj_t * | pointer to a parent widget May be NULL.. When NULL, the widget is created as a screen on the active display. |
width | int32_t | width of the animation and its render buffer in pixels |
height | int32_t | height of the animation and its render buffer in pixels |
path | const char * | path to a json file, e.g. "path/to/file.json" |
Returns: lv_obj_t * — pointer to the created rlottie widget, or NULL if path is NULL
lv_rlottie_create_from_raw
Create an rlottie animation from a raw JSON description. The animation starts playing forward in a loop right away.
> Deprecated: rlottie is deprecated. Use the lv_lottie widget instead.
lv_obj_t * lv_rlottie_create_from_raw(lv_obj_t *parent, int32_t width, int32_t height, const char *rlottie_desc)| Name | Type | Description |
|---|---|---|
parent | lv_obj_t * | pointer to a parent widget May be NULL.. When NULL, the widget is created as a screen on the active display. |
width | int32_t | width of the animation and its render buffer in pixels |
height | int32_t | height of the animation and its render buffer in pixels |
rlottie_desc | const char * | the lottie animation as a nul terminated string |
Returns: lv_obj_t * — pointer to the created rlottie widget, or NULL if rlottie_desc is NULL
Enums
lv_rlottie_ctrl_t
| Name | Value |
|---|---|
LV_RLOTTIE_CTRL_FORWARD | 0 |
LV_RLOTTIE_CTRL_BACKWARD | 1 |
LV_RLOTTIE_CTRL_PAUSE | 2 |
LV_RLOTTIE_CTRL_PLAY | 0 |
LV_RLOTTIE_CTRL_LOOP | 8 |
Used by 1 function
lv_rlottie_set_play_mode— paramctrl
Macros
LV_RLOTTIE_DEPRECATED_MSG
#define LV_RLOTTIE_DEPRECATED_MSG "rlottie is deprecated; use the lv_lottie widget instead."> Deprecated: The rlottie player is deprecated and kept only for backward compatibility. Use the lv_lottie widget instead. See the Lottie widget docs.
Variables
lv_rlottie_class
const lv_obj_class_t lv_rlottie_classDependencies
Last updated on