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
|
<!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::TextureTarget 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 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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_1TextureTarget.html">TextureTarget</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::TextureTarget Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::TextureTarget" --><!-- doxytag: inherits="CEGUI::RenderTarget" -->
<p>Specialisation 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> interface that should be used as the base class for RenderTargets that are implemented using textures.
<a href="classCEGUI_1_1TextureTarget.html#details">More...</a></p>
<p>Inherits <a class="el" href="classCEGUI_1_1RenderTarget.html">CEGUI::RenderTarget</a>.</p>
<p>Inherited by <a class="el" href="classCEGUI_1_1Direct3D10TextureTarget.html">CEGUI::Direct3D10TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D11TextureTarget.html">CEGUI::Direct3D11TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D9TextureTarget.html">CEGUI::Direct3D9TextureTarget</a>, <a class="el" href="classCEGUI_1_1IrrlichtTextureTarget.html">CEGUI::IrrlichtTextureTarget</a>, <a class="el" href="classCEGUI_1_1NullTextureTarget.html">CEGUI::NullTextureTarget</a>, <a class="el" href="classCEGUI_1_1OgreTextureTarget.html">CEGUI::OgreTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html">CEGUI::OpenGLTextureTarget</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::TextureTarget:</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_1TextureTarget__coll__graph.gif" border="0" usemap="#CEGUI_1_1TextureTarget_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1TextureTarget_coll__map" id="CEGUI_1_1TextureTarget_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme..." alt="" coords="7,5,159,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1TextureTarget-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="ad840025b3387963a744d89b21cbb3969"></a><!-- doxytag: member="CEGUI::TextureTarget::clear" ref="ad840025b3387963a744d89b21cbb3969" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextureTarget.html#ad840025b3387963a744d89b21cbb3969">clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the surface of the underlying texture. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextureTarget.html#a6e28889f1666e3ce23e067cb3d1fb7c0">getTexture</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </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="#a6e28889f1666e3ce23e067cb3d1fb7c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextureTarget.html#ab9cdb8912667867c5c3443475838583c">declareRenderSize</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &sz)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to declare to 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> the largest size, in pixels, of the next set of incoming rendering operations. <a href="#ab9cdb8912667867c5c3443475838583c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextureTarget.html#ac9d13a4969f9feae25d90b083cf921ca">isRenderingInverted</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether rendering done on the target texture is inverted in relation to regular textures. <a href="#ac9d13a4969f9feae25d90b083cf921ca"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Specialisation 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> interface that should be used as the base class for RenderTargets that are implemented using textures. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab9cdb8912667867c5c3443475838583c"></a><!-- doxytag: member="CEGUI::TextureTarget::declareRenderSize" ref="ab9cdb8912667867c5c3443475838583c" args="(const Size &sz)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::TextureTarget::declareRenderSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>sz</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to declare to 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> the largest size, in pixels, of the next set of incoming rendering operations. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The main purpose of this is to allow for the implemenatation to resize the underlying texture so that it can hold the imagery that will be drawn.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sz</td><td><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the largest area that will be rendererd in the next batch of rendering operations.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>May be thrown if 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> would not be able to handle the operations rendering content of the given size. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1Direct3D10TextureTarget.html#afd41f9787de89fcc0a0991b3f7ae6d21">CEGUI::Direct3D10TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D11TextureTarget.html#abb43e0781b35c6f253600368c5791ff0">CEGUI::Direct3D11TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D9TextureTarget.html#acf398c5089c8261610824b8fce5aad81">CEGUI::Direct3D9TextureTarget</a>, <a class="el" href="classCEGUI_1_1IrrlichtTextureTarget.html#a225de37d015ff091c52706b2d28046e0">CEGUI::IrrlichtTextureTarget</a>, <a class="el" href="classCEGUI_1_1NullTextureTarget.html#a4cb2c872561d2d85f65f09090761eb8e">CEGUI::NullTextureTarget</a>, <a class="el" href="classCEGUI_1_1OgreTextureTarget.html#ac6694f6b6b4dad003e4fc9102ed3ad1b">CEGUI::OgreTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLApplePBTextureTarget.html#a644855f0738ac8ee41bad88ab09ac74d">CEGUI::OpenGLApplePBTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#a4ceb84c60c57662a3989abe739502f49">CEGUI::OpenGLFBOTextureTarget</a>, <a class="el" href="classCEGUI_1_1OpenGLGLXPBTextureTarget.html#a368753fd36424bc9e2b142138a1c8ad0">CEGUI::OpenGLGLXPBTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLWGLPBTextureTarget.html#ac02c50ed23bd42082e30af8450862dc2">CEGUI::OpenGLWGLPBTextureTarget</a>.</p>
</div>
</div>
<a class="anchor" id="a6e28889f1666e3ce23e067cb3d1fb7c0"></a><!-- doxytag: member="CEGUI::TextureTarget::getTexture" ref="a6e28889f1666e3ce23e067cb3d1fb7c0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Texture.html">Texture</a>& CEGUI::TextureTarget::getTexture </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="classCEGUI_1_1Direct3D10TextureTarget.html#a60d0553f6df3bc366434aad7edbb5e42">CEGUI::Direct3D10TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D11TextureTarget.html#a8baaf9d370ac3b328c8d0d0b437857fe">CEGUI::Direct3D11TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D9TextureTarget.html#a016d7d3172b8e0ae7db990a4910f64a8">CEGUI::Direct3D9TextureTarget</a>, <a class="el" href="classCEGUI_1_1IrrlichtTextureTarget.html#af3851ec4ae70e5e1afe5e9be3419f1e9">CEGUI::IrrlichtTextureTarget</a>, <a class="el" href="classCEGUI_1_1NullTextureTarget.html#a2355ae15b9d0d05798fabe1b77ccd513">CEGUI::NullTextureTarget</a>, <a class="el" href="classCEGUI_1_1OgreTextureTarget.html#accba44c984f0c1add141d10dc7567755">CEGUI::OgreTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#a1d1313b159b4882d475cee61a7abafb6">CEGUI::OpenGLTextureTarget</a>.</p>
</div>
</div>
<a class="anchor" id="ac9d13a4969f9feae25d90b083cf921ca"></a><!-- doxytag: member="CEGUI::TextureTarget::isRenderingInverted" ref="ac9d13a4969f9feae25d90b083cf921ca" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::TextureTarget::isRenderingInverted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure 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>Implemented in <a class="el" href="classCEGUI_1_1Direct3D10TextureTarget.html#a0356cb01cf22c39347bebb1816c1a0be">CEGUI::Direct3D10TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D11TextureTarget.html#a89b9fc43ed32fe06503fc4229f7ea75b">CEGUI::Direct3D11TextureTarget</a>, <a class="el" href="classCEGUI_1_1Direct3D9TextureTarget.html#a6a4a444aa9d0e645115d2787bb26687b">CEGUI::Direct3D9TextureTarget</a>, <a class="el" href="classCEGUI_1_1IrrlichtTextureTarget.html#ae8c8e4611a616ccd9de8daf74df0535e">CEGUI::IrrlichtTextureTarget</a>, <a class="el" href="classCEGUI_1_1NullTextureTarget.html#ab79078b4eac4c37553a5595c891fe505">CEGUI::NullTextureTarget</a>, <a class="el" href="classCEGUI_1_1OgreTextureTarget.html#ad70c6dab4bd801dbfcba1ba05c644da6">CEGUI::OgreTextureTarget</a>, and <a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ad14cc4fae6ac46ee1d8ab1c578130f2c">CEGUI::OpenGLTextureTarget</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
