summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qt3d-index.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/doc/src/qt3d-index.qdoc')
-rw-r--r--src/core/doc/src/qt3d-index.qdoc127
1 files changed, 127 insertions, 0 deletions
diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/core/doc/src/qt3d-index.qdoc
new file mode 100644
index 000000000..8a57a2b10
--- /dev/null
+++ b/src/core/doc/src/qt3d-index.qdoc
@@ -0,0 +1,127 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 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
+
+ \e{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 Getting Started
+
+ For a C++ application that performs 2D or 3D rendering, collision
+ detection, and also handle user input, add the following line to its
+ qmake \c .pro file:
+
+ \badcode
+ QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation
+ \endcode
+
+ To include the definitions of the modules' classes, use the following
+ directives:
+
+ \badcode
+ #include <Qt3DCore>
+ #include <Qt3DRender>
+ #include <Qt3DInput>
+ #include <Qt3DLogic>
+ #include <Qt3DExtras>
+ #include <Qt3DAnimation>
+ \endcode
+
+ A Qt Quick application requires also additional dependencies:
+
+ \badcode
+ QT += 3dcore 3drender 3dinput 3dlogic 3dextras qml quick 3dquick 3danimation
+ \endcode
+
+ \section1 Overview
+
+ The high level design and motivation for Qt 3D is described in the \l {Qt 3D
+ Overview}. The Qt 3D Render aspect 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}
+*/