summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3d-index.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-27 12:17:53 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2015-10-28 13:19:51 +0000
commit09ba2f8b9c360ad4d3cf8ebb04fbfc9c1c57cbe7 (patch)
tree07817ea591e07878b82b1708ea4bf5ae1707ed71 /src/doc/src/qt3d-index.qdoc
parentf108a1a68adad19ab99bb9a523c2d7cf6c697b52 (diff)
Doc: Move the doc artifacts outside of the submodule directory
The qdocconf now lives in 'src/doc' because the documentation project defined by it covers the whole Qt 3D module. This change enables qmake to use 'qt3d' as the output directory for doc make targets. The new 'doc' directory also includes the relevant images, snippets, and the qdoc files. Change-Id: Ibc6d0912f8b1e665767e97630b3e5509e10c5710 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/doc/src/qt3d-index.qdoc')
-rw-r--r--src/doc/src/qt3d-index.qdoc111
1 files changed, 111 insertions, 0 deletions
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
new file mode 100644
index 000000000..db8785436
--- /dev/null
+++ b/src/doc/src/qt3d-index.qdoc
@@ -0,0 +1,111 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page qt3d-index.html
+ \title Qt 3D
+
+ \e Qt3D 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 Qt3D is divided into the following C++ modules:
+
+ \annotatedlist qt3d-modules
+
+ Classes, types and functions are declared under the \l [CPP] {Qt3D} namespace.
+
+ For Qt Quick applications, Qt3D provides the following QML modules:
+
+ \annotatedlist qt3d-qmlmodules
+
+ \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
+ \l qmake \c .pro file:
+
+ \badcode
+ QT += 3dcore 3drender 3dinput 3dcollision 3dlogic
+ \endcode
+
+ To include the definitions of the modules' classes, use the following
+ directives:
+
+ \badcode
+ #include <Qt3DCore>
+ #include <Qt3DRender>
+ #include <Qt3DInput>
+ #include <Qt3DCollision>
+ #include <Qt3DLogic>
+ \endcode
+
+ A Qt Quick application requires also additional dependencies:
+
+ \badcode
+ QT += 3dcore 3drenderer 3dinput 3dcollision qml quick 3dquick
+ \endcode
+
+ \section1 Overview
+
+ The high level design and motivation for Qt3D is described in the \l {Qt3D
+ Overview}. The Qt3D Renderer aspect offers support for data-driven
+ configuration as described in \l {Qt3D Renderer Framegraph}.
+
+ \section1 Reference
+ \list
+ \li \l {Qt3D Overview}
+ \li \l {Qt 3D C++ Classes}
+ \li \l {Qt 3D QML Types}
+ \li \l {Qt3D Examples}
+ \endlist
+
+ \section1 Qt3D Platform Support
+
+ In this Technology Preview Qt3D has the following support for platforms:
+
+ \list
+ \li Microsoft Windows (win32) - Supported
+ \li Linux X11 - Supported
+ \li OS X - Supported although there may be some retina scaling issues
+ \li Android - Supported
+ \li Embedded Linux - Supported
+ \li iOS - Not supported yet (coming in Qt 5.6)
+ \li WinRT - Not supported yet
+ \li Windows CE - Compiles but not tested
+ \endlist
+*/