「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 | + | ::*https://docs.lvgl.io/8.2/overview/animation.html |
+ | =Animations= | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |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:<syntaxhighlight lang="C++" style="border:1px dashed gray;"> | ||
+ | void func(void * var, lv_anim_var_t value); | ||
+ | </syntaxhighlight>This prototype is compatible with the majority of the property ''set'' functions in LVGL. For example <code style="color: #bb0000;">lv_obj_set_x(obj, value)</code> or <code style="color: #bb0000;">lv_obj_set_width(obj, value)</code> | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | == Create an animation== | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |To create an animation an <code style="color: #bb0000;">lv_anim_t</code> variable has to be initialized and configured with <code style="color: #bb0000;">lv_anim_set_...()</code> functions.<syntaxhighlight lang="C++" style="border:1px dashed gray;"> | ||
+ | /* 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*/ | ||
+ | </syntaxhighlight>You can apply multiple different animations on the same variable at the same time. For example, animate the x and y coordinates with <code style="color: #bb0000;">lv_obj_set_x</code> and <code style="color: #bb0000;">lv_obj_set_y</code>. However, only one animation can exist with a given variable and function pair and <code style="color: #bb0000;">lv_anim_start()</code> will remove any existing animations for such a pair. | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==Animation path== | ||
+ | {| class="wikitable" | ||
+ | ! 英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |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: | ||
+ | *<code style="color: #bb0000;">lv_anim_path_linear</code> linear animation | ||
+ | *<code style="color: #bb0000;">lv_anim_path_step</code> change in one step at the end | ||
+ | *<code style="color: #bb0000;">lv_anim_path_ease_in</code> slow at the beginning | ||
+ | *<code style="color: #bb0000;">lv_anim_path_ease_out</code> slow at the end | ||
+ | *<code style="color: #bb0000;">lv_anim_path_ease_in_out</code> slow at the beginning and end | ||
+ | *<code style="color: #bb0000;">lv_anim_path_overshoot</code> overshoot the end value | ||
+ | *<code style="color: #bb0000;">lv_anim_path_bounce</code> bounce back a little from the end value (like hitting a wall) | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==Speed vs time== | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |By default, you set the animation time directly. But in some cases, setting the animation speed is more practical. | ||
+ | |||
+ | The <code style="color: #bb0000;">lv_anim_speed_to_time(speed, start, end)</code> function calculates the required time in milliseconds to reach the end value from a start value with the given speed. The speed is interpreted in ''unit/sec'' dimension. For example, <code style="color: #bb0000;">lv_anim_speed_to_time(20,0,100)</code> will yield 5000 milliseconds. For example, in the case of <code style="color: #bb0000;">lv_obj_set_x</code> ''unit'' is pixels so ''20'' means ''20 px/sec'' speed. | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==Delete animations== | ||
+ | {| class="wikitable" | ||
+ | ! 英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |You can delete an animation with <code style="color: #bb0000;">lv_anim_del(var, func)</code> if you provide the animated variable and its animator function. | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==Timeline== | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |A timeline is a collection of multiple animations which makes it easy to create complex composite animations. | ||
+ | |||
+ | Firstly, create an animation element but don’t call <code style="color: #bb0000;">lv_anim_start()</code>. | ||
+ | |||
+ | Secondly, create an animation timeline object by calling <code style="color: #bb0000;">lv_anim_timeline_create()</code>. | ||
+ | |||
+ | Thirdly, add animation elements to the animation timeline by calling <code style="color: #bb0000;">lv_anim_timeline_add(at, start_time, &a)</code>. <code style="color: #bb0000;">start_time</code> is the start time of the animation on the timeline. Note that <code style="color: #bb0000;">start_time</code> will override the value of <code style="color: #bb0000;">delay</code>. | ||
+ | |||
+ | Finally, call <code style="color: #bb0000;">lv_anim_timeline_start(at)</code> to start the animation timeline. | ||
+ | |||
+ | It supports forward and backward playback of the entire animation group, using <code style="color: #bb0000;">lv_anim_timeline_set_reverse(at, reverse)</code>. | ||
+ | |||
+ | Call <code style="color: #bb0000;">lv_anim_timeline_stop(at)</code> to stop the animation timeline. | ||
+ | |||
+ | Call <code style="color: #bb0000;">lv_anim_timeline_set_progress(at, progress)</code> function to set the state of the object corresponding to the progress of the timeline. | ||
+ | |||
+ | Call <code style="color: #bb0000;">lv_anim_timeline_get_playtime(at)</code> function to get the total duration of the entire animation timeline. | ||
+ | |||
+ | Call <code style="color: #bb0000;">lv_anim_timeline_get_reverse(at)</code> function to get whether to reverse the animation timeline. | ||
+ | |||
+ | Call <code style="color: #bb0000;">lv_anim_timeline_del(at)</code> function to delete the animation timeline. [[file:LVGL docs overview animation 01.png|400px|link=https://docs.lvgl.io/8.2/overview/animation.html#timeline]] | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==Examples== | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | | | ||
+ | ===Start animation on an event=== | ||
+ | [[file:LVGL docs example 018.png|link=https://docs.lvgl.io/8.2/overview/animation.html#start-animation-on-an-event]] | ||
+ | | | ||
+ | |- | ||
+ | | | ||
+ | ===Playback animation=== | ||
+ | [[file:LVGL docs example 019.png|link=https://docs.lvgl.io/8.2/overview/animation.html#playback-animation]] | ||
+ | | | ||
+ | |- | ||
+ | | | ||
+ | ===Animation timeline=== | ||
+ | [[file:LVGL docs example 020.png|link=https://docs.lvgl.io/8.2/overview/animation.html#animation-timeline]] | ||
+ | | | ||
+ | |} | ||
+ | :[[App:Library:LVGL:docs:Overview#Animations|戻る : Previous]] | ||
+ | ==API== | ||
+ | {| class="wikitable" | ||
+ | !英文 | ||
+ | !自動翻訳 | ||
+ | |- | ||
+ | |'''Typedefs''' | ||
+ | |||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*) </span> | ||
+ | :Get the current value during an animation | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef void (*lv_anim_exec_xcb_t)(void*, int32_t) </span> | ||
+ | :Generic prototype of "animator" functions. First parameter is the variable to animate. Second parameter is the value to set. Compatible with <code style="color: #bb0000;">lv_xxx_set_yyy(obj, value)</code> functions The <code style="color: #bb0000;">x</code> in <code style="color: #bb0000;">_xcb_t</code> means it's not a fully generic prototype because it doesn't receive <code style="color: #bb0000;">lv_anim_t *</code> as its first argument | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef void (*lv_anim_custom_exec_cb_t)(struct _lv_anim_t*, int32_t) </span> | ||
+ | :Same as <code style="color: #bb0000;">lv_anim_exec_xcb_t</code> but receives <code style="color: #bb0000;">lv_anim_t *</code> as the first parameter. It's more consistent but less convenient. Might be used by binding generator functions. | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef void (*lv_anim_ready_cb_t)(struct _lv_anim_t*) </span> | ||
+ | : Callback to call when the animation is ready | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef void (*lv_anim_start_cb_t)(struct _lv_anim_t*) </span> | ||
+ | :Callback to call when the animation really stars (considering <code style="color: #bb0000;">delay</code>) | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef int32_t (*lv_anim_get_value_cb_t)(struct _lv_anim_t*) </span> | ||
+ | :Callback used when the animation values are relative to get the current value | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">typedef struct _lv_anim_t lv_anim_t </span> | ||
+ | :Describes an animation | ||
+ | '''Enums''' | ||
+ | |||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">enum lv_anim_enable_t </span> | ||
+ | :Can be used to indicate if animations are enabled or disabled in a case ''Values:'' | ||
+ | :<span style="background-color: #eeeeee;">enumerator LV_ANIM_OFF </span> | ||
+ | :: | ||
+ | :<span style="background-color: #eeeeee;">enumerator LV_ANIM_ON </span> | ||
+ | :: | ||
+ | | | ||
+ | |- | ||
+ | |'''Functions''' | ||
+ | |||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">LV_EXPORT_CONST_INT(LV_ANIM_REPEAT_INFINITE) </span> | ||
+ | : | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">LV_EXPORT_CONST_INT(LV_ANIM_PLAYTIME_INFINITE) </span> | ||
+ | : | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">void _lv_anim_core_init(void) </span> | ||
+ | :Init. the animation module | ||
+ | <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); | ||
+ | :'''Parameters''' | ||
+ | ::'''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> | ||
+ | : Set a variable to animate | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set a function to animate <code style="color: #bb0000;">var</code> | ||
+ | :'''Parameters''' | ||
+ | ::*'''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 | ||
+ | <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 | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set a delay before starting the animation | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | : Set the start and end values of an animation | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''start''' -- the start 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> | ||
+ | :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''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set the path (curve) of the animation. | ||
+ | :'''Parameters''' | ||
+ | ::*'''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. | ||
+ | <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>) | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set a function to use the current value of the variable and make start and end value relative to the returned current value. | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set a function call when the animation is ready | ||
+ | :'''Parameters''' | ||
+ | ::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Make the animation to play back to when the forward direction is ready | ||
+ | : '''Parameters''' | ||
+ | ::*'''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 | ||
+ | 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 | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Make the animation repeat itself. | ||
+ | :'''Parameters''' | ||
+ | ::*'''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. | ||
+ | <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. | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Set a whether the animation's should be applied immediately or only when the delay expired. | ||
+ | :'''Parameters''' | ||
+ | ::*'''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 | ||
+ | <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. | ||
+ | :'''Parameters''' | ||
+ | ::*'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | ::*'''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> | ||
+ | :Create an animation | ||
+ | : '''Parameters''' | ||
+ | ::'''a''' -- an initialized 'anim_t' variable. Not required after call. | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :Get a delay before starting the animation | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | :'''Returns''' | ||
+ | ::delay before the animation in milliseconds | ||
+ | <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. | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation. | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :Get the user_data field of the animation | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :Delete an animation of a variable with a given animator function | ||
+ | :'''Parameters''' | ||
+ | ::*'''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 | ||
+ | :'''Returns''' | ||
+ | ::true: at least 1 animation is deleted, false: no animation is deleted | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">void lv_anim_del_all(void) </span> | ||
+ | :Delete all the animations | ||
+ | <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>. | ||
+ | :'''Parameters''' | ||
+ | ::*'''var''' -- pointer to variable | ||
+ | ::*'''exec_cb''' -- a function pointer which is animating 'var', or NULL to return first matching 'var' | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :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''' | ||
+ | ::*'''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 | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :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''' | ||
+ | ::*'''a''' -- pointer to an animation. | ||
+ | ::*'''exec_cb''' -- a function pointer which is animating 'var', or NULL to return first matching 'var' | ||
+ | :'''Returns''' | ||
+ | ::pointer to the animation. | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">uint16_t lv_anim_count_running(void) </span> | ||
+ | :Get the number of currently running animations | ||
+ | :'''Returns''' | ||
+ | :: 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> | ||
+ | :Calculate the time of an animation with a given speed and the start and end values | ||
+ | : '''Parameters''' | ||
+ | ::*'''speed''' -- speed of animation in unit/sec | ||
+ | ::*'''start''' -- start value of the animation | ||
+ | ::*'''end''' -- end value of the animation | ||
+ | :'''Returns''' | ||
+ | ::the required time [ms] for the animation with the given parameters | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">void lv_anim_refr_now(void) </span> | ||
+ | :Manually refresh the state of the animations. Useful to make the animations running in a blocking process where <code style="color: #bb0000;">lv_timer_handler</code> can't run for a while. Shouldn't be used directly because it is called in <code style="color: #bb0000;">lv_refr_now()</code>. | ||
+ | <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 | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | : Calculate the current value of an animation slowing down the start phase | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :Calculate the current value of an animation slowing down the end phase | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::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> | ||
+ | :Calculate the current value of an animation applying an "S" characteristic (cosine) | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation | ||
+ | : '''Returns''' | ||
+ | ::the current value to set | ||
+ | <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 | ||
+ | :'''Parameters''' | ||
+ | :: '''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::the current value to set | ||
+ | <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 | ||
+ | :'''Parameters''' | ||
+ | :: '''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::the current value to set | ||
+ | <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) | ||
+ | :'''Parameters''' | ||
+ | ::'''a''' -- pointer to an animation | ||
+ | :'''Returns''' | ||
+ | ::the current value to set | ||
+ | <span style="background-color:#e7f2fa;color:#2980b9;">struct _lv_anim_t </span> | ||
+ | :''#include <lv_anim.h>'' | ||
+ | : Describes an animation | ||
+ | : '''Public Members''' | ||
+ | :void *var | ||
+ | ::Variable to animate | ||
+ | :<span style="background-color: #eeeeee;">lv_anim_exec_xcb_t exec_cb </span> | ||
+ | ::Function to execute to animate | ||
+ | :<span style="background-color: #eeeeee;">lv_anim_start_cb_t start_cb </span> | ||
+ | ::Call it when the animation is starts (considering <code style="color: #bb0000;">delay</code>) | ||
+ | :<span style="background-color: #eeeeee;">lv_anim_ready_cb_t ready_cb </span> | ||
+ | ::Call it when the animation is ready | ||
+ | :<span style="background-color: #eeeeee;">lv_anim_get_value_cb_t get_value_cb </span> | ||
+ | ::Get the current value in relative mode | ||
+ | :<span style="background-color: #eeeeee;">void *user_data </span> | ||
+ | :: Custom user data | ||
+ | :<span style="background-color: #eeeeee;">lv_anim_path_cb_t path_cb </span> | ||
+ | ::Describe the path (curve) of animations | ||
+ | :<span style="background-color: #eeeeee;">int32_t start_value </span> | ||
+ | ::Start value | ||
+ | : | ||
+ | :<span style="background-color: #eeeeee;">int32_t current_value </span> | ||
+ | ::Current value | ||
+ | : | ||
+ | :<span style="background-color: #eeeeee;">int32_t end_value </span> | ||
+ | ::End value | ||
+ | : | ||
+ | :<span style="background-color: #eeeeee;">int32_t time </span> | ||
+ | ::Animation time in ms | ||
+ | :<span style="background-color: #eeeeee;">int32_t act_time </span> | ||
+ | ::Current time in animation. Set to negative to make delay. | ||
+ | :<span style="background-color: #eeeeee;">uint32_t playback_delay </span> | ||
+ | ::Wait before play back | ||
+ | :<span style="background-color: #eeeeee;">uint32_t playback_time </span> | ||
+ | ::Duration of playback animation | ||
+ | :<span style="background-color: #eeeeee;">uint32_t repeat_delay </span> | ||
+ | ::Wait before repeat | ||
+ | :<span style="background-color: #eeeeee;">uint16_t repeat_cnt </span> | ||
+ | :: Repeat count for the animation | ||
+ | :<span style="background-color: #eeeeee;">uint8_t early_apply </span> | ||
+ | ::1: Apply start value immediately even is there is <code style="color: #bb0000;">delay</code> | ||
+ | :<span style="background-color: #eeeeee;">uint8_t playback_now </span> | ||
+ | ::Play back is in progress | ||
+ | :<span style="background-color: #eeeeee;">uint8_t run_round </span> | ||
+ | ::Indicates the animation has run in this round | ||
+ | :<span style="background-color: #eeeeee;">uint8_t start_cb_called </span> | ||
+ | ::Indicates that the <code style="color: #bb0000;">start_cb</code> was already called | ||
+ | | | ||
+ | |}[[App:Library:LVGL#Overview|戻る : Previous]] | ||
+ | ::* -- 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 | ||
2022年7月2日 (土) 11:07時点における版
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)
Animations
Create an animation
Animation path
Speed vs time
Delete animations
TimelineExamples
API
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
|