Skip to content

Commit 5c569aa

Browse files
jeevantelukulaVeeruPrudhvi
authored andcommitted
feat(slint): Update Slint section in GUI frameworks guide
Reflect upstream meta-slint improvements: new image targets, demo launcher,pre-built images for AM62P/AM62L, slint-viewer remote preview, and updated renderer/backend documentation. Signed-off-by: Telukula Jeevan Kumar Sahu <j-sahu@ti.com>
1 parent 823025c commit 5c569aa

3 files changed

Lines changed: 83 additions & 20 deletions

File tree

.github/styles/config/vocabularies/PSDK/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ OpenVX
1313
PVRCarbon
1414
PVRTune
1515
Sitara
16+
Skia
1617
Slint
1718
TFLite
1819
TVM
@@ -30,6 +31,7 @@ Zink
3031
[Kk]eywriter
3132
[Kk]irkstone
3233
[Mm]ulticast
34+
[Rr]enderers?
3335
[Ss]carthgap
3436
[Tt]oolchain
3537
balenaEtcher

source/images/slint_gallery.png

46.8 KB
Loading

source/linux/Demo_User_Guides/GUI_Frameworks_User_Guide.rst

Lines changed: 81 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -93,29 +93,62 @@ About Slint
9393
for embedded systems and desktop applications. It is designed to be lightweight and efficient,
9494
making it a good choice for resource-constrained embedded systems.
9595

96-
Slint uses a flexible architecture with interchangeable rendering backends. By default,
97-
it uses its own built-in **FemtoVG** renderer, which is a lightweight, hardware-accelerated
98-
engine that leverages OpenGL ES 2.0. This makes it highly efficient and well-suited for
99-
embedded GPUs like the PowerVR series on the |__PART_FAMILY_NAME__|, providing a great
100-
balance of performance and low resource usage out-of-the-box.
96+
Slint uses a flexible architecture with configurable renderers and backends, controlled
97+
by ``PACKAGECONFIG`` in ``meta-slint``. See the `meta-slint features documentation
98+
<https://github.com/slint-ui/meta-slint#features>`__ for the full list of available
99+
renderers and backends and how to configure them.
100+
101+
On |__PART_FAMILY_NAME__|, the image adapts to the board's graphics stack.
102+
Devices with a GPU render through the hardware-accelerated Skia renderer.
103+
GPU-less devices fall back to the Skia software renderer.
101104

102105
Building with Slint
103106
===================
104107

105-
#. Slint version 1.15 example demos are integrated by default in the :file:`tisdk-default-image`. User can download
106-
the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.
108+
When ``meta-slint`` is included in the Yocto layer configuration, two image targets are available:
109+
110+
.. list-table::
111+
:widths: 30 70
112+
:header-rows: 1
113+
114+
* - Image target
115+
- What you get
116+
* - :file:`tisdk-default-image`
117+
- Full TI SDK image with Slint demo binaries in :file:`/usr/bin` and :command:`slint-viewer`. The user manually starts a specific demo.
118+
* - :file:`ti-image-slint-demos`
119+
- Slint-focused image with the same demo binaries and :command:`slint-viewer`, plus :command:`slint-launcher` which starts
120+
automatically on boot and presents a graphical list of demos to launch.
121+
122+
**Download a pre-built image**
123+
124+
- **TI SDK image:** Download :file:`tisdk-default-image` from |__SDK_DOWNLOAD_URL__|.
125+
- **Slint demo image:** Download from the
126+
`meta-slint releases page <https://github.com/slint-ui/meta-slint/releases/tag/demo-images>`__
127+
(based on :file:`ti-image-slint-demos`, includes the demo launcher).
128+
129+
Flash the downloaded image to an SD card as described in :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.
130+
131+
**Build from source**
132+
133+
Follow the steps in :ref:`building-the-sdk-with-yocto`. Use the default oe-config file, which includes
134+
the ``meta-slint`` layer. See :ref:`Yocto Layer Configuration <yocto-layer-configuration>` to find the
135+
correct oe-config file for the release.
136+
137+
.. code-block:: console
138+
139+
# Standard TI SDK image with Slint demos
140+
MACHINE=<machine> bitbake tisdk-default-image
107141
108-
#. Follow the steps in :ref:`building-the-sdk-with-yocto` to build the image from sources.
109-
Use the default oe-config file, which includes the ``meta-slint`` layer.
110-
See :ref:`Yocto Layer Configuration <yocto-layer-configuration>` to find the correct oe-config file for the release.
142+
# Slint-focused image with demo launcher
143+
MACHINE=<machine> bitbake ti-image-slint-demos
111144
112-
#. Once the build is complete, flash the generated image at :file:`build/deploy-ti/images/<machine>/tisdk-default-image-<machine>.wic.xz`
113-
onto a SD card. See :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>` for instructions.
145+
Flash the generated image at :file:`build/deploy-ti/images/<machine>/<image>-<machine>.wic.xz`
146+
onto a SD card. See :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>` for instructions.
114147

