Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > 8e6051afcdb111a0317a58fb64c2abf5 > files > 4133

qt4-doc-4.6.3-0.2mdv2010.2.i586.rpm

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qglframebufferobject.cpp -->
<head>
  <title>Qt 4.6: QGLFramebufferObjectFormat Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//QGLFramebufferObjectFormat"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QGLFramebufferObjectFormat Class Reference<br /><span class="small-subtitle">[<a href="qtopengl.html">QtOpenGL</a> module]</span>
</h1>
<p>The QGLFramebufferObjectFormat class specifies the format of an OpenGL framebuffer object. <a href="#details">More...</a></p>
<pre> #include &lt;QGLFramebufferObjectFormat&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
<p>This class was introduced in Qt 4.6.</p>
<ul>
<li><a href="qglframebufferobjectformat-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#QGLFramebufferObjectFormat">QGLFramebufferObjectFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#QGLFramebufferObjectFormat-2">QGLFramebufferObjectFormat</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#dtor.QGLFramebufferObjectFormat">~QGLFramebufferObjectFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QGLFramebufferObject::Attachment </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#attachment">attachment</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GLenum </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#samples">samples</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#setAttachment">setAttachment</a></b> ( QGLFramebufferObject::Attachment <i>attachment</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#setInternalTextureFormat">setInternalTextureFormat</a></b> ( GLenum <i>internalTextureFormat</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#setSamples">setSamples</a></b> ( int <i>samples</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#setTextureTarget">setTextureTarget</a></b> ( GLenum <i>target</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GLenum </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#textureTarget">textureTarget</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#operator-not-eq">operator!=</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QGLFramebufferObjectFormat &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#operator-eq">operator=</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglframebufferobjectformat.html#operator-eq-eq">operator==</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QGLFramebufferObjectFormat class specifies the format of an OpenGL framebuffer object.</p>
<p>A framebuffer object has several characteristics:</p>
<ul>
<li><a href="qglframebufferobjectformat.html#setSamples">Number of samples per pixels.</a></li>
<li><a href="qglframebufferobjectformat.html#setAttachment">Depth and/or stencil attachments.</a></li>
<li><a href="qglframebufferobjectformat.html#setTextureTarget">Texture target.</a></li>
<li><a href="qglframebufferobjectformat.html#setInternalTextureFormat">Internal texture format.</a></li>
</ul>
<p>Note that the desired attachments or number of samples per pixels might not be supported by the hardware driver. Call <a href="qglframebufferobject.html#format">QGLFramebufferObject::format</a>() after creating a <a href="qglframebufferobject.html">QGLFramebufferObject</a> to find the exact format that was used to create the frame buffer object.</p>
<p>See also <a href="qglframebufferobject.html">QGLFramebufferObject</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/QGLFramebufferObjectFormat"></a>
<h3 class="fn"><a name="QGLFramebufferObjectFormat"></a>QGLFramebufferObjectFormat::QGLFramebufferObjectFormat ()</h3>
<p>Creates a <a href="qglframebufferobjectformat.html">QGLFramebufferObjectFormat</a> object for specifying the format of an OpenGL framebuffer object.</p>
<p>By default the format specifies a non-multisample framebuffer object with no attachments, texture target <tt>GL_TEXTURE_2D</tt>, and internal format <tt>GL_RGBA8</tt>. On OpenGL/ES systems, the default internal format is <tt>GL_RGBA</tt>.</p>
<p>See also <a href="qglframebufferobjectformat.html#samples">samples</a>(), <a href="qglframebufferobjectformat.html#attachment">attachment</a>(), <a href="qmake-variable-reference.html#target">target</a>(), and <a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a>().</p>
<h3 class="fn"><a name="QGLFramebufferObjectFormat-2"></a>QGLFramebufferObjectFormat::QGLFramebufferObjectFormat ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/~QGLFramebufferObjectFormat"></a>
<h3 class="fn"><a name="dtor.QGLFramebufferObjectFormat"></a>QGLFramebufferObjectFormat::~QGLFramebufferObjectFormat ()</h3>
<p>Destroys the <a href="qglframebufferobjectformat.html">QGLFramebufferObjectFormat</a>.</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/attachment"></a>
<h3 class="fn"><a name="attachment"></a><a href="qglframebufferobject.html#Attachment-enum">QGLFramebufferObject::Attachment</a> QGLFramebufferObjectFormat::attachment () const</h3>
<p>Returns the configuration of the depth and stencil buffers attached to a framebuffer object. The default is <a href="qglframebufferobject.html#Attachment-enum">QGLFramebufferObject::NoAttachment</a>.</p>
<p>See also <a href="qglframebufferobjectformat.html#setAttachment">setAttachment</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/internalTextureFormat"></a>
<h3 class="fn"><a name="internalTextureFormat"></a>GLenum QGLFramebufferObjectFormat::internalTextureFormat () const</h3>
<p>Returns the internal format of a framebuffer object's texture or multisample framebuffer object's color buffer. The default is <tt>GL_RGBA8</tt> on desktop OpenGL systems, and <tt>GL_RGBA</tt> on OpenGL/ES systems.</p>
<p>See also <a href="qglframebufferobjectformat.html#setInternalTextureFormat">setInternalTextureFormat</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/samples"></a>
<h3 class="fn"><a name="samples"></a>int QGLFramebufferObjectFormat::samples () const</h3>
<p>Returns the number of samples per pixel if a framebuffer object is a multisample framebuffer object. Otherwise, returns 0. The default value is 0.</p>
<p>See also <a href="qglframebufferobjectformat.html#setSamples">setSamples</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/setAttachment"></a>
<h3 class="fn"><a name="setAttachment"></a>void QGLFramebufferObjectFormat::setAttachment ( <a href="qglframebufferobject.html#Attachment-enum">QGLFramebufferObject::Attachment</a> <i>attachment</i> )</h3>
<p>Sets the attachment configuration of a framebuffer object to <i>attachment</i>.</p>
<p>See also <a href="qglframebufferobjectformat.html#attachment">attachment</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/setInternalTextureFormat"></a>
<h3 class="fn"><a name="setInternalTextureFormat"></a>void QGLFramebufferObjectFormat::setInternalTextureFormat ( GLenum <i>internalTextureFormat</i> )</h3>
<p>Sets the internal format of a framebuffer object's texture or multisample framebuffer object's color buffer to <i>internalTextureFormat</i>.</p>
<p>See also <a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/setSamples"></a>
<h3 class="fn"><a name="setSamples"></a>void QGLFramebufferObjectFormat::setSamples ( int <i>samples</i> )</h3>
<p>Sets the number of samples per pixel for a multisample framebuffer object to <i>samples</i>. The default sample count of 0 represents a regular non-multisample framebuffer object.</p>
<p>If the desired amount of samples per pixel is not supported by the hardware then the maximum number of samples per pixel will be used. Note that multisample framebuffer objects can not be bound as textures. Also, the <tt>GL_EXT_framebuffer_multisample</tt> extension is required to create a framebuffer with more than one sample per pixel.</p>
<p>See also <a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/setTextureTarget"></a>
<h3 class="fn"><a name="setTextureTarget"></a>void QGLFramebufferObjectFormat::setTextureTarget ( GLenum <i>target</i> )</h3>
<p>Sets the texture target of the texture attached to a framebuffer object to <i>target</i>. Ignored for multisample framebuffer objects.</p>
<p>See also <a href="qglframebufferobjectformat.html#textureTarget">textureTarget</a>() and <a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/textureTarget"></a>
<h3 class="fn"><a name="textureTarget"></a>GLenum QGLFramebufferObjectFormat::textureTarget () const</h3>
<p>Returns the texture target of the texture attached to a framebuffer object. Ignored for multisample framebuffer objects. The default is <tt>GL_TEXTURE_2D</tt>.</p>
<p>See also <a href="qglframebufferobjectformat.html#setTextureTarget">setTextureTarget</a>() and <a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/operator!="></a>
<h3 class="fn"><a name="operator-not-eq"></a>bool QGLFramebufferObjectFormat::operator!= ( const QGLFramebufferObjectFormat &amp; <i>other</i> ) const</h3>
<p>Returns false if all the options of this framebuffer object format are the same as <i>other</i>; otherwise returns true.</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/operator="></a>
<h3 class="fn"><a name="operator-eq"></a>QGLFramebufferObjectFormat &amp; QGLFramebufferObjectFormat::operator= ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this object.</p>
<a name="//apple_ref/cpp/instm/QGLFramebufferObjectFormat/operator=="></a>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QGLFramebufferObjectFormat::operator== ( const QGLFramebufferObjectFormat &amp; <i>other</i> ) const</h3>
<p>Returns true if all the options of this framebuffer object format are the same as <i>other</i>; otherwise returns false.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>