path: root/src/opengl/doc/src
diff options
authorCasper van Donderen <>2012-05-08 10:28:29 +0200
committerMarius Storm-Olsen <>2012-05-09 08:36:59 +0200
commit03d81b0100af4bb9d44a9fa9de55bb4e9e6a0f5d (patch)
treeac87d6ca8721771ed6890e83b4b60a12c4083f86 /src/opengl/doc/src
parent97b5b8009254004608feefb903cbf44abaa099f6 (diff)
Doc: Modularize QtOpenGL documentation.
This change moves the snippets to the modularized directories. Change-Id: Ifcf22fa3f234681f851d1e7eed5fe44e2e223ffd Reviewed-by: Marius Storm-Olsen <>
Diffstat (limited to 'src/opengl/doc/src')
1 files changed, 70 insertions, 0 deletions
diff --git a/src/opengl/doc/src/qtopengl.qdoc b/src/opengl/doc/src/qtopengl.qdoc
new file mode 100644
index 0000000000..0fa28eed8c
--- /dev/null
+++ b/src/opengl/doc/src/qtopengl.qdoc
@@ -0,0 +1,70 @@
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact:
+** This file is part of the documentation of the Qt Toolkit.
+** GNU Free Documentation License
+** 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.
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+ \module QtOpenGL
+ \title QtOpenGL Module
+ \ingroup modules
+ \ingroup technology-apis
+ \brief The QtOpenGL module offers classes that make it easy to
+ use OpenGL in Qt applications.
+ 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 Motif on the 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.