summaryrefslogtreecommitdiffstats
path: root/examples/opengl/overlay/overlay.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/opengl/overlay/overlay.doc')
-rw-r--r--examples/opengl/overlay/overlay.doc16
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/opengl/overlay/overlay.doc b/examples/opengl/overlay/overlay.doc
new file mode 100644
index 000000000..7a10b3cbd
--- /dev/null
+++ b/examples/opengl/overlay/overlay.doc
@@ -0,0 +1,16 @@
+/*! \page opengl-overlay-example.html
+
+ \ingroup opengl-examples
+ \title OpenGL Overlay Example
+
+This example demonstrates how to use OpenGL overlays with the Qt OpenGL
+Extension. It features a QGLWidget with a relatively expensive redrawing
+operation, and rubber-band drawing in the overlay plane. Using the
+overlay has the advantage that the rubber-band may be drawn and erased
+without damaging the image in the main plane, so costly redraws are
+avoided.
+
+See \c{$QTDIR/examples/opengl/overlay} for the source code.
+
+*/
+