mirror of
https://github.com/slint-ui/slint.git
synced 2025-09-30 05:44:52 +00:00
5bae6e01a5
The Image's source property used to be a string. Now it is a Resource enum, which can either be None or an absolute file path to the image on disk. This also replaces the internal Image type. The compiler internally resolves the img bang expression to a resource reference, which shall remain just an absolute path. For now the target generator passes that through, but in the future the target generator may choose a target specific way of embedding the data and thus generating a different Resource type in the final code (through compile_expression in the cpp and rust generator). The C++ binding is a bit messy as cbindgen doesn't really support exporting enums that can be constructed on the C++ side. So instead we use cbindgen to merely export the type internally and only use the tag from it then. The public API is then a custom Resource type that is meant to be binary compatible.
96 lines
2 KiB
Rust
96 lines
2 KiB
Rust
/*!
|
|
# SixtyFPS
|
|
|
|
This create is the main entry point for project using SixtyFPS UI in rust.
|
|
|
|
## How to use:
|
|
|
|
There are two ways to use this crate.
|
|
|
|
- The `.60` code inline in a macro.
|
|
- The `.60` code in external files compiled with `build.rs`
|
|
|
|
### The .60 code in a macro
|
|
|
|
This is the simpler way, just put the
|
|
|
|
```rust
|
|
sixtyfps::sixtyfps!{
|
|
HelloWorld := Text { text: "hello world"; }
|
|
}
|
|
fn main() {
|
|
# return; // Don't run a window in an example
|
|
HelloWorld::default().run()
|
|
}
|
|
```
|
|
|
|
### The .60 file in external files compiled with `build.rs`
|
|
|
|
In your Cargo.toml:
|
|
|
|
FIXME! set the version
|
|
|
|
```toml
|
|
[package]
|
|
...
|
|
build = "build.rs"
|
|
|
|
[dependencies]
|
|
sixtyfps = "*"
|
|
...
|
|
|
|
[build-dependencies]
|
|
sixtyfps-build = "*"
|
|
```
|
|
|
|
In the `build.rs` file:
|
|
|
|
```ignore
|
|
fn main() {
|
|
sixtyfps_build::compile("ui/hello.60");
|
|
}
|
|
```
|
|
|
|
Then in your main file
|
|
|
|
```ignore
|
|
sixtyfps::include_modules!();
|
|
fn main() {
|
|
HelloWorld::default().run()
|
|
}
|
|
```
|
|
*/
|
|
|
|
#![warn(missing_docs)]
|
|
|
|
pub use sixtyfps_rs_macro::sixtyfps;
|
|
|
|
/// internal re_exports used by the macro generated
|
|
#[doc(hidden)]
|
|
pub mod re_exports {
|
|
pub use const_field_offset::{self, FieldOffsets};
|
|
pub use once_cell::sync::Lazy;
|
|
pub use sixtyfps_corelib::abi::datastructures::{
|
|
Component, ComponentTO, ComponentVTable, ItemTreeNode,
|
|
};
|
|
pub use sixtyfps_corelib::abi::primitives::*;
|
|
pub use sixtyfps_corelib::abi::properties::Property;
|
|
pub use sixtyfps_corelib::abi::signals::Signal;
|
|
pub use sixtyfps_corelib::ComponentVTable_static;
|
|
pub use sixtyfps_corelib::EvaluationContext;
|
|
pub use sixtyfps_corelib::Resource;
|
|
pub use sixtyfps_corelib::SharedString;
|
|
pub use sixtyfps_rendering_backend_gl::sixtyfps_runtime_run_component_with_gl_renderer;
|
|
pub use vtable::{self, *};
|
|
}
|
|
|
|
#[cfg(doctest)]
|
|
mod compile_fail_tests;
|
|
|
|
/// Include the code generated with the sixtyfps-build crate from the build script
|
|
#[macro_export]
|
|
macro_rules! include_modules {
|
|
() => {
|
|
include!(env!("SIXTYFPS_INCLUDE_GENERATED"));
|
|
};
|
|
}
|