1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** 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$
**
****************************************************************************/
/*!
\page qt3d-index.html
\title Qt 3D
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:
\annotatedlist qt3d-modules
The following C++ modules are in still development but are available
as technology previews:
\annotatedlist qt3d-modules-preliminary
For Qt Quick applications, Qt 3D provides the following QML modules:
\annotatedlist qt3d-qmlmodules
The following QML modules are in still development but are available
as technology previews:
\annotatedlist qt3d-qmlmodules-preliminary
\section1 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:
\code
#include <Qt3DCore>
#include <Qt3DRender>
#include <Qt3DInput>
#include <Qt3DLogic>
#include <Qt3DExtras>
#include <Qt3DAnimation>
\endcode
To import the QML types into your application, use the following import
statement in your .qml file:
\qml
import Qt3D.Core
import Qt3D.Render
import Qt3D.Input
import Qt3D.Logic
import Qt3D.Extras
import Qt3D.Animation
import QtQuick.Scene2D
import QtQuick.Scene3D
\endqml
\include {module-use.qdocinc} {using the c++ api}
\section2 Building with CMake
\include qt3d-module-use.qdocinc cmakebuild
\section2 Building with qmake
\include qt3d-module-use.qdocinc qmakebuild
\section1 Overview
The high level design and motivation for Qt 3D is described in the \l {Qt 3D
Overview}. The Qt 3D Render offers support for data-driven configuration as
described in \l {Qt 3D Render Framegraph}.
\section1 Reference
\list
\li \l {Qt 3D Overview}
\li \l {Qt 3D C++ Classes}
\li \l {Qt 3D QML Types}
\li \l {Qt 3D Examples}
\endlist
\section1 Qt 3D Platform Support
Qt 3D has the following support for platforms:
\list
\li Microsoft Windows (win32) - Supported
\li Linux X11 - Supported
\li \macos - Supported although there may be some retina scaling issues
\li Android - Supported
\li Embedded Linux - Supported
\li iOS - Supported since (Qt 5.7)
\li WinRT - Not supported yet
\endlist
\section1 Module Evolution
\l{Changes to Qt3D} lists important changes in the module API
and functionality that were done for the Qt 6 series of Qt.
\section1 Licenses and Attributions
Qt 3D is available under commercial licenses from \l{The Qt Company}.
In addition, it is available under the
\l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
Furthermore Qt 3D contains third party
modules under following permissive licenses:
\generatelist{groupsbymodule attributions-qt3d}
*/
|
