language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-09-27 20:42:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update api/cpp/docs/cmake.md

Browse source 
Co-authored-by: Simon Hausmann <hausmann@gmail.com>
This commit is contained in:
Tobias Hunger 2023-03-10 20:39:17 +01:00
parent c5ecade881
commit e5c44ad5a1
1 changed files with 7 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
api/cpp/docs/cmake.md
View file

@ -67,19 +67,15 @@ CMake project, install it into a prefix directory of your choice and use `find_p
### Resource Embedding ### Resource Embedding
You may change the default resource embedding the Slint compiler will use via By default, images or fonts that your Slint files reference are loaded from disk at run-time. This minimises build times, but requires that the directory structure with the files remains stable. If you want to build a program that runs anywhere, then you can configure the Slint compiler to embed such sources into the binary.
the `SLINT_EMBED_RESOURCES` target property, which accepts `as-absolute-path`,
`embed-files` and `embed-for-software-renderer`. The latter optimizes for the
Slint software-renderer and falls back to `embed-files` if that isn't used.
Typically you will want to effect resource embedding for all targets in a Set the `SLINT_EMBED_RESOURCES` target property on your CMake target to one of the following values:
CMake project. This is done with the `DEFAULT_SLINT_EMBED_RESOURCES` option,
which initializes the `SLINT_EMBED_RESOURCES` target property.
Typically you will want to set `DEFAULT_SLINT_EMBED_RESOURCES` to * `embed-files`: The raw files are embedded in the application binary.
`as-absolute-path` for debug builds as this reduces build times. When doing a * `embed-for-software-renderer`: The files will be loaded by the Slint compiler, optimized for use with the software renderer and embedded in the application binary.
release, you will want to switch to `embed-files` to create self-contained * `as-absolute-path`: The paths of files are made absolute and will be used at run-time to load the resources from the file system. This is the default.
binary that will work on all systems.
This target property is initialised from the global `DEFAULT_SLINT_EMBED_RESOURCES` cache variable. Set it to configure the default for all CMake targets.
### Features ### Features