diff options
Diffstat (limited to 'src/core/doc/src/qt3dlogic-module.qdoc')
-rw-r--r-- | src/core/doc/src/qt3dlogic-module.qdoc | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/src/core/doc/src/qt3dlogic-module.qdoc b/src/core/doc/src/qt3dlogic-module.qdoc new file mode 100644 index 000000000..ccbab3253 --- /dev/null +++ b/src/core/doc/src/qt3dlogic-module.qdoc @@ -0,0 +1,81 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \module Qt3DLogic + \title Qt 3D Logic C++ Classes + \keyword Qt 3D Logic + \since 5.7 + + \brief The Qt 3D Logic module enables synchronizing frames with the Qt 3D + backend. + \ingroup modules + \ingroup qt3d-modules + \qtcmakepackage 3dlogic + \qtvariable 3dlogic + + To use classes from this module, add this directive into the C++ files: + + \code + #include <Qt3DLogic> + \endcode + + To link against the corresponding C++ libraries, add the following to your qmake project file: + + \badcode + QT += 3dLogic + \endcode + +*/ + +/*! + \namespace Qt3DLogic + \inmodule Qt3DLogic + \ingroup qt3d-namespaces + + \brief Contains classes that enable frame synchronization. +*/ + +/*! + \qmlmodule Qt3D.Logic 2.\QtMinorVersion + \title Qt 3D Logic QML Types + \since 5.7 + + \ingroup qmlmodules + \ingroup qt3d-qmlmodules + + \brief Provides QML types to synchronize frames with the 3D backend. + + To import and use the module's QML types, use the following statement: + + \qml \QtMinorVersion + import Qt3D.Logic 2.\1 + \endqml + + \section1 QML Types +*/ + |