summaryrefslogtreecommitdiff
path: root/lib/lvgl/docs/widgets/extra/animimg.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/lvgl/docs/widgets/extra/animimg.md')
m---------lib/lvgl0
-rw-r--r--lib/lvgl/docs/widgets/extra/animimg.md49
2 files changed, 49 insertions, 0 deletions
diff --git a/lib/lvgl b/lib/lvgl
deleted file mode 160000
-Subproject 0732400e7b564dd0e7dc4a924619d8e19c5b23a
diff --git a/lib/lvgl/docs/widgets/extra/animimg.md b/lib/lvgl/docs/widgets/extra/animimg.md
new file mode 100644
index 00000000..4727033c
--- /dev/null
+++ b/lib/lvgl/docs/widgets/extra/animimg.md
@@ -0,0 +1,49 @@
+# Animation Image (lv_animimg)
+
+## Overview
+
+The animation image is similar to the normal 'Image' object. The only difference is that instead of one source image, you set an array of multiple source images.
+
+You can specify a duration and repeat count.
+
+
+## Parts and Styles
+- `LV_PART_MAIN` A background rectangle that uses the typical background style properties and the image itself using the image style properties.
+
+
+## Usage
+
+### Image sources
+To set the image in a state, use the `lv_animimg_set_src(imgbtn, dsc[], num)`.
+
+
+## Events
+No special events are sent by image objects.
+
+See the events of the Base object too.
+
+Learn more about [Events](/overview/event).
+
+
+## Keys
+No Keys are processed by the object type.
+
+Learn more about [Keys](/overview/indev).
+
+
+## Example
+
+```eval_rst
+
+.. include:: ../../../examples/widgets/animimg/index.rst
+
+```
+
+## API
+
+```eval_rst
+
+.. doxygenfile:: lv_animimg.h
+ :project: lvgl
+
+```