File: classCEGUI_1_1OgreWindowTarget.html

package info (click to toggle)
cegui-mk2 0.7.6-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 105,384 kB
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (193 lines) | stat: -rw-r--r-- 13,056 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
<!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::OgreWindowTarget 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_1OgreWindowTarget.html">OgreWindowTarget</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::OgreWindowTarget Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::OgreWindowTarget" --><!-- doxytag: inherits="CEGUI::OgreRenderTarget" -->
<p><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...">CEGUI::RenderTarget</a> that targets an existing gre::RenderTarget.  
 <a href="classCEGUI_1_1OgreWindowTarget.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::OgreWindowTarget:</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_1OgreWindowTarget__inherit__graph.gif" border="0" usemap="#CEGUI_1_1OgreWindowTarget_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1OgreWindowTarget_inherit__map" id="CEGUI_1_1OgreWindowTarget_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1OgreRenderTarget.html" title="Intermediate RenderTarget implementing common parts for Ogre engine." alt="" coords="8,83,187,112"/><area shape="rect" id="node4" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme..." alt="" coords="21,5,173,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::OgreWindowTarget:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1OgreWindowTarget__coll__graph.gif" border="0" usemap="#CEGUI_1_1OgreWindowTarget_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1OgreWindowTarget_coll__map" id="CEGUI_1_1OgreWindowTarget_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1OgreRenderTarget.html" title="Intermediate RenderTarget implementing common parts for Ogre engine." alt="" coords="67,117,245,147"/><area shape="rect" id="node4" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme..." alt="" coords="5,5,157,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle." alt="" coords="181,5,283,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1OgreWindowTarget-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="a08d40ab5810457d9a8966731426bfd40"></a><!-- doxytag: member="CEGUI::OgreWindowTarget::OgreWindowTarget" ref="a08d40ab5810457d9a8966731426bfd40" args="(OgreRenderer &amp;owner, Ogre::RenderSystem &amp;rs, Ogre::RenderTarget &amp;target)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreWindowTarget.html#a08d40ab5810457d9a8966731426bfd40">OgreWindowTarget</a> (<a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> &amp;owner, Ogre::RenderSystem &amp;rs, Ogre::RenderTarget &amp;target)</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="a508cd04a3da4652de8262994c5c6f0ec"></a><!-- doxytag: member="CEGUI::OgreWindowTarget::~OgreWindowTarget" ref="a508cd04a3da4652de8262994c5c6f0ec" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreWindowTarget.html#a508cd04a3da4652de8262994c5c6f0ec">~OgreWindowTarget</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreWindowTarget.html#a9c5bfa09f2abf31133fda3a1d736b7d7">setOgreRenderTarget</a> (Ogre::RenderTarget &amp;target)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Ogre::RenderTarget that the output from the <a class="el" href="classCEGUI_1_1OgreWindowTarget.html" title="CEGUI::RenderTarget that targets an existing gre::RenderTarget.">OgreWindowTarget</a> should be rendered to.  <a href="#a9c5bfa09f2abf31133fda3a1d736b7d7"></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_1OgreWindowTarget.html#a166ebfbda39f630c8cd9981d93af964d">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="#a166ebfbda39f630c8cd9981d93af964d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a082b1cfc98cb7d0574ea1c7ccccab863"></a><!-- doxytag: member="CEGUI::OgreWindowTarget::initRenderTarget" ref="a082b1cfc98cb7d0574ea1c7ccccab863" args="(Ogre::RenderTarget &amp;target)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreWindowTarget.html#a082b1cfc98cb7d0574ea1c7ccccab863">initRenderTarget</a> (Ogre::RenderTarget &amp;target)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">helper function to initialise the render target details <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_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">CEGUI::RenderTarget</a> that targets an existing gre::RenderTarget. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a166ebfbda39f630c8cd9981d93af964d"></a><!-- doxytag: member="CEGUI::OgreWindowTarget::isImageryCache" ref="a166ebfbda39f630c8cd9981d93af964d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::OgreWindowTarget::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="a9c5bfa09f2abf31133fda3a1d736b7d7"></a><!-- doxytag: member="CEGUI::OgreWindowTarget::setOgreRenderTarget" ref="a9c5bfa09f2abf31133fda3a1d736b7d7" args="(Ogre::RenderTarget &amp;target)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::OgreWindowTarget::setOgreRenderTarget </td>
          <td>(</td>
          <td class="paramtype">Ogre::RenderTarget &amp;&#160;</td>
          <td class="paramname"><em>target</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the Ogre::RenderTarget that the output from the <a class="el" href="classCEGUI_1_1OgreWindowTarget.html" title="CEGUI::RenderTarget that targets an existing gre::RenderTarget.">OgreWindowTarget</a> should be rendered to. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">target</td><td>Reference to an Ogre::RenderTarget object that will receive the rendered output. </td></tr>
  </table>
  </dd>
</dl>

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