Qt 3D provides functionality for near-realtime simulation systems with support for 2D and 3D rendering in both Qt C++ and Qt Quick applications.
The functionality in Qt 3D is divided into the following C++ modules:
The Qt 3D module contains functionality to support near-realtime simulation systems.
The Qt 3D Input module provides classes for handling user input in applications using Qt3D.
The Qt 3D Logic module enables synchronizing frames with the Qt 3D backend.
The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt 3D.
The following C++ modules are in still development but are available as technology previews:
The Qt 3D Animation modules provides a set of prebuilt elements to help you get started with Qt 3D.
The Qt 3D Extras module provides a set of prebuilt elements to help you get started with Qt 3D.
The Qt 3D Scene2D module provides a way to render Quick2 qml content to a Qt 3D texture.
For Qt Quick applications, Qt 3D provides the following QML modules:
Provides core Qt 3D QML types.
Provides QML types for Qt 3D user input.
Provides QML types to synchronize frames with the 3D backend.
Provides Qt 3D QML types for rendering.
The following QML modules are in still development but are available as technology previews:
Provides Qt 3D QML types for the extras module.
Provides Qt 3D QML types for the animation module.
Provides Qt 3D QML types for the scene2d module.
Provides Qt 3D QML types for the Scene3D module.
Using the Module
For a C++ application that performs 2D or 3D rendering, collision detection, and handles user input, include the following directives of the modules' classes:
#include <Qt3DCore> #include <Qt3DRender> #include <Qt3DInput> #include <Qt3DLogic> #include <Qt3DExtras> #include <Qt3DAnimation>
To import the QML types into your application, use the following import statement in your .qml file:
import Qt3D.Core import Qt3D.Render import Qt3D.Input import Qt3D.Logic import Qt3D.Extras import Qt3D.Animation import QtQuick.Scene2D import QtQuick.Scene3D
Using a Qt module's C++ API requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.
Building with CMake
find_package() command to locate the needed module components in the
find_package(Qt6 REQUIRED COMPONENTS 3DCore 3DRender 3DInput 3DLogic 3DExtras 3DAnimation ) target_link_libraries(mytarget PRIVATE Qt6::3DCore Qt6::3DRender Qt6::3DLogic Qt6::3DExtras Qt6::3DAnimation )
Building with qmake
To configure the module for building with qmake, add the modules to the
QT variable in the project's .pro file:
QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation
A Qt Quick application requires additional dependencies:
QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation qml quick 3dquick
The high level design and motivation for Qt 3D is described in the Qt 3D Overview. The Qt 3D Render offers support for data-driven configuration as described in Qt 3D Render Framegraph.
Qt 3D Platform Support
Qt 3D has the following support for platforms:
- Microsoft Windows (win32) - Supported
- Linux X11 - Supported
- macOS - Supported although there may be some retina scaling issues
- Android - Supported
- Embedded Linux - Supported
- iOS - Supported since (Qt 5.7)
- WinRT - Not supported yet
Changes to Qt3D lists important changes in the module API and functionality that were done for the Qt 6 series of Qt.
Licenses and Attributions
Qt 3D is available under commercial licenses from The Qt Company. In addition, it is available under the GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.
Furthermore Qt 3D contains third party modules under following permissive licenses:
MIT License or Public Domain
© 2023 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.