language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-08-04 02:39:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve the Slint esp-idf component README (#3278)

Browse source 
Provide a brief introduction into what the component provides and how to use it. This is very brief, but
hopefully a good starting point.

We should link to C++ platform docs once we have them, for example.

When the component includes an example, its README will be automatically rendered below this one.

Also make the esp_lcd_touch component a public dependency,
since it's included from `esp_slint.h`.
This commit is contained in:
Simon Hausmann 2023-08-16 08:52:45 +02:00 • committed by GitHub
parent 21e06cd636
commit 12e064b07d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

67
api/cpp/esp-idf/slint/README.md
View file

@ -1,7 +1,68 @@
# Slint
A Declarative GUI toolkit
[![Component Registry](https://components.espressif.com/components/slint/slint/badge.svg)](https://components.espressif.com/components/slint/slint)
![Screenshot](https://slint.dev/resources/energy-monitor-screenshot.png)
Slint is a declarative GUI toolkit to build native user interfaces for desktop and embedded applications written in Rust, C++, or JavaScript.
[Website](https://slint.dev) · [GitHub](https://github.com/slint-ui/slint) · [Docs](https://slint.dev/docs/cpp)
This component provides the C++ version of [Slint](https://slint.dev/) for the [Espressif IoT Development Framework](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html).
It has been tested on ESP32-S3 devices.
![Screenshot](https://user-images.githubusercontent.com/959326/260754861-e2130cce-9d2b-4925-9536-88293818ac3e.jpeg)
## Usage
By using this component, the `Slint::Slint` CMake target is linked to your application and you can access the entire functionality of the
[Slint C++ API](https://slint.dev/docs/cpp).
In addition, this component provides the `slint_esp.h` header file, which provides a `EspPlatform` class, based on
[ESP LCD Touch](https://components.espressif.com/components/espressif/esp_lcd_touch). It implements the `slint::platform::Platform` interface by
reading touch events and rendering to an attached screen via `esp_lcd_panel_draw_bitmap`.
Use this platform implementation by instantiating it with a `esp_lcd_panel_handle_t`, an optional `esp_lcd_touch_handle_t`, and a pointer to one
or two `slint::platform::Rgb565Pixel` frame buffers. Next, register the instance with the Slint run-time library by calling `slint::platform::set_platform()`:
```cpp
static std::vector<slint::platform::Rgb565Pixel> single_buffer(BSP_LCD_H_RES * BSP_LCD_V_RES);
slint::platform::set_platform(
std::make_unique<EspPlatform>(slint::PhysicalSize({ BSP_LCD_H_RES, BSP_LCD_V_RES }),
panel_handle, touch_handle, single_buffer));
```
Alternatively, you can implement your own sub-class of `slint::platform::Platform` to drive the screen and handle input events.
Next, integrate your `.slint` files into the build by compiling them to C++ and linking them to your component:
```cmake
slint_target_sources(${COMPONENT_LIB} my_application_ui.slint)
```
Instantiate the Slint component by including the generated header file (`my_application_ui.h` in the above example), call `create()`
on the generated class and `run()` to spin the event loop:
```cpp
#include "my_application_ui.h"
/// ...
auto my_application_ui = MainWindow::create();
my_application_ui->run();
```
## License
You can use Slint under ***any*** of the following licenses, at your choice:
1. [GNU GPLv3](https://github.com/slint-ui/slint/blob/master/LICENSES/GPL-3.0-only.txt),
2. [Paid license](https://slint.dev/pricing.html).
See also the [Licensing FAQ](https://github.com/slint-ui/slint/blob/master/FAQ.md#licensing).
Slint is also available with a third license (Royalty Free) for desktop applications.
## Links
[Website](https://slint.dev) · [GitHub](https://github.com/slint-ui/slint) · [Docs](https://slint.dev/docs/cpp)

6
api/cpp/esp-idf/slint/idf_component.yml
View file

@ -4,10 +4,12 @@
description: "Slint — declarative GUI toolkit"
url: "https://slint.dev"
license: "GPL-3.0-only OR LicenseRef-Slint-Royalty-free-1.1 OR LicenseRef-Slint-commercial"
version: "1.2.0-alpha2"
version: "1.2.0-alpha3"
discussion: "https://github.com/slint-ui/slint/discussions"
documentation: "https://slint.dev/docs"
repository: "https://github.com/slint-ui/slint"
dependencies:
idf: ">=5.1"
esp_lcd_touch: ">=1.0.4"
esp_lcd_touch:
version: ">=1.0.4"
public: true