File: qglframebufferobjectformat.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (186 lines) | stat: -rw-r--r-- 16,825 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
<?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" />
<!-- qglframebufferobject.cpp -->
  <title>Qt 4.8: QGLFramebufferObjectFormat Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <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><a href="qtopengl.html">QtOpenGL</a></li>
<li>QGLFramebufferObjectFormat</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGLFramebufferObjectFormat Class Reference</h1>
<!-- $$$QGLFramebufferObjectFormat-brief -->
<p>The QGLFramebufferObjectFormat class specifies the format of an OpenGL framebuffer object. <a href="#details">More...</a></p>
<!-- @@@QGLFramebufferObjectFormat -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGLFramebufferObjectFormat&gt;</span></pre><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>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#QGLFramebufferObjectFormat">QGLFramebufferObjectFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#QGLFramebufferObjectFormat-2">QGLFramebufferObjectFormat</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#dtor.QGLFramebufferObjectFormat">~QGLFramebufferObjectFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGLFramebufferObject::Attachment </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#attachment">attachment</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> GLenum </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#mipmap">mipmap</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#samples">samples</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#setAttachment">setAttachment</a></b> ( QGLFramebufferObject::Attachment <i>attachment</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#setInternalTextureFormat">setInternalTextureFormat</a></b> ( GLenum <i>internalTextureFormat</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#setMipmap">setMipmap</a></b> ( bool <i>enabled</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#setSamples">setSamples</a></b> ( int <i>samples</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#setTextureTarget">setTextureTarget</a></b> ( GLenum <i>target</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> GLenum </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#textureTarget">textureTarget</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#operator-not-eq">operator!=</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGLFramebufferObjectFormat &amp; </td><td class="memItemRight bottomAlign"><b><a href="qglframebufferobjectformat.html#operator-eq">operator=</a></b> ( const QGLFramebufferObjectFormat &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><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>
<!-- $$$QGLFramebufferObjectFormat-description -->
<div class="descr">
<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>
</div>
<p><b>See also </b><a href="qglframebufferobject.html">QGLFramebufferObject</a>.</p>
<!-- @@@QGLFramebufferObjectFormat -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGLFramebufferObjectFormat[overload1]$$$QGLFramebufferObjectFormat -->
<h3 class="fn"><a name="QGLFramebufferObjectFormat"></a>QGLFramebufferObjectFormat::<span class="name">QGLFramebufferObjectFormat</span> ()</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><b>See also </b><a href="qglframebufferobjectformat.html#samples">samples</a>(), <a href="qglframebufferobjectformat.html#attachment">attachment</a>(), and <a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a>().</p>
<!-- @@@QGLFramebufferObjectFormat -->
<!-- $$$QGLFramebufferObjectFormat$$$QGLFramebufferObjectFormatconstQGLFramebufferObjectFormat& -->
<h3 class="fn"><a name="QGLFramebufferObjectFormat-2"></a>QGLFramebufferObjectFormat::<span class="name">QGLFramebufferObjectFormat</span> ( const <span class="type">QGLFramebufferObjectFormat</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QGLFramebufferObjectFormat -->
<!-- $$$~QGLFramebufferObjectFormat[overload1]$$$~QGLFramebufferObjectFormat -->
<h3 class="fn"><a name="dtor.QGLFramebufferObjectFormat"></a>QGLFramebufferObjectFormat::<span class="name">~QGLFramebufferObjectFormat</span> ()</h3>
<p>Destroys the <a href="qglframebufferobjectformat.html">QGLFramebufferObjectFormat</a>.</p>
<!-- @@@~QGLFramebufferObjectFormat -->
<!-- $$$attachment[overload1]$$$attachment -->
<h3 class="fn"><a name="attachment"></a><span class="type"><a href="qglframebufferobject.html#Attachment-enum">QGLFramebufferObject::Attachment</a></span> QGLFramebufferObjectFormat::<span class="name">attachment</span> () 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><b>See also </b><a href="qglframebufferobjectformat.html#setAttachment">setAttachment</a>().</p>
<!-- @@@attachment -->
<!-- $$$internalTextureFormat[overload1]$$$internalTextureFormat -->
<h3 class="fn"><a name="internalTextureFormat"></a><span class="type">GLenum</span> QGLFramebufferObjectFormat::<span class="name">internalTextureFormat</span> () 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><b>See also </b><a href="qglframebufferobjectformat.html#setInternalTextureFormat">setInternalTextureFormat</a>().</p>
<!-- @@@internalTextureFormat -->
<!-- $$$mipmap[overload1]$$$mipmap -->
<h3 class="fn"><a name="mipmap"></a><span class="type">bool</span> QGLFramebufferObjectFormat::<span class="name">mipmap</span> () const</h3>
<p>Returns true if mipmapping is enabled.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qglframebufferobjectformat.html#setMipmap">setMipmap</a>().</p>
<!-- @@@mipmap -->
<!-- $$$samples[overload1]$$$samples -->
<h3 class="fn"><a name="samples"></a><span class="type">int</span> QGLFramebufferObjectFormat::<span class="name">samples</span> () 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><b>See also </b><a href="qglframebufferobjectformat.html#setSamples">setSamples</a>().</p>
<!-- @@@samples -->
<!-- $$$setAttachment[overload1]$$$setAttachmentQGLFramebufferObject::Attachment -->
<h3 class="fn"><a name="setAttachment"></a><span class="type">void</span> QGLFramebufferObjectFormat::<span class="name">setAttachment</span> ( <span class="type"><a href="qglframebufferobject.html#Attachment-enum">QGLFramebufferObject::Attachment</a></span> <i>attachment</i> )</h3>
<p>Sets the attachment configuration of a framebuffer object to <i>attachment</i>.</p>
<p><b>See also </b><a href="qglframebufferobjectformat.html#attachment">attachment</a>().</p>
<!-- @@@setAttachment -->
<!-- $$$setInternalTextureFormat[overload1]$$$setInternalTextureFormatGLenum -->
<h3 class="fn"><a name="setInternalTextureFormat"></a><span class="type">void</span> QGLFramebufferObjectFormat::<span class="name">setInternalTextureFormat</span> ( <span class="type">GLenum</span> <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><b>See also </b><a href="qglframebufferobjectformat.html#internalTextureFormat">internalTextureFormat</a>().</p>
<!-- @@@setInternalTextureFormat -->
<!-- $$$setMipmap[overload1]$$$setMipmapbool -->
<h3 class="fn"><a name="setMipmap"></a><span class="type">void</span> QGLFramebufferObjectFormat::<span class="name">setMipmap</span> ( <span class="type">bool</span> <i>enabled</i> )</h3>
<p>Enables mipmapping if <i>enabled</i> is true; otherwise disables it.</p>
<p>Mipmapping is disabled by default.</p>
<p>If mipmapping is enabled, additional memory will be allocated for the mipmap levels. The mipmap levels can be updated by binding the texture and calling glGenerateMipmap(). Mipmapping cannot be enabled for multisampled framebuffer objects.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qglframebufferobjectformat.html#mipmap">mipmap</a>() and <a href="qglframebufferobject.html#texture">QGLFramebufferObject::texture</a>().</p>
<!-- @@@setMipmap -->
<!-- $$$setSamples[overload1]$$$setSamplesint -->
<h3 class="fn"><a name="setSamples"></a><span class="type">void</span> QGLFramebufferObjectFormat::<span class="name">setSamples</span> ( <span class="type">int</span> <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><b>See also </b><a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<!-- @@@setSamples -->
<!-- $$$setTextureTarget[overload1]$$$setTextureTargetGLenum -->
<h3 class="fn"><a name="setTextureTarget"></a><span class="type">void</span> QGLFramebufferObjectFormat::<span class="name">setTextureTarget</span> ( <span class="type">GLenum</span> <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><b>See also </b><a href="qglframebufferobjectformat.html#textureTarget">textureTarget</a>() and <a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<!-- @@@setTextureTarget -->
<!-- $$$textureTarget[overload1]$$$textureTarget -->
<h3 class="fn"><a name="textureTarget"></a><span class="type">GLenum</span> QGLFramebufferObjectFormat::<span class="name">textureTarget</span> () 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><b>See also </b><a href="qglframebufferobjectformat.html#setTextureTarget">setTextureTarget</a>() and <a href="qglframebufferobjectformat.html#samples">samples</a>().</p>
<!-- @@@textureTarget -->
<!-- $$$operator!=[overload1]$$$operator!=constQGLFramebufferObjectFormat& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGLFramebufferObjectFormat::<span class="name">operator!=</span> ( const <span class="type">QGLFramebufferObjectFormat</span> &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>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGLFramebufferObjectFormat& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGLFramebufferObjectFormat</span> &amp; QGLFramebufferObjectFormat::<span class="name">operator=</span> ( const <span class="type">QGLFramebufferObjectFormat</span> &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGLFramebufferObjectFormat& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGLFramebufferObjectFormat::<span class="name">operator==</span> ( const <span class="type">QGLFramebufferObjectFormat</span> &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>
<!-- @@@operator== -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. 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>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      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>
</body>
</html>