File: classCEGUI_1_1OpenGLTextureTarget.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (241 lines) | stat: -rw-r--r-- 17,982 bytes parent folder | download | duplicates (2)
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::OpenGLTextureTarget Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html">OpenGLTextureTarget</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::OpenGLTextureTarget Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::OpenGLTextureTarget" --><!-- doxytag: inherits="CEGUI::OpenGLRenderTarget,CEGUI::TextureTarget" -->
<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.  
 <a href="classCEGUI_1_1OpenGLTextureTarget.html#details">More...</a></p>

<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>

<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>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::OpenGLTextureTarget:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1OpenGLTextureTarget__coll__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLTextureTarget_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1OpenGLTextureTarget_coll__map" id="CEGUI_1_1OpenGLTextureTarget_coll__map">
<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>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1OpenGLTextureTarget-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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)" -->
&#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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a594b6d3efe46d71999f43fdf8c43e62c"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::~OpenGLTextureTarget" ref="a594b6d3efe46d71999f43fdf8c43e62c" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a594b6d3efe46d71999f43fdf8c43e62c">~OpenGLTextureTarget</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <br/></td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Grab the texture to a local buffer.  <a href="#ac30068b3ef91d37702308495abc6680d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e7b4104fa704dba1474cdd4cb51e8a9"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::restoreTexture" ref="a0e7b4104fa704dba1474cdd4cb51e8a9" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a0e7b4104fa704dba1474cdd4cb51e8a9">restoreTexture</a> ()</td></tr>
<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>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a3e909c19ed858b14b47c1bdae23983"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::d_texture" ref="a8a3e909c19ed858b14b47c1bdae23983" args="" -->
GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a8a3e909c19ed858b14b47c1bdae23983">d_texture</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Associated OpenGL texture ID. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5280ef61e2319d94968dfb3eb7af63d"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::d_CEGUITexture" ref="ad5280ef61e2319d94968dfb3eb7af63d" args="" -->
<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>
<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>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<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>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1d1313b159b4882d475cee61a7abafb6"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::getTexture" ref="a1d1313b159b4882d475cee61a7abafb6" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>&amp; CEGUI::OpenGLTextureTarget::getTexture </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>
<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>

<p>Implements <a class="el" href="classCEGUI_1_1TextureTarget.html#a6e28889f1666e3ce23e067cb3d1fb7c0">CEGUI::TextureTarget</a>.</p>

</div>
</div>
<a class="anchor" id="ac30068b3ef91d37702308495abc6680d"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::grabTexture" ref="ac30068b3ef91d37702308495abc6680d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CEGUI::OpenGLTextureTarget::grabTexture </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Grab the texture to a local buffer. </p>
<p>This will destroy the OpenGL texture, and restoreTexture must be called before using it again. </p>

<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>

</div>
</div>
<a class="anchor" id="a77e011ea669f13d0f19019f405ecfa63"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::isImageryCache" ref="a77e011ea669f13d0f19019f405ecfa63" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::OpenGLTextureTarget::isImageryCache </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>
<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>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<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>
<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>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCEGUI_1_1RenderTarget.html#a69b2354445177e907b94e68a479e8996">CEGUI::RenderTarget</a>.</p>

</div>
</div>
<a class="anchor" id="ad14cc4fae6ac46ee1d8ab1c578130f2c"></a><!-- doxytag: member="CEGUI::OpenGLTextureTarget::isRenderingInverted" ref="ad14cc4fae6ac46ee1d8ab1c578130f2c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::OpenGLTextureTarget::isRenderingInverted </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return whether rendering done on the target texture is inverted in relation to regular textures. </p>
<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>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the texture content should be considered as inverted vertically in comparison with other regular textures.</li>
<li>false if the texture content has the same orientation as regular textures. </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCEGUI_1_1TextureTarget.html#ac9d13a4969f9feae25d90b083cf921ca">CEGUI::TextureTarget</a>.</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>