summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndy Shaw <andy.shaw@qt.io>2016-11-18 11:03:57 +0100
committerAndy Shaw <andy.shaw@qt.io>2016-11-18 10:05:49 +0000
commitbc218e2fba92368e2c5d8547042d1939481d5e2c (patch)
tree1b09d4a34225bd1f54331eebc0c351d8cd58279a
parente3c70ea206eaef9fe310ebc880070b173977530e (diff)
Readd doc that was removed by e3c70ea206eaef9fe310ebc880070b173977530e
Change-Id: I8fd9fde776b81b09b3d107f2ad95f90672a354ab Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
-rw-r--r--tests/manual/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc21
1 files changed, 21 insertions, 0 deletions
diff --git a/tests/manual/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc b/tests/manual/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc
index 65311e77f..610270316 100644
--- a/tests/manual/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc
+++ b/tests/manual/deferred-renderer-cpp/doc/src/deferred-renderer-cpp.qdoc
@@ -29,4 +29,25 @@
\example deferred-renderer-cpp
\title Qt 3D: Deferred Renderer C++ Example
\ingroup qt3d-examples-cpp
+ \brief A C++ application that demonstrates rendering to an intermediate
+ G-buffer.
+
+ \e {Deferred Renderer} demonstrates using a two pass rendering method.
+ First, all the meshes in the scene are drawn using the same shader that will
+ output the following values for each fragment: world normal vector, color,
+ depth, and world position vector.
+
+ Each of these values will be stored in a texture, which together form what
+ is called the G-buffer. Nothing is drawn onscreen during the first pass, but
+ rather drawn into the G-buffer ready for later use.
+
+ Once all the meshes have been drawn, the G-buffer is filled with all the
+ meshes that can currently be seen by the camera. The second render pass is
+ then used to render the scene to the back buffer with the final color
+ shading by reading the values from the G-buffer textures and outputting a
+ color onto a full screen quad.
+
+ For more information, see \l{Deferred Renderer}.
+
+ \include examples-run.qdocinc
*/