- Qt 6.5
- Deploying QML Applications
- Qt 6.5.1 Reference Documentation

# Deploying QML Applications

QML documents are loaded and run by the QML runtime. This includes the Declarative UI engine along with the built-in QML types and plugin modules. The QML runtime also provides access to third-party QML types and modules.

Applications that use QML must invoke the QML runtime to run QML documents. You can do this by creating a QQuickView or a QQmlEngine, as described below. In addition, the Declarative UI package includes the `qml` tool, which loads `.qml` files. This tool is useful for developing and testing QML code without having to write a C++ application to load the QML runtime.

## Deploying Applications with Qt Creator

Qt Creator deploys and packages QML applications to various platforms. For mobile devices, Qt Creator can directly bundle applications to the respective platform package formats, such as APK.

When you run your applications on the target platform, your application needs to access the location of the QML libraries. If you use qmake, the `QT_INSTALL_QML` environment variable points to the location of the libraries. The Qt Installers install the QML libraries in: `<version>``/`<compiler>`/qml` directory.

## QML Caching

The QML runtime loads QML documents by parsing them and generating byte code. Most of the time, the document hasn't changed since the last time it was loaded. To speed up this loading process, the QML runtime maintains a cache file for each QML document. This cache file contains the compiled byte code and a binary representation of the QML document structure. In addition, when multiple applications use the same QML document, the memory needed for the code is shared between application processes. The cache files are loaded via the `mmap()` system call on POSIX-compliant operating systems or `CreateFileMapping()` on Windows, resulting in significant memory savings.

Each time you load a changed QML document, the cache is automatically re-created. Cache files are located in a sub-directory of QStandardPaths::CacheLocation with the name "qmlcache". The file extension is `.qmlc` for QML documents and `.jsc` for imported JavaScript modules.

## Ahead-of-Time Compilation

The automatic caching of compiled QML documents into cache files results in significantly faster application load time. However, the initial creation of cache files can still take time, especially when the application starts for the very first time. To avoid that initial step and provide faster startup times from the very beginning, Qt's build system allows you to perform the compilation step for QML files ahead of time, when compiling the C++ parts of your application.

One benefit of compiling ahead of time is that, in the event of syntax errors in your QML documents, you are notified at application compile-time instead of at run-time, when the file is loaded.

This will happen automatically if you use the CMake QML Module API, for qmake see the section below.

### qmake

When using qmake, in order to deploy your application with QML files compiled ahead of time, you must organize the files and the build system in a specific way:

- All QML documents (including JavaScript files) must be included as resources via Qt's Resource system.
- Your application must load the QML documents via the `qrc:///` URL scheme.
- You can enable Ahead-of-Time compilation using the `CONFIG+=qtquickcompiler` directive.

## Prototyping with QML Scene

The Declarative UI package includes a QML Runtime Tool, qml, which loads and displays QML documents. This is useful during the application development phase for prototyping QML-based applications without writing your own C++ applications to invoke the QML runtime.

## Initializing the QML Runtime in Applications

To run an application that uses QML, your application must invoke the QML runtime. This is done by writing a Qt C++ application that loads the QQmlEngine by either:

- Loading the QML file through a QQuickView instance.
- Creating a QQmlEngine instance and loading QML files with QQmlComponent.

### Initializing with QQuickView

QQuickView is a QWindow-based class that can load QML files. For example, if there is a QML file, `application.qml`, it will look like this:

     import QtQuick

     Rectangle { width: 100; height: 100; color: "red" }

It can be loaded in a Qt application's `main.cpp` file like this:

     #include <QGuiApplication>
     #include <QQuickView>

     int main(int argc, char *argv[])
     {
         QGuiApplication app(argc, argv);

         QQuickView view;
         view.setSource(QUrl::fromLocalFile("application.qml"));
         view.show();

         return app.exec();
     }

This creates a QWindow-based view that displays the contents of `application.qml`.

The application's `.pro` project file must specify the `declarative` module for the `QT` variable. For example:

     TEMPLATE += app
     QT += quick
     SOURCES += main.cpp

### Creating a QQmlEngine Directly

If `application.qml` doesn't have any graphical components, or if it's preferred to avoid QQuickView for other reasons, the QQmlEngine can be constructed directly instead. In this case, `application.qml` is loaded as a QQmlComponent instance rather than placed into a view:

     #include <QGuiApplication>
     #include <QQmlEngine>
     #include <QQmlContext>
     #include <QQmlComponent>

     int main(int argc, char *argv[])
     {
         QGuiApplication app(argc, argv);

         QQmlEngine engine;
         QQmlContext *objectContext = new QQmlContext(engine.rootContext());

         QQmlComponent component(&engine, "application.qml");
         QObject *object = component.create(objectContext);

         // ... delete object and objectContext when necessary

         return app.exec();
     }

If you're not using any graphical items from Qt Quick, you can replace QGuiApplication with a QCoreApplication in the code above. This way, you can use QML as a language without any dependencies to the Qt GUI module.

## Using the Qt Resource System with QML

The Qt resource system allows resource files to be stored as binary files in an application executable. The Qt Resource System is used for QML application as it enables QML files and other resources – such as images and sound files – to be referred to through the resource system URI scheme rather than relative or absolute paths to filesystem resources.

Note: Usage of the resource system means that the application executable usually must be re-compiled whenever a QML source file is changed, to update the resources in the package.

The CMake QML Module API automatically places your QML files in the resource system. To access them, load your main QML file as a resource or as a URL with the `qrc` scheme. The path in the resource system where your QML files are placed can be found by concatenating:

- the `RESOURCE_PREFIX` you have passed to qt_add_qml_module.
- `/qt/qml`, if you have not passed `RESOURCE_PREFIX` to qt_add_qml_module and QTP0001 policy is set to `NEW`.
- `/`, if you have not passed `RESOURCE_PREFIX` to qt_add_qml_module and QTP0001 policy is `not` set to `NEW`.
- If you have not passed `NO_RESOURCE_TARGET_PATH` to qt_add_qml_module: the `URI` you have passed to qt_add_qml_module with dots replaced by slashes.

For example, a module called `My.Own.Module` is placed at:

- `:/qt/qml/My/Own/Module/` if you have specified `/qt/qml` as `RESOURCE_PREFIX`, or you have not passed `RESOURCE_PREFIX` and QTP0001 policy is set to `NEW`.
- `:/My/Own/Module/` if you have specified `/` as `RESOURCE_PREFIX`, or you have not passed `RESOURCE_PREFIX` and QTP0001 policy is not set to `NEW`. }
- `:/Some/Prefix/My/Own/Module/` if you have specified `Some/Prefix/` as `RESOURCE_PREFIX`
- `:/` if you have specified `NO_RESOURCE_TARGET_PATH`

Once this is done, all files specified by relative paths in QML are loaded from the resource system. Use of the resource system is completely transparent to the QML layer; this means all QML code should refer to resource files using relative paths and should not use the `qrc` scheme. This scheme should only be used from C++ code to refer to resource files.

Note: When using qmake, you need to manually place your files in the resource system. See the qmake Manual and the general documentation on the resouce system for how to do this. It's advisable to still follow the path naming convention outlined above.

## Related Information

- Deploying Qt Applications
- Running on Multiple Platforms
- Deploying to Devices
- qtqml-cppintegration-exposecppattributes.html{Exposing Attributes of C++ Types to QML}
- The Qt Resource System