diff options
Diffstat (limited to 'src/corelib/doc/src/cmake/qt_add_resources.qdoc')
| -rw-r--r-- | src/corelib/doc/src/cmake/qt_add_resources.qdoc | 57 |
1 files changed, 26 insertions, 31 deletions
diff --git a/src/corelib/doc/src/cmake/qt_add_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_resources.qdoc index c3709a9bf3..2e713b1b8e 100644 --- a/src/corelib/doc/src/cmake/qt_add_resources.qdoc +++ b/src/corelib/doc/src/cmake/qt_add_resources.qdoc @@ -1,36 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_resources.html +\page qt-add-resources.html \ingroup cmake-commands-qtcore \title qt_add_resources -\target qt6_add_resources +\keyword qt6_add_resources \summary {Compiles binary resources into source code.} @@ -52,6 +28,8 @@ qt_add_resources(<TARGET> <RESOURCE_NAME> [PREFIX <PATH>] [LANG <LANGUAGE>] [BASE <PATH>] + [BIG_RESOURCES] + [OUTPUT_TARGETS <VARIABLE_NAME>] [FILES ...] [OPTIONS ...]) \endcode @@ -70,8 +48,6 @@ When passing a target as first argument, the function creates a resource with the name \c{RESOURCE_NAME}, containing the specified \c{FILES}. The resource is automatically linked into \c{TARGET}. -For embedding bigger resources, see \l qt_add_big_resources. - See \l{The Qt Resource System} for a general description of Qt resources. \section1 Arguments of the target-based variant @@ -79,7 +55,9 @@ See \l{The Qt Resource System} for a general description of Qt resources. \c PREFIX specifies a path prefix under which all files of this resource are accessible from C++ code. This corresponds to the XML attribute \c prefix of the \c .qrc file format. If \c PREFIX is not given, the target property -\l{cmake-target-property-QT_RESOURCE_PREFIX}{QT_RESOURCE_PREFIX} is used. +\l{cmake-target-property-QT_RESOURCE_PREFIX}{QT_RESOURCE_PREFIX} is used. Since +6.5, \c{PREFIX} is optional. If it is omitted and not specified by +\c{QT_RESOURCE_PREFIX}, \c{"/"} will be used as the default path prefix. \c LANG specifies the locale of this resource. This corresponds to the XML attribute \c lang of the \c .qrc file format. @@ -92,6 +70,21 @@ example, if \c BASE is \c{"assets"} and \c FILES is Alias settings for files need to be set via the \c QT_RESOURCE_ALIAS source file property. +\c BIG_RESOURCES can be specified to enable support for big resources. This +directly generates object files (\c .o, \c .obj) instead of C++ source code. +This allows embedding bigger resources, without having to compile generated C++ +sources, which can be too time consuming and memory intensive. + +Note that \c BIG_RESOURCES is not compatible with iOS due to restrictions of +CMake's Xcode project generator. See +\l{https://bugreports.qt.io/browse/QTBUG-103497}{QTBUG-103497} for details. +Also, \c BIG_RESOURCES only works reliably from CMake 3.17 onwards. + +When using this command with static libraries, one or more special targets will +be generated. Should you wish to perform additional processing on these targets, +pass a variable name to the \c OUTPUT_TARGETS parameter. The \c qt_add_resources +function stores the names of the special targets in the specified variable. + \section1 Arguments of both variants You can set additional \c{OPTIONS} that should be added to the \c{rcc} calls. @@ -112,4 +105,6 @@ 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. + +\sa {qt6_add_big_resources}{qt_add_big_resources()} */ |