diff options
Diffstat (limited to 'examples/qt3d/widgets-scene3d/doc/src/widgets-scene3d.qdoc')
-rw-r--r-- | examples/qt3d/widgets-scene3d/doc/src/widgets-scene3d.qdoc | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/examples/qt3d/widgets-scene3d/doc/src/widgets-scene3d.qdoc b/examples/qt3d/widgets-scene3d/doc/src/widgets-scene3d.qdoc new file mode 100644 index 000000000..267b53ba8 --- /dev/null +++ b/examples/qt3d/widgets-scene3d/doc/src/widgets-scene3d.qdoc @@ -0,0 +1,56 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** 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$ +** +****************************************************************************/ + +/*! + \example widgets-scene3d + \title Qt 3D: Scene3D QML with Widgets Example + \ingroup qt3d-examples-qml + \brief A QWidget-based application with a QML scene containing a 3D scene. + + \image widgets-scene3d.png + + \e {widgets-scene3D} demonstrates visualizing a 3D scene from a + QWidget-based application using QQuickWidget. + + The actual 3D scene is the same as in the \e {scene3d} example. + + This approach is different from the one based on + QWidget::createWindowContainer() demonstrated in \e {basicshapes-cpp} + because it does not create a native window for the Qt 3D content. Rather, + it uses QQuickWidget, a genuine QWidget subclass to compose the Qt Quick + and Qt 3D content together with the traditional widgets. + + \note Be aware of the performance implications. While this approach is very + flexible in the sense that it allows mixing QML and Qt 3D with widgets + without clipping or stacking issues, using Scene3D in a QQuickWidget + involves rendering to offscreen render targets (via framebuffer objects) + twice. This is not always desirable for more complex scenes. For those the + native window based approach shown in \e {basicshapes-cpp} will likely be a + better choice. + + \include examples-run.qdocinc +*/ |