summaryrefslogtreecommitdiffstats
path: root/src/core/doc
diff options
context:
space:
mode:
authorSean Harmer <sean.harmer@kdab.com>2015-06-12 19:08:00 +0100
committerSean Harmer <sean.harmer@kdab.com>2015-06-19 09:16:31 +0000
commitb71f09d143002f15abfd4a407651544942a75c44 (patch)
tree0abd8995d4213e0d0d0f630256e0a9c3cef26e08 /src/core/doc
parentb3479775e23f42f0314af54442133e86f9737301 (diff)
Add some documentation about the framegraph concepts
Change-Id: I9f2e21d3277d69a396a564ffd58c53ee91b37d45 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/core/doc')
-rw-r--r--src/core/doc/src/qt3d-overview.qdoc7
-rw-r--r--src/core/doc/src/qt3dcore-index.qdoc5
2 files changed, 7 insertions, 5 deletions
diff --git a/src/core/doc/src/qt3d-overview.qdoc b/src/core/doc/src/qt3d-overview.qdoc
index 48788b5c7..a02f32d83 100644
--- a/src/core/doc/src/qt3d-overview.qdoc
+++ b/src/core/doc/src/qt3d-overview.qdoc
@@ -74,9 +74,10 @@
\section1 Configurable Renderer
To combine support for both C++ and QML APIs with having a fully
- configurable renderer, the concept of a \e framegraph was introduced.
- While a \e scenegraph is a data-driven description of \e what to render, a
- framegraph is a data-driven description of \e how to render it.
+ configurable renderer, the concept of a \e framegraph was introduced. While
+ a \e scenegraph is a data-driven description of \e what to render, a \l
+ {Qt3D Renderer Framegraph}{framegraph} is a data-driven description of \e
+ how to render it.
A framegraph enables developers to choose between a simple forward renderer,
including a z-fill pass, or using a deferred renderer for example. It also
diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc
index 5c3bc9794..9e01e25ff 100644
--- a/src/core/doc/src/qt3dcore-index.qdoc
+++ b/src/core/doc/src/qt3dcore-index.qdoc
@@ -79,8 +79,9 @@
\section1 Overview
- The high level design and motivation for Qt3D is described in the
- \l {Qt3D Overview}.
+ The high level design and motivation for Qt3D is described in the \l {Qt3D
+ Overview}. The Qt3D Renderer aspect offers support for data-driven
+ configuration as described in \l {Qt3D Renderer Framegraph}.
\section1 Reference
\list