「App:Library:LVGL:docs:Overview:Animations」の版間の差分
(→API) |
|||
195行目: | 195行目: | ||
|- | |- | ||
| | | | ||
− | Typedefs | + | '''Typedefs''' |
<span style="background-color:#e7f2fa;color:#2980b9;">typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*) </span> | ||
218行目: | 218行目: | ||
: Describes an animation | : Describes an animation | ||
− | Enums | + | '''Enums''' |
<span style="background-color:#e7f2fa;color:#2980b9;">enum lv_anim_enable_t </span> | <span style="background-color:#e7f2fa;color:#2980b9;">enum lv_anim_enable_t </span> | ||
229行目: | 229行目: | ||
|- | |- | ||
| | | | ||
− | Functions | + | '''Functions''' |
+ | |||
243行目: | 244行目: | ||
<span style="background-color:#e7f2fa;color:#2980b9;">void lv_anim_init(lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">void lv_anim_init(lv_anim_t *a) </span> | ||
: Initialize an animation variable. E.g.: lv_anim_t a; lv_anim_init(&a); lv_anim_set_...(&a); lv_anim_start(&a); | : Initialize an animation variable. E.g.: lv_anim_t a; lv_anim_init(&a); lv_anim_set_...(&a); lv_anim_start(&a); | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an <code style="color: #bb0000;">lv_anim_t</code> variable to initialize | + | :: '''a''' -- pointer to an <code style="color: #bb0000;">lv_anim_t</code> variable to initialize |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_var(lv_anim_t *a, void *var) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_var(lv_anim_t *a, void *var) </span> | ||
: Set a variable to animate | : Set a variable to animate | ||
: Parameters | : Parameters | ||
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* var -- pointer to a variable to animate | + | ::* '''var''' -- pointer to a variable to animate |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb) </span> | ||
: Set a function to animate <code style="color: #bb0000;">var</code> | : Set a function to animate <code style="color: #bb0000;">var</code> | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* exec_cb -- a function to execute during animation LVGL's built-in functions can be used. E.g. lv_obj_set_x | + | ::* '''exec_cb''' -- a function to execute during animation LVGL's built-in functions can be used. E.g. lv_obj_set_x |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration) </span> | ||
: Set the duration of an animation | : Set the duration of an animation | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* duration -- duration of the animation in milliseconds | + | ::* '''duration''' -- duration of the animation in milliseconds |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay) </span> | ||
: Set a delay before starting the animation | : Set a delay before starting the animation | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* delay -- delay before the animation in milliseconds | + | ::* '''delay''' -- delay before the animation in milliseconds |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end) </span> | ||
: Set the start and end values of an animation | : Set the start and end values of an animation | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* start -- the start value | + | ::* '''start''' -- the start value |
− | ::* end -- the end value | + | ::* '''end''' -- the end value |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | ||
: Similar to <code style="color: #bb0000;">lv_anim_set_exec_cb</code> but <code style="color: #bb0000;">lv_anim_custom_exec_cb_t</code> receives <code style="color: #bb0000;">lv_anim_t *</code> as its first parameter instead of <code style="color: #bb0000;">void *</code>. This function might be used when LVGL is bound to other languages because it's more consistent to have <code style="color: #bb0000;">lv_anim_t *</code> as first parameter. The variable to animate can be stored in the animation's <code style="color: #bb0000;">user_data</code> | : Similar to <code style="color: #bb0000;">lv_anim_set_exec_cb</code> but <code style="color: #bb0000;">lv_anim_custom_exec_cb_t</code> receives <code style="color: #bb0000;">lv_anim_t *</code> as its first parameter instead of <code style="color: #bb0000;">void *</code>. This function might be used when LVGL is bound to other languages because it's more consistent to have <code style="color: #bb0000;">lv_anim_t *</code> as first parameter. The variable to animate can be stored in the animation's <code style="color: #bb0000;">user_data</code> | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* exec_cb -- a function to execute. | + | ::* '''exec_cb''' -- a function to execute. |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb) </span> | ||
: Set the path (curve) of the animation. | : Set the path (curve) of the animation. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* path_cb -- a function to set the current value of the animation. | + | ::* '''path_cb''' -- a function to set the current value of the animation. |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_start_cb_t start_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_start_cb_t start_cb) </span> | ||
: Set a function call when the animation really starts (considering <code style="color: #bb0000;">delay</code>) | : Set a function call when the animation really starts (considering <code style="color: #bb0000;">delay</code>) | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* start_cb -- a function call when the animation starts | + | ::* '''start_cb''' -- a function call when the animation starts |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_get_value_cb(lv_anim_t *a, lv_anim_get_value_cb_t get_value_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_get_value_cb(lv_anim_t *a, lv_anim_get_value_cb_t get_value_cb) </span> | ||
: Set a function to use the current value of the variable and make start and end value relative to the returned current value. | : Set a function to use the current value of the variable and make start and end value relative to the returned current value. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* get_value_cb -- a function call when the animation starts | + | ::* '''get_value_cb''' -- a function call when the animation starts |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb) </span> | ||
: Set a function call when the animation is ready | : Set a function call when the animation is ready | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* ready_cb -- a function call when the animation is ready | + | ::* '''ready_cb''' -- a function call when the animation is ready |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time) </span> | ||
: Make the animation to play back to when the forward direction is ready | : Make the animation to play back to when the forward direction is ready | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* time -- the duration of the playback animation in milliseconds. 0: disable playback | + | ::* '''time''' -- the duration of the playback animation in milliseconds. 0: disable playback |
static inline void lv_anim_set_playback_delay(lv_anim_t *a, uint32_t delay) | static inline void lv_anim_set_playback_delay(lv_anim_t *a, uint32_t delay) | ||
: Make the animation to play back to when the forward direction is ready | : Make the animation to play back to when the forward direction is ready | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* delay -- delay in milliseconds before starting the playback animation. | + | ::* '''delay''' -- delay in milliseconds before starting the playback animation. |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt) </span> | ||
: Make the animation repeat itself. | : Make the animation repeat itself. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* cnt -- repeat count or <code style="color: #bb0000;">LV_ANIM_REPEAT_INFINITE</code> for infinite repetition. 0: to disable repetition. | + | ::* '''cnt''' -- repeat count or <code style="color: #bb0000;">LV_ANIM_REPEAT_INFINITE</code> for infinite repetition. 0: to disable repetition. |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay) </span> | ||
: Set a delay before repeating the animation. | : Set a delay before repeating the animation. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* delay -- delay in milliseconds before repeating the animation. | + | ::* '''delay''' -- delay in milliseconds before repeating the animation. |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en) </span> | ||
: Set a whether the animation's should be applied immediately or only when the delay expired. | : Set a whether the animation's should be applied immediately or only when the delay expired. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* en -- true: apply the start value immediately in <code style="color: #bb0000;">lv_anim_start</code>; false: apply the start value only when <code style="color: #bb0000;">delay</code> ms is elapsed and the animations really starts | + | ::* '''en''' -- true: apply the start value immediately in <code style="color: #bb0000;">lv_anim_start</code>; false: apply the start value only when <code style="color: #bb0000;">delay</code> ms is elapsed and the animations really starts |
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_user_data(lv_anim_t *a, void *user_data) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void lv_anim_set_user_data(lv_anim_t *a, void *user_data) </span> | ||
: Set the custom user data field of the animation. | : Set the custom user data field of the animation. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* | + | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | ::* user_data -- pointer to the new user_data. | + | ::* '''user_data''' -- pointer to the new user_data. |
<span style="background-color:#e7f2fa;color:#2980b9;">lv_anim_t *lv_anim_start(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">lv_anim_t *lv_anim_start(const lv_anim_t *a) </span> | ||
: Create an animation | : Create an animation | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- an initialized 'anim_t' variable. Not required after call. | + | :: '''a''' -- an initialized 'anim_t' variable. Not required after call. |
− | : Returns | + | : '''Returns''' |
:: pointer to the created animation (different from the <code style="color: #bb0000;">a</code> parameter) | :: pointer to the created animation (different from the <code style="color: #bb0000;">a</code> parameter) | ||
<span style="background-color:#e7f2fa;color:#2980b9;">static inline uint32_t lv_anim_get_delay(lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline uint32_t lv_anim_get_delay(lv_anim_t *a) </span> | ||
: Get a delay before starting the animation | : Get a delay before starting the animation | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | :: '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | : Returns | + | : '''Returns''' |
:: delay before the animation in milliseconds | :: delay before the animation in milliseconds | ||
<span style="background-color:#e7f2fa;color:#2980b9;">uint32_t lv_anim_get_playtime(lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">uint32_t lv_anim_get_playtime(lv_anim_t *a) </span> | ||
: Get the time used to play the animation. | : Get the time used to play the animation. | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation. | + | :: '''a''' -- pointer to an animation. |
− | : Returns | + | : '''Returns''' |
:: the play time in milliseconds. | :: the play time in milliseconds. | ||
<span style="background-color:#e7f2fa;color:#2980b9;">static inline void *lv_anim_get_user_data(lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline void *lv_anim_get_user_data(lv_anim_t *a) </span> | ||
: Get the user_data field of the animation | : Get the user_data field of the animation | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | + | :: '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable |
− | : Returns | + | : '''Returns''' |
:: the pointer to the custom user_data of the animation | :: the pointer to the custom user_data of the animation | ||
<span style="background-color:#e7f2fa;color:#2980b9;">bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb) </span> | ||
: Delete an animation of a variable with a given animator function | : Delete an animation of a variable with a given animator function | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* var -- pointer to variable | + | ::* '''var''' -- pointer to variable |
− | ::* exec_cb -- a function pointer which is animating 'var', or NULL to ignore it and delete all the animations of 'var | + | ::* '''exec_cb''' -- a function pointer which is animating 'var', or NULL to ignore it and delete all the animations of 'var |
− | : Returns | + | : '''Returns''' |
:: true: at least 1 animation is deleted, false: no animation is deleted | :: true: at least 1 animation is deleted, false: no animation is deleted | ||
384行目: | 385行目: | ||
<span style="background-color:#e7f2fa;color:#2980b9;">lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb) </span> | ||
: Get the animation of a variable and its <code style="color: #bb0000;">exec_cb</code>. | : Get the animation of a variable and its <code style="color: #bb0000;">exec_cb</code>. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* var -- pointer to variable | + | ::* '''var''' -- pointer to variable |
− | ::* exec_cb -- a function pointer which is animating 'var', or NULL to return first matching 'var' | + | ::* '''exec_cb''' -- a function pointer which is animating 'var', or NULL to return first matching 'var' |
− | : Returns | + | : '''Returns''' |
:: pointer to the animation. | :: pointer to the animation. | ||
<span style="background-color:#e7f2fa;color:#2980b9;">static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | ||
: Delete an animation by getting the animated variable from <code style="color: #bb0000;">a</code>. Only animations with <code style="color: #bb0000;">exec_cb</code> will be deleted. This function exists because it's logical that all anim. functions receives an <code style="color: #bb0000;">lv_anim_t</code> as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings. | : Delete an animation by getting the animated variable from <code style="color: #bb0000;">a</code>. Only animations with <code style="color: #bb0000;">exec_cb</code> will be deleted. This function exists because it's logical that all anim. functions receives an <code style="color: #bb0000;">lv_anim_t</code> as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an animation. | + | ::* '''a''' -- pointer to an animation. |
− | ::* exec_cb -- a function pointer which is animating 'var', or NULL to ignore it and delete all the animations of 'var | + | ::* '''exec_cb''' -- a function pointer which is animating 'var', or NULL to ignore it and delete all the animations of 'var |
− | : Returns | + | : '''Returns''' |
:: true: at least 1 animation is deleted, false: no animation is deleted | :: true: at least 1 animation is deleted, false: no animation is deleted | ||
<span style="background-color:#e7f2fa;color:#2980b9;">static inline lv_anim_t *lv_anim_custom_get(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">static inline lv_anim_t *lv_anim_custom_get(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb) </span> | ||
: Get the animation of a variable and its <code style="color: #bb0000;">exec_cb</code>. This function exists because it's logical that all anim. functions receives an <code style="color: #bb0000;">lv_anim_t</code> as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings. | : Get the animation of a variable and its <code style="color: #bb0000;">exec_cb</code>. This function exists because it's logical that all anim. functions receives an <code style="color: #bb0000;">lv_anim_t</code> as their first parameter. It's not practical in C but might make the API more consequent and makes easier to generate bindings. | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* a -- pointer to an animation. | + | ::* '''a''' -- pointer to an animation. |
− | ::* exec_cb -- a function pointer which is animating 'var', or NULL to return first matching 'var' | + | ::* '''exec_cb''' -- a function pointer which is animating 'var', or NULL to return first matching 'var' |
− | : Returns | + | : '''Returns''' |
:: pointer to the animation. | :: pointer to the animation. | ||
<span style="background-color:#e7f2fa;color:#2980b9;">uint16_t lv_anim_count_running(void) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">uint16_t lv_anim_count_running(void) </span> | ||
: Get the number of currently running animations | : Get the number of currently running animations | ||
− | : Returns | + | : '''Returns''' |
:: the number of running animations | :: the number of running animations | ||
<span style="background-color:#e7f2fa;color:#2980b9;">uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end) </span> | ||
: Calculate the time of an animation with a given speed and the start and end values | : Calculate the time of an animation with a given speed and the start and end values | ||
− | : Parameters | + | : '''Parameters''' |
− | ::* speed -- speed of animation in unit/sec | + | ::* '''speed''' -- speed of animation in unit/sec |
− | ::* start -- start value of the animation | + | ::* '''start''' -- start value of the animation |
− | ::* end -- end value of the animation | + | ::* '''end''' -- end value of the animation |
− | : Returns | + | : '''Returns''' |
:: the required time [ms] for the animation with the given parameters | :: the required time [ms] for the animation with the given parameters | ||
425行目: | 426行目: | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_linear(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_linear(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation applying linear characteristic | : Calculate the current value of an animation applying linear characteristic | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_in(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_in(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation slowing down the start phase | : Calculate the current value of an animation slowing down the start phase | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_out(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_out(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation slowing down the end phase | : Calculate the current value of an animation slowing down the end phase | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_in_out(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_ease_in_out(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation applying an "S" characteristic (cosine) | : Calculate the current value of an animation applying an "S" characteristic (cosine) | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_overshoot(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_overshoot(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation with overshoot at the end | : Calculate the current value of an animation with overshoot at the end | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_bounce(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_bounce(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation with 3 bounces | : Calculate the current value of an animation with 3 bounces | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_step(const lv_anim_t *a) </span> | <span style="background-color:#e7f2fa;color:#2980b9;">int32_t lv_anim_path_step(const lv_anim_t *a) </span> | ||
: Calculate the current value of an animation applying step characteristic. (Set end value on the end of the animation) | : Calculate the current value of an animation applying step characteristic. (Set end value on the end of the animation) | ||
− | : Parameters | + | : '''Parameters''' |
− | :: a -- pointer to an animation | + | :: '''a''' -- pointer to an animation |
− | : Returns | + | : '''Returns''' |
:: the current value to set | :: the current value to set | ||
<span style="background-color:#e7f2fa;color:#2980b9;">struct _lv_anim_t </span> | <span style="background-color:#e7f2fa;color:#2980b9;">struct _lv_anim_t </span> | ||
− | : ''#include < | + | : ''#include <lv_anim.h>'' |
+ | : Describes an animation | ||
+ | : '''Public Members''' | ||
: void *var | : void *var | ||
:: Variable to animate | :: Variable to animate | ||
500行目: | 503行目: | ||
:: Animation time in ms | :: Animation time in ms | ||
: <span style="background-color: #eeeeee;">int32_t act_time </span> | : <span style="background-color: #eeeeee;">int32_t act_time </span> | ||
− | :: Current time in animation. Set to negative to make delay. | + | :: Current time in animation. |
+ | :: Set to negative to make delay. | ||
: <span style="background-color: #eeeeee;">uint32_t playback_delay </span> | : <span style="background-color: #eeeeee;">uint32_t playback_delay </span> | ||
:: Wait before play back | :: Wait before play back |
2022年7月2日 (土) 11:14時点における版
https://docs.lvgl.io/8.2/overview/animation.html
Animations
英文 | 自動翻訳 |
---|---|
You can automatically change the value of a variable between a start and an end value using animations. Animation will happen by periodically calling an "animator" function with the corresponding value parameter. The animator functions have the following prototype: void func(void * var, lv_anim_var_t value);
This prototype is compatible with the majority of the property set functions in LVGL. For example |
Create an animation
英文 | 自動翻訳 |
---|---|
To create an animation an /* INITIALIZE AN ANIMATION
*-----------------------*/
lv_anim_t a;
lv_anim_init(&a);
/* MANDATORY SETTINGS
*------------------*/
/*Set the "animator" function*/
lv_anim_set_exec_cb(&a, (lv_anim_exec_xcb_t) lv_obj_set_x);
/*Set target of the animation*/
lv_anim_set_var(&a, obj);
/*Length of the animation [ms]*/
lv_anim_set_time(&a, duration);
/*Set start and end values. E.g. 0, 150*/
lv_anim_set_values(&a, start, end);
/* OPTIONAL SETTINGS
*------------------*/
/*Time to wait before starting the animation [ms]*/
lv_anim_set_delay(&a, delay);
/*Set path (curve). Default is linear*/
lv_anim_set_path(&a, lv_anim_path_ease_in);
/*Set a callback to indicate when the animation is ready (idle).*/
lv_anim_set_ready_cb(&a, ready_cb);
/*Set a callback to indicate when the animation is started (after delay).*/
lv_anim_set_start_cb(&a, start_cb);
/*When ready, play the animation backward with this duration. Default is 0 (disabled) [ms]*/
lv_anim_set_playback_time(&a, time);
/*Delay before playback. Default is 0 (disabled) [ms]*/
lv_anim_set_playback_delay(&a, delay);
/*Number of repetitions. Default is 1. LV_ANIM_REPEAT_INFINITE for infinite repetition*/
lv_anim_set_repeat_count(&a, cnt);
/*Delay before repeat. Default is 0 (disabled) [ms]*/
lv_anim_set_repeat_delay(&a, delay);
/*true (default): apply the start value immediately, false: apply start value after delay when the anim. really starts. */
lv_anim_set_early_apply(&a, true/false);
/* START THE ANIMATION
*------------------*/
lv_anim_start(&a); /*Start the animation*/
You can apply multiple different animations on the same variable at the same time. For example, animate the x and y coordinates with |
Animation path
英文 | 自動翻訳 |
---|---|
You can control the path of an animation. The most simple case is linear, meaning the current value between start and end is changed with fixed steps. A path is a function which calculates the next value to set based on the current state of the animation. Currently, there are the following built-in path functions:
|
Speed vs time
英文 | 自動翻訳 |
---|---|
By default, you set the animation time directly. But in some cases, setting the animation speed is more practical. The |
Delete animations
英文 | 自動翻訳 |
---|---|
You can delete an animation with |
Timeline
Examples
英文 | 自動翻訳 |
---|---|
Start animation on an event |
|
Playback animation |
|
Animation timeline |
API
英文 | 自動翻訳 |
---|---|
Typedefs typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*)
typedef void (*lv_anim_exec_xcb_t)(void*, int32_t)
typedef void (*lv_anim_custom_exec_cb_t)(struct _lv_anim_t*, int32_t)
typedef void (*lv_anim_ready_cb_t)(struct _lv_anim_t*)
typedef void (*lv_anim_start_cb_t)(struct _lv_anim_t*)
typedef int32_t (*lv_anim_get_value_cb_t)(struct _lv_anim_t*)
typedef struct _lv_anim_t lv_anim_t
Enums enum lv_anim_enable_t
|
|
Functions
LV_EXPORT_CONST_INT(LV_ANIM_REPEAT_INFINITE) LV_EXPORT_CONST_INT(LV_ANIM_PLAYTIME_INFINITE) void _lv_anim_core_init(void)
void lv_anim_init(lv_anim_t *a)
static inline void lv_anim_set_var(lv_anim_t *a, void *var)
static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb)
static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration)
static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay)
static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end)
static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)
static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb)
static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_start_cb_t start_cb)
static inline void lv_anim_set_get_value_cb(lv_anim_t *a, lv_anim_get_value_cb_t get_value_cb)
static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb)
static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time)
static inline void lv_anim_set_playback_delay(lv_anim_t *a, uint32_t delay)
static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt)
static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay)
static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en)
static inline void lv_anim_set_user_data(lv_anim_t *a, void *user_data)
lv_anim_t *lv_anim_start(const lv_anim_t *a)
static inline uint32_t lv_anim_get_delay(lv_anim_t *a)
uint32_t lv_anim_get_playtime(lv_anim_t *a)
static inline void *lv_anim_get_user_data(lv_anim_t *a)
bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb)
void lv_anim_del_all(void)
lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb)
static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)
static inline lv_anim_t *lv_anim_custom_get(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)
uint16_t lv_anim_count_running(void)
uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end)
void lv_anim_refr_now(void)
int32_t lv_anim_path_linear(const lv_anim_t *a)
int32_t lv_anim_path_ease_in(const lv_anim_t *a)
int32_t lv_anim_path_ease_out(const lv_anim_t *a)
int32_t lv_anim_path_ease_in_out(const lv_anim_t *a)
int32_t lv_anim_path_overshoot(const lv_anim_t *a)
int32_t lv_anim_path_bounce(const lv_anim_t *a)
int32_t lv_anim_path_step(const lv_anim_t *a)
struct _lv_anim_t
|