← Back to branch summary

~thomir-deactivatedaccount/cegui/fix-build

« back to all changes in this revision

Viewing changes to docs/classCEGUI_1_1OpenGLTextureTarget.html

  • Committer: Thomi Richards
  • Date: 2013-02-06 22:13:36 UTC
  • Revision ID: thomi.richards@canonical.com-20130206221336-rsmud4k50g6nzv50
Initial code import.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/classCEGUI_1_1OpenGLTextureTarget.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>Crazy Eddies GUI System: CEGUI::OpenGLTextureTarget Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.4 -->
 
11
<script type="text/javascript">
 
12
function hasClass(ele,cls) {
 
13
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
 
14
}
 
15
 
 
16
function addClass(ele,cls) {
 
17
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
 
18
}
 
19
 
 
20
function removeClass(ele,cls) {
 
21
  if (hasClass(ele,cls)) {
 
22
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
 
23
    ele.className=ele.className.replace(reg,' ');
 
24
  }
 
25
}
 
26
 
 
27
function toggleVisibility(linkObj) {
 
28
 var base = linkObj.getAttribute('id');
 
29
 var summary = document.getElementById(base + '-summary');
 
30
 var content = document.getElementById(base + '-content');
 
31
 var trigger = document.getElementById(base + '-trigger');
 
32
 if ( hasClass(linkObj,'closed') ) {
 
33
   summary.style.display = 'none';
 
34
   content.style.display = 'block';
 
35
   trigger.src = 'open.png';
 
36
   removeClass(linkObj,'closed');
 
37
   addClass(linkObj,'opened');
 
38
 } else if ( hasClass(linkObj,'opened') ) {
 
39
   summary.style.display = 'block';
 
40
   content.style.display = 'none';
 
41
   trigger.src = 'closed.png';
 
42
   removeClass(linkObj,'opened');
 
43
   addClass(linkObj,'closed');
 
44
 }
 
45
 return false;
 
46
}
 
47
</script>
 
48
<div id="top">
 
49
<div id="titlearea">
 
50
<table cellspacing="0" cellpadding="0">
 
51
 <tbody>
 
52
 <tr style="height: 56px;">
 
53
  <td style="padding-left: 0.5em;">
 
54
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
 
55
  </td>
 
56
 </tr>
 
57
 </tbody>
 
58
</table>
 
59
</div>
 
60
  <div id="navrow1" class="tabs">
 
61
    <ul class="tablist">
 
62
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
63
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
64
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
65
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
66
      <li><a href="files.html"><span>Files</span></a></li>
 
67
    </ul>
 
68
  </div>
 
69
  <div id="navrow2" class="tabs2">
 
70
    <ul class="tablist">
 
71
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
72
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
73
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
74
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
75
    </ul>
 
76
  </div>
 
77
  <div id="nav-path" class="navpath">
 
78
    <ul>
 
79
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
 
80
      <li class="navelem"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html">OpenGLTextureTarget</a>      </li>
 
81
    </ul>
 
82
  </div>
 
83
</div>
 
84
<div class="header">
 
85
  <div class="summary">
 
86
<a href="#pub-methods">Public Member Functions</a> &#124;
 
87
<a href="#pro-attribs">Protected Attributes</a>  </div>
 
88
  <div class="headertitle">
 
89
<div class="title">CEGUI::OpenGLTextureTarget Class Reference</div>  </div>
 
90
</div>
 
91
<div class="contents">
 
92
<!-- doxytag: class="CEGUI::OpenGLTextureTarget" --><!-- doxytag: inherits="CEGUI::OpenGLRenderTarget,CEGUI::TextureTarget" -->
 
93
<p><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html" title="OpenGLTextureTarget - Common base class for all OpenGL render targets based on some form of RTT suppo...">OpenGLTextureTarget</a> - Common base class for all OpenGL render targets based on some form of RTT support.  
 
94
 <a href="classCEGUI_1_1OpenGLTextureTarget.html#details">More...</a></p>
 
95
 
 
96
<p>Inherits <a class="el" href="classCEGUI_1_1OpenGLRenderTarget.html">CEGUI::OpenGLRenderTarget</a>, and <a class="el" href="classCEGUI_1_1TextureTarget.html">CEGUI::TextureTarget</a>.</p>
 
97
 
 
98
<p>Inherited by <a class="el" href="classCEGUI_1_1OpenGLApplePBTextureTarget.html">CEGUI::OpenGLApplePBTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html">CEGUI::OpenGLFBOTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLGLXPBTextureTarget.html">CEGUI::OpenGLGLXPBTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLWGLPBTextureTarget.html">CEGUI::OpenGLWGLPBTextureTarget</a>.</p>
 
99
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
100
  <img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::OpenGLTextureTarget:</div>
 
101
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 
102
</div>
 
103
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 
104
<div class="center"><img src="classCEGUI_1_1OpenGLTextureTarget__coll__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLTextureTarget_coll__map" alt="Collaboration graph"/></div>
 
