Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
5** Contact: https://www.qt.io/licensing/
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:FDL$
10** Commercial License Usage
11** Licensees holding valid commercial Qt licenses may use this file in
12** accordance with the commercial license agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and The Qt Company. For licensing terms
15** and conditions see https://www.qt.io/terms-conditions. For further
16** information use the contact form at https://www.qt.io/contact-us.
17**
18** GNU Free Documentation License Usage
19** Alternatively, this file may be used under the terms of the GNU Free
20** Documentation License version 1.3 as published by the Free Software
21** Foundation and appearing in the file included in the packaging of
22** this file. Please review the following information to ensure
23** the GNU Free Documentation License version 1.3 requirements
24** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
25** $QT_END_LICENSE$
26**
27****************************************************************************/
28
29/*!
30 \page qt3d-index.html
31 \title Qt 3D
32
33 \e{Qt 3D} provides functionality for near-realtime simulation systems
34 with support for 2D and 3D rendering in both Qt C++ and Qt Quick
35 applications.
36
37 The functionality in Qt 3D is divided into the following C++ modules:
38
39 \annotatedlist qt3d-modules
40
41 The following C++ modules are in still development but are available
42 as technology previews:
43
44 \annotatedlist qt3d-modules-preliminary
45
46 For Qt Quick applications, Qt 3D provides the following QML modules:
47
48 \annotatedlist qt3d-qmlmodules
49
50 The following QML modules are in still development but are available
51 as technology previews:
52
53 \annotatedlist qt3d-qmlmodules-preliminary
54
55 \section1 Getting Started
56
57 For a C++ application that performs 2D or 3D rendering, collision
58 detection, and also handle user input, add the following line to its
59 qmake \c .pro file:
60
61 \badcode
62 QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation
63 \endcode
64
65 To include the definitions of the modules' classes, use the following
66 directives:
67
68 \badcode
69 #include <Qt3DCore>
70 #include <Qt3DRender>
71 #include <Qt3DInput>
72 #include <Qt3DLogic>
73 #include <Qt3DExtras>
74 #include <Qt3DAnimation>
75 \endcode
76
77 A Qt Quick application requires also additional dependencies:
78
79 \badcode
80 QT += 3dcore 3drender 3dinput 3dlogic 3dextras qml quick 3dquick 3danimation
81 \endcode
82
83 \section1 Overview
84
85 The high level design and motivation for Qt 3D is described in the \l {Qt 3D
86 Overview}. The Qt 3D Render aspect offers support for data-driven
87 configuration as described in \l {Qt 3D Render Framegraph}.
88
89 \section1 Reference
90 \list
91 \li \l {Qt 3D Overview}
92 \li \l {Qt 3D C++ Classes}
93 \li \l {Qt 3D QML Types}
94 \li \l {Qt 3D Examples}
95 \endlist
96
97 \section1 Qt 3D Platform Support
98
99 Qt 3D has the following support for platforms:
100
101 \list
102 \li Microsoft Windows (win32) - Supported
103 \li Linux X11 - Supported
104 \li \macos - Supported although there may be some retina scaling issues
105 \li Android - Supported
106 \li Embedded Linux - Supported
107 \li iOS - Supported since (Qt 5.7)
108 \li WinRT - Not supported yet
109 \endlist
110
111 \section1 Licenses and Attributions
112
113 Qt 3D is available under commercial licenses from \l{The Qt Company}.
114 In addition, it is available under the
115 \l{GNU Lesser General Public License, version 3}, or
116 the \l{GNU General Public License, version 2}.
117 See \l{Qt Licensing} for further details.
118
119 Furthermore Qt 3D contains third party
120 modules under following permissive licenses:
121
122 \generatelist{groupsbymodule attributions-qt3d}
123*/
124

Warning: That file was not part of the compilation database. It may have many parsing errors.