summaryrefslogtreecommitdiffstats
path: root/examples/opengl/doc/src/hellogl2.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/opengl/doc/src/hellogl2.qdoc')
-rw-r--r--examples/opengl/doc/src/hellogl2.qdoc43
1 files changed, 43 insertions, 0 deletions
diff --git a/examples/opengl/doc/src/hellogl2.qdoc b/examples/opengl/doc/src/hellogl2.qdoc
new file mode 100644
index 0000000000..adaf9d4719
--- /dev/null
+++ b/examples/opengl/doc/src/hellogl2.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example hellogl2
+ \title Hello GL2 Example
+ \ingroup examples-widgets-opengl
+
+ \brief The Hello GL2 example demonstrates the basic use of the OpenGL-related classes
+ provided with Qt.
+
+ \image hellogl2-example.png
+
+ Qt provides the QOpenGLWidget class to enable OpenGL graphics to be rendered
+ within a standard application user interface. By subclassing this class, and
+ providing reimplementations of event handler functions, 3D scenes can be
+ displayed on widgets that can be placed in layouts, connected to other
+ objects using signals and slots, and manipulated like any other widget.
+*/