105
<map name="CEGUI_1_1OpenGLTextureTarget_coll__map" id="CEGUI_1_1OpenGLTextureTarget_coll__map">
 
106
<area shape="rect" id="node2" href="classCEGUI_1_1OpenGLRenderTarget.html" title="Intermediate OpenGL implementation of a RenderTarget." alt="" coords="5,5,205,35"/><area shape="rect" id="node4" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that..." alt="" coords="229,5,384,35"/><area shape="rect" id="node6" href="classCEGUI_1_1OpenGLTexture.html" title="Texture implementation for the OpenGLRenderer." alt="" coords="408,5,573,35"/></map>
 
107
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
108
 
 
109
<p><a href="classCEGUI_1_1OpenGLTextureTarget-members.html">List of all members.</a></p>
 
110
<table class="memberdecls">
 
111
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
112
Public Member Functions</h2></td></tr>
 
113
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac30c9b35993c7f65eea2934d1380c7cd"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::OpenGLTextureTarget" ref="ac30c9b35993c7f65eea2934d1380c7cd" args="(OpenGLRenderer &amp;owner)" -->
 
114
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ac30c9b35993c7f65eea2934d1380c7cd">OpenGLTextureTarget</a> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &amp;owner)</td></tr>
 
115
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor. <br/></td></tr>
 
116
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a594b6d3efe46d71999f43fdf8c43e62c"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::~OpenGLTextureTarget" ref="a594b6d3efe46d71999f43fdf8c43e62c" args="()" -->
 
117
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a594b6d3efe46d71999f43fdf8c43e62c">~OpenGLTextureTarget</a> ()</td></tr>
 
118
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <br/></td></tr>
 
119
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a77e011ea669f13d0f19019f405ecfa63">isImageryCache</a> () const </td></tr>
 
120
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> is an implementation that caches actual rendered imagery.  <a href="#a77e011ea669f13d0f19019f405ecfa63"></a><br/></td></tr>
 
121
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a1d1313b159b4882d475cee61a7abafb6">getTexture</a> () const </td></tr>
 
122
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">CEGUI::Texture</a> that the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> is using.  <a href="#a1d1313b159b4882d475cee61a7abafb6"></a><br/></td></tr>
 
123
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ad14cc4fae6ac46ee1d8ab1c578130f2c">isRenderingInverted</a> () const </td></tr>
 
124
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether rendering done on the target texture is inverted in relation to regular textures.  <a href="#ad14cc4fae6ac46ee1d8ab1c578130f2c"></a><br/></td></tr>
 
125
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ac30068b3ef91d37702308495abc6680d">grabTexture</a> ()</td></tr>
 
126
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Grab the texture to a local buffer.  <a href="#ac30068b3ef91d37702308495abc6680d"></a><br/></td></tr>
 
127
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e7b4104fa704dba1474cdd4cb51e8a9"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::restoreTexture" ref="a0e7b4104fa704dba1474cdd4cb51e8a9" args="()" -->
 
128
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a0e7b4104fa704dba1474cdd4cb51e8a9">restoreTexture</a> ()</td></tr>
 
129
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the texture from the locally buffered copy previously create by a call to grabTexture. <br/></td></tr>
 
130
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
 
131
Protected Attributes</h2></td></tr>
 
132
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a3e909c19ed858b14b47c1bdae23983"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::d_texture" ref="a8a3e909c19ed858b14b47c1bdae23983" args="" -->
 
133
GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a8a3e909c19ed858b14b47c1bdae23983">d_texture</a></td></tr>
 
134
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Associated OpenGL texture ID. <br/></td></tr>
 
135
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5280ef61e2319d94968dfb3eb7af63d"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::d_CEGUITexture" ref="ad5280ef61e2319d94968dfb3eb7af63d" args="" -->
 
136
<a class="el" href="classCEGUI_1_1OpenGLTexture.html">OpenGLTexture</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ad5280ef61e2319d94968dfb3eb7af63d">d_CEGUITexture</a></td></tr>
 
137
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">we use this to wrap d_texture so it can be used by the core <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie&#39;s GUI Library.">CEGUI</a> lib. <br/></td></tr>
 
138
</table>
 
139
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
140
<div class="textblock"><p><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html" title="OpenGLTextureTarget - Common base class for all OpenGL render targets based on some form of RTT suppo...">OpenGLTextureTarget</a> - Common base class for all OpenGL render targets based on some form of RTT support. </p>
 
141
</div><hr/><h2>Member Function Documentation</h2>
 
142
<a class="anchor" id="a1d1313b159b4882d475cee61a7abafb6"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::getTexture" ref="a1d1313b159b4882d475cee61a7abafb6" args="() const " -->
 
143
<div class="memitem">
 
144
<div class="memproto">
 
145
      <table class="memname">
 
146
        <tr>
 
147
          <td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>&amp; CEGUI::OpenGLTextureTarget::getTexture </td>
 
148
          <td>(</td>
 
149
          <td class="paramname"></td><td>)</td>
 
150
          <td> const<code> [virtual]</code></td>
 
151
        </tr>
 
152
      </table>
 
