qt_add_resources
Synopsis
qt_add_resources(<VAR> file1.qrc [file2.qrc ...] [OPTIONS ...]) qt6_add_resources(<VAR> file1.qrc [file2.qrc ...] [OPTIONS ...])
Since 6.0:
qt_add_resources(<TARGET> <RESOURCE_NAME> [PREFIX <PATH>] [LANG <LANGUAGE>] [BASE <PATH>] [FILES ...] [OPTIONS ...]) qt6_add_resources(<TARGET> <RESOURCE_NAME> [PREFIX <PATH>] [LANG <LANGUAGE>] [BASE <PATH>] [FILES ...] [OPTIONS ...])
Description
To add resources, you can pass either a variable name or a target as the first argument of the command.
When passing a variable name as first argument, qt_add_resources
creates source code from Qt resource files using the Resource Compiler (rcc). Paths to the generated source files are added to <VAR>
.
When passing a target as first argument, the function creates a resource with the name RESOURCE_NAME
, containing the specified FILES
. The resource is automatically linked into TARGET
.
For embedding bigger resources, see qt_add_big_resources.
See The Qt Resource System for a general description of Qt resources.
Arguments of the target-based variant
PREFIX
specifies a path prefix under which all files of this resource are accessible from C++ code. This corresponds to the XML attribute prefix
of the .qrc
file format. If PREFIX
is not given, the target property QT_RESOURCE_PREFIX is used.
LANG
specifies the locale of this resource. This corresponds to the XML attribute lang
of the .qrc
file format.
BASE
is a path prefix that denotes the root point of the file's alias. For example, if BASE
is "assets"
and FILES
is "assets/images/logo.png"
, then the alias of that file is "images/logo.png"
.
Alias settings for files need to be set via the QT_RESOURCE_ALIAS
source file property.
Arguments of both variants
You can set additional OPTIONS
that should be added to the rcc
calls. You can find possible options in the rcc documentation.
Examples
Variable variant, using a .qrc file:
set(SOURCES main.cpp) qt_add_resources(SOURCES example.qrc) add_executable(myapp ${SOURCES})
Target variant, using immediate resources:
add_executable(myapp main.cpp) qt_add_resources(myapp "images" PREFIX "/images" FILES image1.png image2.png)
Caveats
When adding multiple resources, RESOURCE_NAME
must be unique across all resources linked into the final target.
This especially affects static builds. There, the same resource name in different static libraries conflict in the consuming target.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.