aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/rendercontrol/rendercontrol_opengl/doc
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@qt.io>2021-06-14 16:13:21 +0200
committerLaszlo Agocs <laszlo.agocs@qt.io>2021-06-15 11:12:21 +0200
commitd3412cddab1ca2ed47ed3862d5d7e0a065e64b86 (patch)
tree6f4cf25cd9e738461c6331d5b6f6381d59d1d120 /examples/quick/rendercontrol/rendercontrol_opengl/doc
parent6dfed1ee9c8e03780b222a71f6b90fe2016d8994 (diff)
rendercontrol examples: Exercise key event generation as well
Task-number: QTBUG-93489 Change-Id: Ife9db7b066add1f41de964d4c41309568f954320 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'examples/quick/rendercontrol/rendercontrol_opengl/doc')
-rw-r--r--examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc b/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc
index a4a648e5de..ecf7ab35ee 100644
--- a/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc
+++ b/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc
@@ -30,4 +30,19 @@
\example rendercontrol/rendercontrol_opengl
\brief Shows how to render a Qt Quick scene into a texture that is then used by a non-Quick based OpenGL renderer.
\image rendercontrol-opengl-example.jpg
+
+ The Qt Quick scene is managed by a QQuickWindow that is not visible
+ on-screen. Rather, rendering targets an OpenGL texture and is controlled
+ through QQuickRenderControl.
+
+ The cube is rendered directly with OpenGL, using Qt Gui enablers such as
+ QWindow, QOpenGLContext, QOpenGLShaderProgram, and QOpenGLFunctions. The
+ cube is textured with the texture that the Qt Quick render pass outputs to.
+
+ In addition, basic input event forwarding is also demonstrated. When holding
+ down the left mouse button, the background \l Rectangle color is altered via
+ QML bindings. Similarly, holding down a key on the keyboard changes the
+ color as well. This proves that the "fake" events sent from the application
+ (generated based on events from the on-screen QWindow) are forwarded and
+ processed within the Qt Quick scene.
*/