153
</div>
 
154
<div class="memdoc">
 
155
 
 
156
<p>Return a pointer to the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">CEGUI::Texture</a> that the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> is using. </p>
 
157
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object that the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> uses when rendering imagery. </dd></dl>
 
158
 
 
159
<p>Implements <a class="el" href="classCEGUI_1_1TextureTarget.html#a6e28889f1666e3ce23e067cb3d1fb7c0">CEGUI::TextureTarget</a>.</p>
 
160
 
 
161
</div>
 
162
</div>
 
163
<a class="anchor" id="ac30068b3ef91d37702308495abc6680d"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::grabTexture" ref="ac30068b3ef91d37702308495abc6680d" args="()" -->
 
164
<div class="memitem">
 
165
<div class="memproto">
 
166
      <table class="memname">
 
167
        <tr>
 
168
          <td class="memname">virtual void CEGUI::OpenGLTextureTarget::grabTexture </td>
 
169
          <td>(</td>
 
170
          <td class="paramname"></td><td>)</td>
 
171
          <td><code> [virtual]</code></td>
 
172
        </tr>
 
173
      </table>
 
174
</div>
 
175
<div class="memdoc">
 
176
 
 
177
<p>Grab the texture to a local buffer. </p>
 
178
<p>This will destroy the OpenGL texture, and restoreTexture must be called before using it again. </p>
 
179
 
 
180
<p>Reimplemented in <a class="el" href="classCEGUI_1_1OpenGLApplePBTextureTarget.html#a2ca4260d2aa3fc00210b5452225ffd46">CEGUI::OpenGLApplePBTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#ab37869c230b77310709bfbb0d1643145">CEGUI::OpenGLFBOTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLGLXPBTextureTarget.html#adfc9f4fa4a0278120d2ac208f41884ac">CEGUI::OpenGLGLXPBTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLWGLPBTextureTarget.html#adda0f079347aa104b34c9abe47813f01">CEGUI::OpenGLWGLPBTextureTarget</a>.</p>
 
181
 
 
182
</div>
 
183
</div>
 
184
<a class="anchor" id="a77e011ea669f13d0f19019f405ecfa63"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::isImageryCache" ref="a77e011ea669f13d0f19019f405ecfa63" args="() const " -->
 
185
<div class="memitem">
 
186
<div class="memproto">
 
187
      <table class="memname">
 
188
        <tr>
 
189
          <td class="memname">bool CEGUI::OpenGLTextureTarget::isImageryCache </td>
 
190
          <td>(</td>
 
191
          <td class="paramname"></td><td>)</td>
 
192
          <td> const<code> [virtual]</code></td>
 
193
        </tr>
 
194
      </table>
 
195
</div>
 
196
<div class="memdoc">
 
197
 
 
198
<p>Return whether the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> is an implementation that caches actual rendered imagery. </p>
 
199
<p>Typically it is expected that texture based RenderTargets would return true in response to this call. Other types of <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a>, like view port based targets, will more likely return false.</p>
 
200
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
 
201
<li>true if the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> does cache rendered imagery.</li>
 
202
<li>false if the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> does not cache rendered imagery. </li>
 
203
</ul>
 
204
</dd></dl>
 
205
 
 
206
<p>Implements <a class="el" href="classCEGUI_1_1RenderTarget.html#a69b2354445177e907b94e68a479e8996">CEGUI::RenderTarget</a>.</p>
 
207
 
 
208
</div>
 
209
</div>
 
210
<a class="anchor" id="ad14cc4fae6ac46ee1d8ab1c578130f2c"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::isRenderingInverted" ref="ad14cc4fae6ac46ee1d8ab1c578130f2c" args="() const " -->
 
211
<div class="memitem">
 
212
<div class="memproto">
 
213
      <table class="memname">
 
214
        <tr>
 
215
          <td class="memname">bool CEGUI::OpenGLTextureTarget::isRenderingInverted </td>
 
216
          <td>(</td>
 
217
          <td class="paramname"></td><td>)</td>
 
218
          <td> const<code> [virtual]</code></td>
 
219
        </tr>
 
220
      </table>
 
221
</div>
 
222
<div class="memdoc">
 
223
 
 
224
<p>Return whether rendering done on the target texture is inverted in relation to regular textures. </p>
 
225
<p>This is intended to be used when generating geometry for rendering the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> onto another surface.</p>
 
226
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
 
227
<li>true if the texture content should be considered as inverted vertically in comparison with other regular textures.</li>
 
228
<li>false if the texture content has the same orientation as regular textures. </li>
 
229
</ul>
 
230
</dd></dl>
 
231
 
 
232
<p>Implements <a class="el" href="classCEGUI_1_1TextureTarget.html#ac9d13a4969f9feae25d90b083cf921ca">CEGUI::TextureTarget</a>.</p>
 
233
 
 
234
</div>
 
235
</div>
 
236
</div>
 
237
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by&#160;
 
238
<a href="http://www.doxygen.org/index.html">
 
239
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
 
240
</body>
 
241
</html>