<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- modules.qdoc -->
<title>Qt 4.8: QtOpenGL Module</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li>QtOpenGL</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#namespaces">Namespaces</a></li>
<li class="level1"><a href="#classes">Classes</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QtOpenGL Module</h1>
<span class="subtitle"></span>
<!-- $$$QtOpenGL-brief -->
<p>The QtOpenGL module offers classes that make it easy to use OpenGL in Qt applications. <a href="#details">More...</a></p>
<!-- @@@QtOpenGL -->
<a name="namespaces"></a>
<h2>Namespaces</h2>
<table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qgl.html">QGL</a></p></td><td class="tblDescr"><p>Specifies miscellaneous identifiers used in the Qt OpenGL module</p></td></tr>
</table>
<a name="classes"></a>
<h2>Classes</h2>
<table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qglbuffer.html">QGLBuffer</a></p></td><td class="tblDescr"><p>Functions for creating and managing GL buffer objects</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qglcolormap.html">QGLColormap</a></p></td><td class="tblDescr"><p>Used for installing custom colormaps into a QGLWidget</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qglcontext.html">QGLContext</a></p></td><td class="tblDescr"><p>Encapsulates an OpenGL rendering context</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qglformat.html">QGLFormat</a></p></td><td class="tblDescr"><p>Specifies the display format of an OpenGL rendering context</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qglframebufferobject.html">QGLFramebufferObject</a></p></td><td class="tblDescr"><p>Encapsulates an OpenGL framebuffer object</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qglframebufferobjectformat.html">QGLFramebufferObjectFormat</a></p></td><td class="tblDescr"><p>Specifies the format of an OpenGL framebuffer object</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qglfunctions.html">QGLFunctions</a></p></td><td class="tblDescr"><p>Cross-platform access to the OpenGL/ES 2.0 API</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qglpixelbuffer.html">QGLPixelBuffer</a></p></td><td class="tblDescr"><p>Encapsulates an OpenGL pbuffer</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qglshader.html">QGLShader</a></p></td><td class="tblDescr"><p>Allows OpenGL shaders to be compiled</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qglshaderprogram.html">QGLShaderProgram</a></p></td><td class="tblDescr"><p>Allows OpenGL shader programs to be linked and used</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qglwidget.html">QGLWidget</a></p></td><td class="tblDescr"><p>Widget for rendering OpenGL graphics</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwsglwindowsurface.html">QWSGLWindowSurface</a></p></td><td class="tblDescr"><p>The drawing area for top-level windows with Qt for Embedded Linux on EGL/OpenGL ES. It also provides the drawing area for QGLWidgets whether they are top-level windows or children of another QWidget</p></td></tr>
</table>
<!-- $$$QtOpenGL-description -->
<a name="details"></a>
<div class="descr">
<h2>Detailed Description</h2>
<p>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.</p>
<p><b>Note:</b> OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries.</p>
<p>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.</p>
<p>To include the definitions of the module's classes, use the following directive:</p>
<pre class="cpp"> <span class="preprocessor">#include <QtOpenGL></span></pre>
<p>To link against the module, add this line to your <a href="qmake-manual.html#qmake">qmake</a> <tt>.pro</tt> file:</p>
<pre class="cpp"> QT += opengl</pre>
<p>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.</p>
<p>The QtOpenGL module is available on Windows, X11 and Mac OS X. <a href="qt-embeddedlinux-opengl.html">Qt for Embedded Linux and OpenGL</a> supports OpenGL ES (OpenGL for Embedded Systems). <b>Note:</b> To be able to use the OpenGL API in <a href="qt-embedded-linux.html">Qt for Embedded Linux</a>, it must be integrated with the Q Window System (QWS). See the <a href="qt-embeddedlinux-opengl.html">Qt for Embedded Linux and OpenGL</a> documentation for details.</p>
</div>
<!-- @@@QtOpenGL -->
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
