1/**************************************************************************** 2** 3** Copyright (C) 2019 The Qt Company Ltd. 4** Contact: https://www.qt.io/licensing/ 5** 6** This file is part of the documentation of the Qt Toolkit. 7** 8** $QT_BEGIN_LICENSE:FDL$ 9** Commercial License Usage 10** Licensees holding valid commercial Qt licenses may use this file in 11** accordance with the commercial license agreement provided with the 12** Software or, alternatively, in accordance with the terms contained in 13** a written agreement between you and The Qt Company. For licensing terms 14** and conditions see https://www.qt.io/terms-conditions. For further 15** information use the contact form at https://www.qt.io/contact-us. 16** 17** GNU Free Documentation License Usage 18** Alternatively, this file may be used under the terms of the GNU Free 19** Documentation License version 1.3 as published by the Free Software 20** Foundation and appearing in the file included in the packaging of 21** this file. Please review the following information to ensure 22** the GNU Free Documentation License version 1.3 requirements 23** will be met: https://www.gnu.org/licenses/fdl-1.3.html. 24** $QT_END_LICENSE$ 25** 26****************************************************************************/ 27 28/*! 29\page qtquick3d-index.html 30\title Qt Quick 3D 31\brief Provides API that lets you define 3D items using QML. 32 33Qt Quick 3D provides a high-level API for creating 3D content and 3D user interfaces 34based on \l{Qt Quick}. Rather than using an external engine which creates syncing issues, 35and additional layers of abstraction, we provide extensions to the existing 36\l{Qt Quick Scene Graph} for spatial content, and a renderer for that extended 37scene graph. When using the spatial scene graph it is also be possible to mix 38Qt Quick 2D content with 3D content. 39 40\image dragon.jpg 41 42\section1 Prerequisites 43 44The \l{Qt Quick 3D QML Types}{QML Types} can be imported into your 45application using the following import statement in your \c {.qml} file: 46 47\code \QtMinorVersion 48import QtQuick3D 1.\1 49\endcode 50 51In addition to the base Qt Quick 3D Model, additional functionality is 52provided by the following module imports: 53 54\code \QtMinorVersion 55import QtQuick3D.Materials 1.\1 56import QtQuick3D.Effects 1.\1 57import QtQuick3D.Helpers 1.\1 58\endcode 59 60\section1 Building From Source 61 62When building from source, ensure that the \e qtdeclarative module 63is also built, as it is not possible to use Qt Quick 3D without it. 64 65In addition, examples use the modules \l {Qt Quick Controls} and 66\l {Qt Graphical Effects} for additional functionality. 67 68It can also be helpful to build \l {Qt Image Formats} as this 69module provides support for additional texture formats. 70 71\section1 License and Attributions 72 73Qt Quick 3D is available under the commercial license from \l {The Qt Company}. 74In addition, it is available under the 75\l{GNU General Public License, version 3}. 76See \l {Qt Licensing} for further details. 77 78Furthermore Qt Quick 3D potentially contains third party modules 79under the following permissive licenses: 80 81\generatelist{groupsbymodule attributions-qtquick3d} 82 83\section1 Topics 84 85\list 86 \li \l{Qt Quick 3D Graphics Requirements} 87 \li \l{Qt Quick 3D Asset Conditioning} 88 \li \l{Qt Quick 3D Custom Material Reference} 89 \li \l{Qt Quick 3D Environment Variables} 90 \li \l{Balsam Asset Import Tool} 91\endlist 92 93\section1 Reference 94\list 95 \li \l{Qt Quick 3D QML Types} 96 \li \l{Qt Quick 3D C++ Classes} 97 \li \l{Qt Quick 3D Helpers QML Types} 98 \li \l{Qt Quick 3D Materials QML Types} 99 \li \l{Qt Quick 3D Effects QML Types} 100\endlist 101 102\section1 Examples 103 104\list 105 \li \l{Qt Quick 3D - Simple Example}{Simple Scene} 106 \li \l{Qt Quick 3D - View3D Example}{View3D} 107 \li \l{Qt Quick 3D - Dynamic Model Creation Example}{Dynamic Model Creation} 108 \li \l{Qt Quick 3D - Custom Materials Example}{Custom Materials} 109 \li \l{Qt Quick 3D - Principled Material Example}{Principled Material} 110 \li \l{Qt Quick 3D Examples and Tutorials}{ All Examples } 111\endlist 112 113\section1 Related Modules 114 115\list 116 \li \l{Qt Quick} 117\endlist 118 119*/ 120