「App:Library:LVGL:docs:Overview:Animations」の版間の差分

提供: robot-jp wiki
ナビゲーションに移動検索に移動
288行目: 288行目:
 
<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
  
313行目: 313行目:
 
<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
564行目: 565行目:
  
 
<span style="background-color:#e7f2fa;color:#2980b9;">void _lv_anim_core_init(void) </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>
 
<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);
+
: アニメーション変数を初期化する。例: 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''' -- 初期化する <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタを指定します。
  
 
<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
+
: アニメーションを行う変数を設定する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ。
−
::* '''var''' -- pointer to a variable to animate
+
::* '''var''' -- アニメーションを行う変数へのポインタ
  
 
<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>
+
: アニメーション<code style="color: #bb0000;">var</code>を行う関数を設定する
−
: Parameters
+
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ。
−
::* '''exec_cb''' -- a function to execute during animation LVGL's built-in functions can be used. E.g. lv_obj_set_x
+
::*'''exec_cb''' -- アニメーション中に実行する関数 LVGL の組み込み関数を使用することができます．例：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
+
: アニメーションのデュレーションを設定する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ。
−
::* '''duration''' -- duration of the animation in milliseconds
+
::* '''duration''' -- アニメーションの継続時間（単位：ミリ秒
  
 
<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
+
: アニメーションを開始するまでの遅延時間を設定する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ。
−
::* '''delay''' -- delay before the animation in milliseconds
+
::* '''delay''' -- アニメーションの前の遅延時間（ミリ秒単位)
  
 
<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
+
: アニメーションの開始値と終了値を設定する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code>変数へのポインタ。
−
::* '''start''' -- the start value
+
::* '''start''' -- 開始値
−
::* '''end''' -- the end value
+
::* '''end''' --終わり値
  
 
<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>
+
:<code style="color: #bb0000;">lv_anim_set_exec_cb</code>と似ていますが、 <code style="color: #bb0000;">lv_anim_custom_exec_cb_t</code> は <code style="color: #bb0000;">void *</code> の代わりに<code style="color: #bb0000;">lv_anim_t *</code>を最初の引数として受け取ります。
−
: '''Parameters'''
+
: この関数は、LVGLが他の言語にバインドされている場合に使用できます。これは、最初のパラメーターとして<code style="color: #bb0000;">lv_anim_t *</code>を使用する方が一貫性があるためです。
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
: アニメーションさせる変数は，アニメーションの<code style="color: #bb0000;">user_data</code>に格納することができます．
−
::* '''exec_cb''' -- a function to execute.
+
:
 +
:'''Parameters'''
 +
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code>変数へのポインタ
 +
::*'''exec_cb''' -- 実行する関数。
  
 
<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.
+
: アニメーションのパス (カーブ) を設定します。
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ
−
::* '''path_cb''' -- a function to set the current value of the animation.
+
::* '''path_cb''' -- アニメーションの現在の値を設定する関数。
  
 
<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>)
+
: アニメーションが実際に開始するときに関数呼び出しを設定する (<code style="color: #bb0000;">delay</code>を考慮)
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ
−
::* '''start_cb''' -- a function call when the animation starts
+
::* '''start_cb''' -- アニメーション開始時の関数呼び出し
  
 
<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.
+
: 変数の現在の値を使用し、戻り値に相対的な開始値と終了値を作成する関数を設定します。
−
: '''Parameters'''
+
:
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
:'''Parameters'''
−
::* '''get_value_cb''' -- a function call when the animation starts
+
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ
 +
::*'''get_value_cb''' -- アニメーション開始時の関数呼び出し
  
 
<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
+
: アニメーションの準備ができたときに関数呼び出しを設定する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ
−
::* '''ready_cb''' -- a function call when the animation is ready
+
::* '''ready_cb''' -- アニメーションの準備ができたときの関数呼び出し
  
 
<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
+
: 順方向の準備ができたらアニメーションを再生する
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された<code style="color: #bb0000;">lv_anim_t</code>変数へのポインタ
−
::* '''time''' -- the duration of the playback animation in milliseconds. 0: disable playback
+
::* '''time''' -- 再生アニメーションの継続時間 (ミリ秒単位) 。0:再生を無効にします。
  
 
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
+
: 順方向の準備ができたときに再生するアニメーションを作る
 
: '''Parameters'''
 
: '''Parameters'''
−
::* '''a''' -- pointer to an initialized <code style="color: #bb0000;">lv_anim_t</code> variable
+
::*'''a''' -- 初期化された <code style="color: #bb0000;">lv_anim_t</code> 変数へのポインタ。
−
::* '''delay''' -- delay in milliseconds before starting the playback animation.
+
::* '''delay''' -- 再生アニメーションを開始するまでの遅延時間をミリ秒単位で指定します。
  
 
<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>

2022年7月2日 (土) 11:39時点における版

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 lv_obj_set_x(obj, value) or lv_obj_set_width(obj, value)

戻る : Previous


Create an animation

英文 自動翻訳

To create an animation an lv_anim_t variable has to be initialized and configured with lv_anim_set_...() functions. 

 /* 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 lv_obj_set_x and lv_obj_set_y. However, only one animation can exist with a given variable and function pair and lv_anim_start() will remove any existing animations for such a pair.

戻る : Previous


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:

  • lv_anim_path_linear linear animation
  • lv_anim_path_step change in one step at the end
  • lv_anim_path_ease_in slow at the beginning
  • lv_anim_path_ease_out slow at the end
  • lv_anim_path_ease_in_out slow at the beginning and end
  • lv_anim_path_overshoot overshoot the end value
  • lv_anim_path_bounce bounce back a little from the end value (like hitting a wall)
戻る : Previous


Speed vs time

英文 自動翻訳

By default, you set the animation time directly. But in some cases, setting the animation speed is more practical.

The lv_anim_speed_to_time(speed, start, end) 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, lv_anim_speed_to_time(20,0,100) will yield 5000 milliseconds. For example, in the case of lv_obj_set_x unit is pixels so 20 means 20 px/sec speed.

戻る : Previous


Delete animations

英文 自動翻訳

You can delete an animation with lv_anim_del(var, func) if you provide the animated variable and its animator function.

戻る : Previous


Timeline

英文 自動翻訳

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 lv_anim_start().

Secondly, create an animation timeline object by calling lv_anim_timeline_create().

Thirdly, add animation elements to the animation timeline by calling lv_anim_timeline_add(at, start_time, &a). start_time is the start time of the animation on the timeline. Note that start_time will override the value of delay.

Finally, call lv_anim_timeline_start(at) to start the animation timeline.

It supports forward and backward playback of the entire animation group, using lv_anim_timeline_set_reverse(at, reverse).

Call lv_anim_timeline_stop(at) to stop the animation timeline.

Call lv_anim_timeline_set_progress(at, progress) function to set the state of the object corresponding to the progress of the timeline.

Call lv_anim_timeline_get_playtime(at) function to get the total duration of the entire animation timeline.

Call lv_anim_timeline_get_reverse(at) function to get whether to reverse the animation timeline.

Call lv_anim_timeline_del(at) function to delete the animation timeline. LVGL docs overview animation 01.png

戻る : Previous

Examples

英文 自動翻訳

Start animation on an event

LVGL docs example 018.png

Playback animation

LVGL docs example 019.png

Animation timeline

LVGL docs example 020.png

戻る : Previous


API

英文 自動翻訳
Typedefs

typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*)

Get the current value during an animation

typedef void (*lv_anim_exec_xcb_t)(void*, int32_t)

Generic prototype of "animator" functions. First parameter is the variable to animate. Second parameter is the value to set. Compatible with lv_xxx_set_yyy(obj, value) functions The x in _xcb_t means it's not a fully generic prototype because it doesn't receive lv_anim_t * as its first argument

typedef void (*lv_anim_custom_exec_cb_t)(struct _lv_anim_t*, int32_t)

Same as lv_anim_exec_xcb_t but receives lv_anim_t * as the first parameter. It's more consistent but less convenient. Might be used by binding generator functions.

typedef void (*lv_anim_ready_cb_t)(struct _lv_anim_t*)

Callback to call when the animation is ready

typedef void (*lv_anim_start_cb_t)(struct _lv_anim_t*)

Callback to call when the animation really stars (considering delay)

typedef int32_t (*lv_anim_get_value_cb_t)(struct _lv_anim_t*)

Callback used when the animation values are relative to get the current value

typedef struct _lv_anim_t lv_anim_t

Describes an animation

Enums

enum lv_anim_enable_t

Can be used to indicate if animations are enabled or disabled in a case Values:
enumerator LV_ANIM_OFF
enumerator LV_ANIM_ON
Typedefs

typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t*)

アニメーション中の現在値を取得する

typedef void (*lv_anim_exec_xcb_t)(void*, int32_t)

animator "関数の一般的なプロトタイプ。第1パラメータはアニメートする変数。 第2パラメータは設定する値。lv_xxx_set_yyy(obj, value)関数と互換性がある。 _xcb_t の x は、第一引数に lv_anim_t * を受け取らないので、完全な汎用プロトタイプでないことを意味します。

typedef void (*lv_anim_custom_exec_cb_t)(struct _lv_anim_t*, int32_t)

lv_anim_exec_xcb_t と同じですが、最初のパラメータとしてlv_anim_t *を受け取ります。
より一貫性がありますが、便利ではありません。
バインドジェネレータ関数で使用されるかもしれません。

typedef void (*lv_anim_ready_cb_t)(struct _lv_anim_t*)

アニメーションの準備ができたときに呼び出されるコールバック

typedef void (*lv_anim_start_cb_t)(struct _lv_anim_t*)

アニメーションが本当に始まるときに呼び出されるコールバック（delayを考慮したもの）

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

ケース値において、アニメーションの有効・無効を示すことができる。
enumerator LV_ANIM_OFF
enumerator LV_ANIM_ON

Functions


LV_EXPORT_CONST_INT(LV_ANIM_REPEAT_INFINITE)

LV_EXPORT_CONST_INT(LV_ANIM_PLAYTIME_INFINITE)

void _lv_anim_core_init(void)

Init. the animation module

void lv_anim_init(lv_anim_t *a)

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 lv_anim_t variable to initialize

static inline void lv_anim_set_var(lv_anim_t *a, void *var)

Set a variable to animate
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • var -- pointer to a variable to animate

static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb)

Set a function to animate var
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • exec_cb -- a function to execute during animation LVGL's built-in functions can be used. E.g. lv_obj_set_x

static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration)

Set the duration of an animation
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • duration -- duration of the animation in milliseconds

static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay)

Set a delay before starting the animation
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • delay -- delay before the animation in milliseconds

static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end)

Set the start and end values of an animation
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • start -- the start value
  • end -- the end value

static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

Similar to lv_anim_set_exec_cb but lv_anim_custom_exec_cb_t receives lv_anim_t * as its first parameter instead of void *. This function might be used when LVGL is bound to other languages because it's more consistent to have lv_anim_t * as first parameter. The variable to animate can be stored in the animation's user_data
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • exec_cb -- a function to execute.

static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb)

Set the path (curve) of the animation.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • path_cb -- a function to set the current value of the animation.

static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_start_cb_t start_cb)

Set a function call when the animation really starts (considering delay)
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • start_cb -- a function call when the animation starts

static inline void lv_anim_set_get_value_cb(lv_anim_t *a, lv_anim_get_value_cb_t get_value_cb)

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 lv_anim_t variable
  • get_value_cb -- a function call when the animation starts

static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb)

Set a function call when the animation is ready
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • ready_cb -- a function call when the animation is ready

static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time)

Make the animation to play back to when the forward direction is ready
Parameters
  • a -- pointer to an initialized lv_anim_t 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 lv_anim_t variable
  • delay -- delay in milliseconds before starting the playback animation.

static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt)

Make the animation repeat itself.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • cnt -- repeat count or LV_ANIM_REPEAT_INFINITE for infinite repetition. 0: to disable repetition.

static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay)

Set a delay before repeating the animation.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • delay -- delay in milliseconds before repeating the animation.

static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en)

Set a whether the animation's should be applied immediately or only when the delay expired.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • en -- true: apply the start value immediately in lv_anim_start; false: apply the start value only when delay ms is elapsed and the animations really starts

static inline void lv_anim_set_user_data(lv_anim_t *a, void *user_data)

Set the custom user data field of the animation.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • user_data -- pointer to the new user_data.

lv_anim_t *lv_anim_start(const lv_anim_t *a)

Create an animation
Parameters
a -- an initialized 'anim_t' variable. Not required after call.
Returns
pointer to the created animation (different from the a parameter)

static inline uint32_t lv_anim_get_delay(lv_anim_t *a)

Get a delay before starting the animation
Parameters
a -- pointer to an initialized lv_anim_t variable
Returns
delay before the animation in milliseconds

uint32_t lv_anim_get_playtime(lv_anim_t *a)

Get the time used to play the animation.
Parameters
a -- pointer to an animation.
Returns
the play time in milliseconds.

static inline void *lv_anim_get_user_data(lv_anim_t *a)

Get the user_data field of the animation
Parameters
a -- pointer to an initialized lv_anim_t variable
Returns
the pointer to the custom user_data of the animation

bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb)

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

void lv_anim_del_all(void)

Delete all the animations

lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb)

Get the animation of a variable and its exec_cb.
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.

static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

Delete an animation by getting the animated variable from a. Only animations with exec_cb will be deleted. This function exists because it's logical that all anim. functions receives an lv_anim_t 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

static inline lv_anim_t *lv_anim_custom_get(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

Get the animation of a variable and its exec_cb. This function exists because it's logical that all anim. functions receives an lv_anim_t 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.

uint16_t lv_anim_count_running(void)

Get the number of currently running animations
Returns
the number of running animations

uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end)

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

void lv_anim_refr_now(void)

Manually refresh the state of the animations. Useful to make the animations running in a blocking process where lv_timer_handler can't run for a while. Shouldn't be used directly because it is called in lv_refr_now().

int32_t lv_anim_path_linear(const lv_anim_t *a)

Calculate the current value of an animation applying linear characteristic
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_in(const lv_anim_t *a)

Calculate the current value of an animation slowing down the start phase
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_out(const lv_anim_t *a)

Calculate the current value of an animation slowing down the end phase
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_in_out(const lv_anim_t *a)

Calculate the current value of an animation applying an "S" characteristic (cosine)
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_overshoot(const lv_anim_t *a)

Calculate the current value of an animation with overshoot at the end
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_bounce(const lv_anim_t *a)

Calculate the current value of an animation with 3 bounces
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_step(const lv_anim_t *a)

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

struct _lv_anim_t

#include <lv_anim.h>
Describes an animation
Public Members
void *var
Variable to animate
lv_anim_exec_xcb_t exec_cb
Function to execute to animate
lv_anim_start_cb_t start_cb
Call it when the animation is starts (considering delay)
lv_anim_ready_cb_t ready_cb
Call it when the animation is ready
lv_anim_get_value_cb_t get_value_cb
Get the current value in relative mode
void *user_data
Custom user data
lv_anim_path_cb_t path_cb
Describe the path (curve) of animations
int32_t start_value
Start value
int32_t current_value
Current value
int32_t end_value
End value
int32_t time
Animation time in ms
int32_t act_time
Current time in animation.
Set to negative to make delay.
uint32_t playback_delay
Wait before play back
uint32_t playback_time
Duration of playback animation
uint32_t repeat_delay
Wait before repeat
uint16_t repeat_cnt
Repeat count for the animation
uint8_t early_apply
1: Apply start value immediately even is there is delay
uint8_t playback_now
Play back is in progress
uint8_t run_round
Indicates the animation has run in this round
uint8_t start_cb_called
Indicates that the start_cb was already called
 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)

アニメーション変数を初期化する。例: lv_anim_t a; lv_anim_init(&a); lv_anim_set_...(&a); lv_anim_start(&a);
Parameters
a -- 初期化する lv_anim_t 変数へのポインタを指定します。

static inline void lv_anim_set_var(lv_anim_t *a, void *var)

アニメーションを行う変数を設定する
Parameters
  • a -- 初期化された lv_anim_t 変数へのポインタ。
  • var -- アニメーションを行う変数へのポインタ

static inline void lv_anim_set_exec_cb(lv_anim_t *a, lv_anim_exec_xcb_t exec_cb)

アニメーションvarを行う関数を設定する
Parameters
  • a -- 初期化された lv_anim_t 変数へのポインタ。
  • exec_cb -- アニメーション中に実行する関数 LVGL の組み込み関数を使用することができます．例：lv_obj_set_x

static inline void lv_anim_set_time(lv_anim_t *a, uint32_t duration)

アニメーションのデュレーションを設定する
Parameters
  • a -- 初期化された lv_anim_t 変数へのポインタ。
  • duration -- アニメーションの継続時間（単位：ミリ秒

static inline void lv_anim_set_delay(lv_anim_t *a, uint32_t delay)

アニメーションを開始するまでの遅延時間を設定する
Parameters
  • a -- 初期化された lv_anim_t 変数へのポインタ。
  • delay -- アニメーションの前の遅延時間（ミリ秒単位)

static inline void lv_anim_set_values(lv_anim_t *a, int32_t start, int32_t end)

アニメーションの開始値と終了値を設定する
Parameters
  • a -- 初期化された lv_anim_t変数へのポインタ。
  • start -- 開始値
  • end --終わり値

static inline void lv_anim_set_custom_exec_cb(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

lv_anim_set_exec_cbと似ていますが、 lv_anim_custom_exec_cb_t は void * の代わりにlv_anim_t *を最初の引数として受け取ります。
この関数は、LVGLが他の言語にバインドされている場合に使用できます。これは、最初のパラメーターとしてlv_anim_t *を使用する方が一貫性があるためです。
アニメーションさせる変数は，アニメーションのuser_dataに格納することができます．
Parameters
  • a -- 初期化されたlv_anim_t変数へのポインタ
  • exec_cb -- 実行する関数。

static inline void lv_anim_set_path_cb(lv_anim_t *a, lv_anim_path_cb_t path_cb)

アニメーションのパス (カーブ) を設定します。
Parameters
  • a -- 初期化されたlv_anim_t 変数へのポインタ
  • path_cb -- アニメーションの現在の値を設定する関数。

static inline void lv_anim_set_start_cb(lv_anim_t *a, lv_anim_start_cb_t start_cb)

アニメーションが実際に開始するときに関数呼び出しを設定する (delayを考慮)
Parameters
  • a -- 初期化されたlv_anim_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)

変数の現在の値を使用し、戻り値に相対的な開始値と終了値を作成する関数を設定します。
Parameters
  • a -- 初期化されたlv_anim_t 変数へのポインタ
  • get_value_cb -- アニメーション開始時の関数呼び出し

static inline void lv_anim_set_ready_cb(lv_anim_t *a, lv_anim_ready_cb_t ready_cb)

アニメーションの準備ができたときに関数呼び出しを設定する
Parameters
  • a -- 初期化されたlv_anim_t 変数へのポインタ
  • ready_cb -- アニメーションの準備ができたときの関数呼び出し

static inline void lv_anim_set_playback_time(lv_anim_t *a, uint32_t time)

順方向の準備ができたらアニメーションを再生する
Parameters
  • a -- 初期化されたlv_anim_t変数へのポインタ
  • time -- 再生アニメーションの継続時間 (ミリ秒単位) 。0:再生を無効にします。

static inline void lv_anim_set_playback_delay(lv_anim_t *a, uint32_t delay)

順方向の準備ができたときに再生するアニメーションを作る
Parameters
  • a -- 初期化された lv_anim_t 変数へのポインタ。
  • delay -- 再生アニメーションを開始するまでの遅延時間をミリ秒単位で指定します。

static inline void lv_anim_set_repeat_count(lv_anim_t *a, uint16_t cnt)

Make the animation repeat itself.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • cnt -- repeat count or LV_ANIM_REPEAT_INFINITE for infinite repetition. 0: to disable repetition.

static inline void lv_anim_set_repeat_delay(lv_anim_t *a, uint32_t delay)

Set a delay before repeating the animation.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • delay -- delay in milliseconds before repeating the animation.

static inline void lv_anim_set_early_apply(lv_anim_t *a, bool en)

Set a whether the animation's should be applied immediately or only when the delay expired.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • en -- true: apply the start value immediately in lv_anim_start; false: apply the start value only when delay ms is elapsed and the animations really starts

static inline void lv_anim_set_user_data(lv_anim_t *a, void *user_data)

Set the custom user data field of the animation.
Parameters
  • a -- pointer to an initialized lv_anim_t variable
  • user_data -- pointer to the new user_data.

lv_anim_t *lv_anim_start(const lv_anim_t *a)

Create an animation
Parameters
a -- an initialized 'anim_t' variable. Not required after call.
Returns
pointer to the created animation (different from the a parameter)

static inline uint32_t lv_anim_get_delay(lv_anim_t *a)

Get a delay before starting the animation
Parameters
a -- pointer to an initialized lv_anim_t variable
Returns
delay before the animation in milliseconds

uint32_t lv_anim_get_playtime(lv_anim_t *a)

Get the time used to play the animation.
Parameters
a -- pointer to an animation.
Returns
the play time in milliseconds.

static inline void *lv_anim_get_user_data(lv_anim_t *a)

Get the user_data field of the animation
Parameters
a -- pointer to an initialized lv_anim_t variable
Returns
the pointer to the custom user_data of the animation

bool lv_anim_del(void *var, lv_anim_exec_xcb_t exec_cb)

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

void lv_anim_del_all(void)

Delete all the animations

lv_anim_t *lv_anim_get(void *var, lv_anim_exec_xcb_t exec_cb)

Get the animation of a variable and its exec_cb.
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.

static inline bool lv_anim_custom_del(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

Delete an animation by getting the animated variable from a. Only animations with exec_cb will be deleted. This function exists because it's logical that all anim. functions receives an lv_anim_t 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

static inline lv_anim_t *lv_anim_custom_get(lv_anim_t *a, lv_anim_custom_exec_cb_t exec_cb)

Get the animation of a variable and its exec_cb. This function exists because it's logical that all anim. functions receives an lv_anim_t 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.

uint16_t lv_anim_count_running(void)

Get the number of currently running animations
Returns
the number of running animations

uint32_t lv_anim_speed_to_time(uint32_t speed, int32_t start, int32_t end)

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

void lv_anim_refr_now(void)

Manually refresh the state of the animations. Useful to make the animations running in a blocking process where lv_timer_handler can't run for a while. Shouldn't be used directly because it is called in lv_refr_now().

int32_t lv_anim_path_linear(const lv_anim_t *a)

Calculate the current value of an animation applying linear characteristic
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_in(const lv_anim_t *a)

Calculate the current value of an animation slowing down the start phase
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_out(const lv_anim_t *a)

Calculate the current value of an animation slowing down the end phase
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_ease_in_out(const lv_anim_t *a)

Calculate the current value of an animation applying an "S" characteristic (cosine)
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_overshoot(const lv_anim_t *a)

Calculate the current value of an animation with overshoot at the end
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_bounce(const lv_anim_t *a)

Calculate the current value of an animation with 3 bounces
Parameters
a -- pointer to an animation
Returns
the current value to set

int32_t lv_anim_path_step(const lv_anim_t *a)

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

struct _lv_anim_t

#include <lv_anim.h>
Describes an animation
Public Members
void *var
Variable to animate
lv_anim_exec_xcb_t exec_cb
Function to execute to animate
lv_anim_start_cb_t start_cb
Call it when the animation is starts (considering delay)
lv_anim_ready_cb_t ready_cb
Call it when the animation is ready
lv_anim_get_value_cb_t get_value_cb
Get the current value in relative mode
void *user_data
Custom user data
lv_anim_path_cb_t path_cb
Describe the path (curve) of animations
int32_t start_value
Start value
int32_t current_value
Current value
int32_t end_value
End value
int32_t time
Animation time in ms
int32_t act_time
Current time in animation.
Set to negative to make delay.
uint32_t playback_delay
Wait before play back
uint32_t playback_time
Duration of playback animation
uint32_t repeat_delay
Wait before repeat
uint16_t repeat_cnt
Repeat count for the animation
uint8_t early_apply
1: Apply start value immediately even is there is delay
uint8_t playback_now
Play back is in progress
uint8_t run_round
Indicates the animation has run in this round
uint8_t start_cb_called
Indicates that the start_cb was already called


戻る : Previous

「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Overview:Animations&oldid=4076」から取得