115148
Running the Demos
116149
=================
117150

118-
After booting the board with the new image, you will find several Slint demo binaries located in :file:`/usr/bin`, including:
151+
The following Slint demo binaries are available in :file:`/usr/bin` on both image types:
119152

120153
* :file:`energy-monitor`
121154
* :file:`gallery`
@@ -125,8 +158,11 @@ After booting the board with the new image, you will find several Slint demo bin
125158
* :file:`printerdemo`
126159
* :file:`slide_puzzle`
127160

128-
To run a demo, first stop the ti-apps-launcher that runs out-of-box and then execute the desired binary.
129-
For example, to run the "home-automation" demo on a Wayland display:
161+
**With ti-image-slint-demos (or Slint pre-built image):** :command:`slint-launcher` starts automatically on boot.
162+
Select and start any demo from the graphical list.
163+
164+
**With tisdk-default-image:** Run demos manually. Stop the ti-apps-launcher first before starting any demo.
165+
For example, to run the :command:`home-automation` demo on a Wayland display:
130166

131167
.. code-block:: console
132168
@@ -140,7 +176,26 @@ For example, to run the "home-automation" demo on a Wayland display:
140176
:width: 50%
141177
:alt: Slint Home Automation Demo
142178

143-
Here are some snapshots of the other demos running on the device.
179+
Slint Viewer
180+
------------
181+
182+
The images now include :command:`slint-viewer`, a tool for previewing :file:`.slint` UI files directly
183+
on the board. Run it in remote mode to connect from your development machine and push live UI updates
184+
to the board as you edit, without rebuilding:
185+
186+
.. code-block:: console
187+
188+
# View all available options
189+
slint-viewer --help
190+
191+
# Start in remote mode — board waits for editor to connect
192+
slint-viewer --remote
193+
194+
In your editor's Slint live preview, select **Remote** and enter the address shown on the board.
195+
See the `Slint Viewer documentation <https://docs.slint.dev/latest/docs/slint/guide/tooling/slint-viewer/>`__
196+
for full usage.
197+
198+
Here are some snapshots of the other demos running on the device (OpenGL demos require a GPU).
144199

145200
.. list-table::
146201
:widths: 50 50
@@ -170,8 +225,14 @@ Here are some snapshots of the other demos running on the device.
170225

171226
Puzzle demo
172227

173-
.. figure:: /images/slint_energy_monitor.png
174-
:align: left
175-
:alt: Slint Energy Monitor Demo
228+
* - .. figure:: /images/slint_energy_monitor.png
229+
:align: center
230+
:alt: Slint Energy Monitor Demo
231+
232+
Energy Monitor
233+
234+
- .. figure:: /images/slint_gallery.png
235+
:align: center
236+
:alt: Slint Gallery Demo
176237

177-
Energy Monitor
238+
Gallery Demo

0 commit comments

Comments
 (0)