Doc: Add recommendation for optimizing large asset files

Building apps with large asset files added to .qrc files
requires huge amounts of memory, so they should be avoided
or included as external binary resources.

Fixes: QDS-4943
Change-Id: I8e4b3630b0543a33547c3477145adf3b2f47b758
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2021-08-26 11:44:57 +02:00
parent b02b2b3da8
commit 8db873a8c3

View File

@@ -55,8 +55,10 @@
from the Qt UI Quick project to the application project. from the Qt UI Quick project to the application project.
You can use the \c RESOURCES option in the project configuration file to You can use the \c RESOURCES option in the project configuration file to
automatically add all the QML files and related assets to a Qt resource automatically add all the QML files and related assets to a
file. \l{The Qt Resource System}{Qt resource collection file (.qrc)}. However,
large files should be included as external binary resources instead of
compiling them into the binary.
The wizard automatically adds the \c QML_IMPORT_PATH option to the project The wizard automatically adds the \c QML_IMPORT_PATH option to the project
file for specifying the required file for specifying the required
@@ -132,6 +134,21 @@
\quotefile progressbar/main.cpp \quotefile progressbar/main.cpp
\section1 Handling Large Data Files
Graphical assets used in the UI, such as images, effects, or 3D scenes
are a typical cause for performance problems in UIs. Even building the
application requires huge amounts of memory if you try to include large
asset files, such as 100-MB 3D models or 64-MB textures, into the \c .qrc
file for compiling them into the binary.
First try to optimize your assets, as described in \l{Optimizing Designs}
and \l {Creating Optimized 3D Scenes}.
If you really need large assets, they should either be loaded directly from
the file system or use the Qt resource system in the dynamic way. For more
information, see \l{The Qt Resource System} in the Qt documentation.
\section1 Adding Custom Fonts \section1 Adding Custom Fonts
To \l{Using Custom Fonts}{use custom fonts} from the Qt Quick UI project, To \l{Using Custom Fonts}{use custom fonts} from the Qt Quick UI project,