summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qt3d-module-use.qdocinc
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/doc/src/qt3d-module-use.qdocinc')
-rw-r--r--src/core/doc/src/qt3d-module-use.qdocinc62
1 files changed, 62 insertions, 0 deletions
diff --git a/src/core/doc/src/qt3d-module-use.qdocinc b/src/core/doc/src/qt3d-module-use.qdocinc
new file mode 100644
index 000000000..13506d40d
--- /dev/null
+++ b/src/core/doc/src/qt3d-module-use.qdocinc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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$
+**
+****************************************************************************/
+
+//! [cmakebuild]
+ Use the \c {find_package()} command to locate the needed module components
+ in the \c {Qt6} package:
+ \code
+ find_package(Qt6 REQUIRED COMPONENTS
+ 3DCore
+ 3DRender
+ 3DInput
+ 3DLogic
+ 3DExtras
+ 3DAnimation
+ )
+ target_link_libraries(mytarget PRIVATE
+ Qt6::3DCore
+ Qt6::3DRender
+ Qt6::3DLogic
+ Qt6::3DExtras
+ Qt6::3DAnimation
+ )
+ \endcode
+//! [cmakebuild]
+
+//! [qmakebuild]
+ To configure the module for building with qmake, add the modules to the \c
+ QT variable in the project's .pro file:
+ \code
+ QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation
+ \endcode
+
+ A Qt Quick application requires additional dependencies:
+
+ \code
+ QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation qml quick 3dquick
+ \endcode
+//! [qmakebuild]