summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike Krus <mike.krus@kdab.com>2020-11-13 10:03:40 +0000
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-11-23 18:51:18 +0000
commitd062b314965058601f241bbf8169059bb665856a (patch)
treed4bf32a8eb8664752eedf12676943e9dcd25e7fc
parent09a5922c66d772769ac9a69a9a49c10012a4f33e (diff)
Update documentation
Change-Id: I20195e764ee33ec6c8af3ded2ff7ec84c6ac3eb1 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> (cherry picked from commit fb687161002474d20772a594f7e61cf927443919) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/doc/src/qt3drender-geometry.qdoc32
-rw-r--r--src/doc/src/qt6-changes.qdoc30
2 files changed, 54 insertions, 8 deletions
diff --git a/src/doc/src/qt3drender-geometry.qdoc b/src/doc/src/qt3drender-geometry.qdoc
index 6bfabbc76..478400469 100644
--- a/src/doc/src/qt3drender-geometry.qdoc
+++ b/src/doc/src/qt3drender-geometry.qdoc
@@ -119,18 +119,19 @@
}
\endcode
- \section2 GeometryRenderer
+ \section2 GeometryView
- Qt3DRender::QGeometryRenderer is a QComponent which when aggregated by a
- QEntity allows to draw the Qt3DCore::QGeometry it references. It provides
+ A Qt3DCore::QGeometryView takes a Qt3DCore::QGeometry. It provides
properties to control the draw call such as the number of instances to be
drawn, the starting instance, the type of
- Qt3DRender::QGeometryRenderer::PrimitiveType to be used, etc. A
- Qt3DRender::QGeometryRenderer is translated into a draw call to the
- underlying graphics API.
+ Qt3DCore::QGeometryView::PrimitiveType to be used, etc.
+
+ It completely defines the details of a mesh so that operations such as
+ bounding volume computation and picking can be done on a mesh without
+ requiring it to be rendered.
\code
- GeometryRenderer {
+ GeometryView {
instanceCount: 1
indexOffset: 0
firstInstance: 0
@@ -139,4 +140,21 @@
}
\endcode
+ \section2 GeometryRenderer
+
+ Qt3DRender::QGeometryRenderer is a QComponent which when aggregated by a
+ QEntity allows to draw the Qt3DCore::QGeometryView it references. A
+ Qt3DRender::QGeometryRenderer is translated into a draw call to the
+ underlying graphics API.
+
+ \code
+ GeometryRenderer {
+ view: GeometryView { ... }
+ }
+ \endcode
+
+ \note Prior to Qt 6, Qt3DRender::QGeometryRenderer included details that are
+ now intended to be provided by the view instance. The properties are still
+ there in Qt 6 but will be deprecated and then removed in Qt 7.
+
*/
diff --git a/src/doc/src/qt6-changes.qdoc b/src/doc/src/qt6-changes.qdoc
index 4ec2886d1..04c9d6c57 100644
--- a/src/doc/src/qt6-changes.qdoc
+++ b/src/doc/src/qt6-changes.qdoc
@@ -39,5 +39,33 @@
In this topic we summarize those changes in Qt3D, and provide guidance
to handle them.
- \section1 ADD STUFF HERE
+ \section1 New rendering backend
+
+ Over the course of 5.14 and 5.15, the rendering backend was gradually
+ moved into a plugin.
+
+ Qt 6 release completes this work and introduces a new RHI based rendering
+ backend which will enable use of Vulkan, Metal or DirectX on the relevant
+ platforms.
+
+ The RHI backend is the default but this can be controlled by setting
+ environment variables as explained \l {Qt 3D Render C++ Classes} {here}.
+
+ \section1 Code changes
+
+ Some classes have changed modules. In particular, the QBuffer, QAttribute
+ and QGeometry classes (along with associated helper classes) have moved
+ from the Render module to the Core module.
+
+ \section1 New API
+
+ \list
+ \li \l {Qt3DCore::QGeometryView} provides all details for a mesh
+ \li \l {Qt3DCore::QBoundingVolume} provides a way of querying or overriding
+ the size of the axis aligned bounding box of a geometry
+ \li \l {Qt3DRender::QPickingProxy} provides a way of specifying an alternative
+ (usually simpler) geometry for picking
+ \li \l {Qt3DCore::QAbstractAspect} and \l {Qt3DCore::QAspectJobs} add methods
+ to facilitate and optimize the synchronization of backend operations.
+ \endlist
*/