path: root/src/opengl/doc/src/qtopengl-index.qdoc
diff options
authorLars Knoll <>2012-11-29 13:54:31 +0100
committerThe Qt Project <>2012-11-30 00:49:21 +0100
commitc85ca8d1cf2bf637014f82e732ee897e2fe2dafa (patch)
treee40ed63acd58a09794d5eef859ef36359b51cbcb /src/opengl/doc/src/qtopengl-index.qdoc
parentf810c9fc330e41230321442e3fa06edb2fd95ee6 (diff)
Fix Qt OpenGL overview.
Change-Id: Ib95638a8eb306e5ababa47cc61e1b5db4ae6cb31 Reviewed-by: Paul Olav Tvete <>
Diffstat (limited to 'src/opengl/doc/src/qtopengl-index.qdoc')
1 files changed, 72 insertions, 0 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
new file mode 100644
index 0000000000..041751be0f
--- /dev/null
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -0,0 +1,72 @@
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact:
+** This file is part of the documentation of the Qt Toolkit.
+** 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 For further information
+** use the contact form at
+** 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:
+ \page qtopengl-index.html
+ \title Qt OpenGL
+ \brief The QtOpenGL module offers classes that make it easy to
+ use OpenGL in Qt applications.
+ \warning Apart from the \l{QGLWidget} class, this module should not be used
+ anymore for new code. Please use the corresponding OpenGL classes in
+ \l{Qt Gui}.
+ OpenGL is a standard API for rendering 3D graphics. OpenGL only
+ deals with 3D rendering and provides little or no support for GUI
+ programming issues. The user interface for an OpenGL application
+ must be created with another toolkit, such as Cocoa on the Mac OS X
+ platform, Microsoft Foundation Classes (MFC) under Windows, or Qt
+ on both platforms.
+ \note OpenGL is a trademark of Silicon Graphics, Inc. in
+ the United States and other countries.
+ The Qt OpenGL module makes it easy to use OpenGL in Qt applications.
+ It provides an OpenGL widget class that can be used just like any
+ other Qt widget, except that it opens an OpenGL display buffer where
+ you can use the OpenGL API to render the contents.
+ To include the definitions of the module's classes, use the
+ following directive:
+ \snippet code/doc_src_qtopengl.cpp 0
+ To link against the module, add this line to your \l qmake \c
+ .pro file:
+ \snippet code/ 1
+ The Qt OpenGL module is implemented as a platform-independent Qt/C++
+ wrapper around the platform-dependent GLX (version 1.3 or later),
+ WGL, or AGL C APIs. Although the basic functionality provided is very
+ similar to Mark Kilgard's GLUT library, applications using the Qt
+ OpenGL module can take advantage of the whole Qt API for
+ non-OpenGL-specific GUI functionality.
+ The \l{Qt OpenGL C++ classes} page gives an overview over the available classes
+ int this module.