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
|
<!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::RenderQueue 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_1RenderQueue.html">RenderQueue</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::RenderQueue Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderQueue" -->
<p>Class that represents a queue of <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects to be rendered.
<a href="classCEGUI_1_1RenderQueue.html#details">More...</a></p>
<p><a href="classCEGUI_1_1RenderQueue-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="ac422d4f4b1490d383d714c3764672cb2"></a><!-- doxytag: member="CEGUI::RenderQueue::draw" ref="ac422d4f4b1490d383d714c3764672cb2" args="() const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderQueue.html#ac422d4f4b1490d383d714c3764672cb2">draw</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw all <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects currently listed in the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a>. The <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects remain in the queue after drawing has taken place. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderQueue.html#a95aa03b11553a9339b01317fcc59f8c8">addGeometryBuffer</a> (const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> to the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a>. Ownership of the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> does not pass to the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a>. <a href="#a95aa03b11553a9339b01317fcc59f8c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderQueue.html#abc82acaa3f59a034cf30fc3c4bafdefe">removeGeometryBuffer</a> (const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> previously queued for drawing. If the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> is not added to the queue, no action is taken. The removed <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> is not destroyed or modified in any way. <a href="#abc82acaa3f59a034cf30fc3c4bafdefe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c527cb7544314e57f6877cc8ed02ccf"></a><!-- doxytag: member="CEGUI::RenderQueue::reset" ref="a2c527cb7544314e57f6877cc8ed02ccf" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderQueue.html#a2c527cb7544314e57f6877cc8ed02ccf">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove any and all queued <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects and restore the queue to the default state. Any <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects removed are not destroyed or modified in any way. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that represents a queue of <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects to be rendered. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> does not make copies of added GeometryBuffers, nor does it take ownership of them - it is up to other parts of the system to manage the lifetime of the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects (and to remove them from any <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> to which they may be attached prior to destoying them). </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a95aa03b11553a9339b01317fcc59f8c8"></a><!-- doxytag: member="CEGUI::RenderQueue::addGeometryBuffer" ref="a95aa03b11553a9339b01317fcc59f8c8" args="(const GeometryBuffer &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderQueue::addGeometryBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> to the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a>. Ownership of the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> does not pass to the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> that is to be added to the <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> for later drawing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abc82acaa3f59a034cf30fc3c4bafdefe"></a><!-- doxytag: member="CEGUI::RenderQueue::removeGeometryBuffer" ref="abc82acaa3f59a034cf30fc3c4bafdefe" args="(const GeometryBuffer &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderQueue::removeGeometryBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> previously queued for drawing. If the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> is not added to the queue, no action is taken. The removed <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> is not destroyed or modified in any way. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> to be removed from the queue. </td></tr>
</table>
</dd>
</dl>
</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>
|