diff options
author | Laszlo Agocs <laszlo.agocs@qt.io> | 2018-05-14 17:17:37 +0200 |
---|---|---|
committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2018-05-15 07:51:22 +0000 |
commit | a68c2d9f0853c8939b54d08528fc09bfea88160e (patch) | |
tree | 03106da7b63006de4011f489ef4ef7920c8a1b15 /examples | |
parent | 8fa825cb97fb90c1135210a68e23de29f14d6aa4 (diff) |
simplewindow: add doc landing page
Change-Id: I4ffdd4bd41466611276028ba47ade306f816e51b
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/3dstudioruntime2/simplewindow/doc/images/simplewindow.png | bin | 0 -> 246472 bytes | |||
-rw-r--r-- | examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc | 51 |
2 files changed, 51 insertions, 0 deletions
diff --git a/examples/3dstudioruntime2/simplewindow/doc/images/simplewindow.png b/examples/3dstudioruntime2/simplewindow/doc/images/simplewindow.png Binary files differnew file mode 100644 index 0000000..37550c7 --- /dev/null +++ b/examples/3dstudioruntime2/simplewindow/doc/images/simplewindow.png diff --git a/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc b/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc new file mode 100644 index 0000000..b00bc3e --- /dev/null +++ b/examples/3dstudioruntime2/simplewindow/doc/src/simplewindow.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt 3D Studio. +** +** $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 simplewindow + \title Qt 3D Studio Runtime: Simple Window Example + \ingroup qt3dstudioruntime2-examples-cpp + \brief Demonstrates using the Q3DSSurfaceViewer class in order to render in a QWindow + + \image simplewindow.png + + \e {This example demonstrates basic usage of the Q3DSSurfaceViewer class} + + \include examples-run.qdocinc + + \section1 Description + + This example consists of an OpenGL-based QWindow. The contents is + provided by a Q3DSSurfaceViewer instance by loading up a simple Qt + 3D Studio presentation. + + When targeting a QWindow, the application can choose whether it + wants to be in control of updates (i.e. manually requesting the + next frame by calling Q3DSSurfaceViewer::update()). By passing + the \c{--multi} command-line argument the example demonstrates + both types of usages. +*/ |