Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2193

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: cstool/rbuflock.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>cstool/rbuflock.h</h1><a href="rbuflock_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2004 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2004 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSTOOL_RBUFLOCK_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSTOOL_RBUFLOCK_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="rndbuf_8h.html" title="Render buffer interface.">ivideo/rndbuf.h</a>"</span>
<a name="l00029"></a>00029 
<a name="l00043"></a>00043 <span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> TbufferKeeper = iRenderBuffer*&gt;
<a name="l00044"></a><a class="code" href="classcsRenderBufferLock.html">00044</a> <span class="keyword">class </span><a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock</a>
<a name="l00045"></a>00045 {
<a name="l00047"></a>00047   TbufferKeeper buffer;
<a name="l00049"></a>00049   T* lockBuf;
<a name="l00051"></a>00051   <span class="keywordtype">size_t</span> bufStride;
<a name="l00052"></a>00052 <span class="preprocessor">#ifdef CS_DEBUG</span>
<a name="l00054"></a>00054 <span class="preprocessor">  size_t elements;</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor">  size_t currElement;</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span>
<a name="l00059"></a>00059   <span class="keyword">typedef</span> <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock&lt;T, TbufferKeeper&gt;</a> <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">LockType</a>;
<a name="l00069"></a>00069   <span class="keyword">struct </span>PointerProxy
<a name="l00070"></a>00070   {
<a name="l00071"></a>00071 <span class="preprocessor">  #ifdef CS_DEBUG</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>    <span class="keyword">const</span> <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">LockType</a>&amp; parent;
<a name="l00073"></a>00073     <span class="keywordtype">size_t</span> elemNum;
<a name="l00074"></a>00074 <span class="preprocessor">  #else</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span>    T* p;
<a name="l00076"></a>00076 <span class="preprocessor">  #endif</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span>
<a name="l00078"></a>00078     PointerProxy (<span class="keyword">const</span> <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">LockType</a>&amp; parent, <span class="keywordtype">size_t</span> elemNum) 
<a name="l00079"></a>00079   <span class="preprocessor">#ifdef CS_DEBUG</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span>      : parent (parent), elemNum (elemNum)
<a name="l00081"></a>00081   <span class="preprocessor">#else</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span>      : p (&amp;parent.<a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (elemNum))
<a name="l00083"></a>00083   #endif
<a name="l00084"></a>00084     { }
<a name="l00085"></a>00085     T&amp; <a class="code" href="classcsRenderBufferLock.html#ff0f4c842a448aba613f8b717b288fd9" title="Get current element.">operator*</a>()
<a name="l00086"></a>00086     {
<a name="l00087"></a>00087 <span class="preprocessor">  #ifdef CS_DEBUG</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span>      <span class="keywordflow">return</span> parent.<a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (elemNum);
<a name="l00089"></a>00089 <span class="preprocessor">  #else</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span>      <span class="keywordflow">return</span> *p;
<a name="l00091"></a>00091 <span class="preprocessor">  #endif</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span>    }
<a name="l00093"></a>00093     <span class="keyword">const</span> T&amp; <a class="code" href="classcsRenderBufferLock.html#ff0f4c842a448aba613f8b717b288fd9" title="Get current element.">operator*</a>()<span class="keyword"> const</span>
<a name="l00094"></a>00094 <span class="keyword">    </span>{
<a name="l00095"></a>00095 <span class="preprocessor">  #ifdef CS_DEBUG</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>      <span class="keywordflow">return</span> parent.<a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (elemNum);
<a name="l00097"></a>00097 <span class="preprocessor">  #else</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span>      <span class="keywordflow">return</span> *p;
<a name="l00099"></a>00099 <span class="preprocessor">  #endif</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>    }
<a name="l00101"></a>00101   };
<a name="l00102"></a>00102 
<a name="l00103"></a>00103   <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock</a>() {}
<a name="l00104"></a>00104   <span class="comment">// Copying the locking stuff is somewhat nasty so ... prevent it</span>
<a name="l00105"></a>00105   <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock</a> (<span class="keyword">const</span> <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock</a>&amp; other) {}
<a name="l00106"></a>00106 
<a name="l00108"></a>00108   <span class="keywordtype">void</span> Unlock ()
<a name="l00109"></a>00109   {
<a name="l00110"></a>00110     <span class="keywordflow">if</span> (buffer) buffer-&gt;Release();
<a name="l00111"></a>00111   }
<a name="l00112"></a>00112 <span class="keyword">public</span>:
<a name="l00116"></a><a class="code" href="classcsRenderBufferLock.html#6d6bf4106f65c0c51f108537dda1452f">00116</a>   <a class="code" href="classcsRenderBufferLock.html" title="Helper class for convenient locking/unlocking of an iRenderBuffer.">csRenderBufferLock</a> (<a class="code" href="structiRenderBuffer.html" title="This is a general buffer.">iRenderBuffer</a>* buf, 
<a name="l00117"></a>00117     <a class="code" href="group__gfx3d.html#g6415ede5d389a1c56c44ddbc924c8fdc" title="Type of lock of a render buffer.">csRenderBufferLockType</a> lock = <a class="code" href="group__gfx3d.html#gg6415ede5d389a1c56c44ddbc924c8fdcbbd9fe06e63ce950e6c2e497cf923247" title="Get a (writeable) pointer to the buffer.">CS_BUF_LOCK_NORMAL</a>) : buffer(buf),
<a name="l00118"></a>00118     lockBuf(0), bufStride(buf ? buf-&gt;GetElementDistance() : 0),
<a name="l00119"></a>00119     currElement(0)
<a name="l00120"></a>00120   {
<a name="l00121"></a>00121 <span class="preprocessor">#ifdef CS_DEBUG</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span>    elements = buf ? buf-&gt;<a class="code" href="structiRenderBuffer.html#2c43d2f649e4725a8e86abfa5dfbfffe" title="Number of elements in a buffer.">GetElementCount</a>() : 0;
<a name="l00123"></a>00123 <span class="preprocessor">#endif</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>    <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> (buffer != 0);
<a name="l00125"></a>00125     lockBuf = 
<a name="l00126"></a>00126       buffer ? ((T*)((<a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a>*)buffer-&gt;Lock (lock))) : (T*)-1;
<a name="l00127"></a>00127   }
<a name="l00128"></a>00128   
<a name="l00132"></a><a class="code" href="classcsRenderBufferLock.html#b76caf859563992d9a63f5dc4813a4c6">00132</a>   <a class="code" href="classcsRenderBufferLock.html#b76caf859563992d9a63f5dc4813a4c6" title="Destruct the helper.">~csRenderBufferLock</a>()
<a name="l00133"></a>00133   {
<a name="l00134"></a>00134     Unlock();
<a name="l00135"></a>00135   }
<a name="l00136"></a>00136   
<a name="l00141"></a><a class="code" href="classcsRenderBufferLock.html#7bcd17c2436839c0cc9f66d8423d2c56">00141</a>   T* <a class="code" href="classcsRenderBufferLock.html#7bcd17c2436839c0cc9f66d8423d2c56" title="Lock the renderbuffer.">Lock</a> ()<span class="keyword"> const</span>
<a name="l00142"></a>00142 <span class="keyword">  </span>{
<a name="l00143"></a>00143     <span class="keywordflow">return</span> lockBuf;
<a name="l00144"></a>00144   }
<a name="l00145"></a>00145   
<a name="l00150"></a><a class="code" href="classcsRenderBufferLock.html#ffad85cb6b07b682bf9b93bfcf2880e4">00150</a>   <a class="code" href="classcsRenderBufferLock.html#ffad85cb6b07b682bf9b93bfcf2880e4" title="Retrieve a pointer to the contained data.">operator T* </a>()<span class="keyword"> const</span>
<a name="l00151"></a>00151 <span class="keyword">  </span>{
<a name="l00152"></a>00152     <span class="keywordflow">return</span> <a class="code" href="classcsRenderBufferLock.html#7bcd17c2436839c0cc9f66d8423d2c56" title="Lock the renderbuffer.">Lock</a>();
<a name="l00153"></a>00153   }
<a name="l00154"></a>00154 
<a name="l00156"></a><a class="code" href="classcsRenderBufferLock.html#ff0f4c842a448aba613f8b717b288fd9">00156</a>   T&amp; <a class="code" href="classcsRenderBufferLock.html#ff0f4c842a448aba613f8b717b288fd9" title="Get current element.">operator*</a>()<span class="keyword"> const</span>
<a name="l00157"></a>00157 <span class="keyword">  </span>{
<a name="l00158"></a>00158     <span class="keywordflow">return</span> <a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (currElement);
<a name="l00159"></a>00159   }
<a name="l00160"></a>00160 
<a name="l00162"></a><a class="code" href="classcsRenderBufferLock.html#85303043ac965b13518375461fe8d48f">00162</a>   PointerProxy <a class="code" href="classcsRenderBufferLock.html#85303043ac965b13518375461fe8d48f" title="Set current element to the next, pre-increment version.">operator++ </a>()  
<a name="l00163"></a>00163   {
<a name="l00164"></a>00164     currElement++;
<a name="l00165"></a>00165     <span class="keywordflow">return</span> PointerProxy (*<span class="keyword">this</span>, currElement);
<a name="l00166"></a>00166   }
<a name="l00167"></a>00167 
<a name="l00169"></a><a class="code" href="classcsRenderBufferLock.html#346b7a8afcb6666ed979bb3c303790c5">00169</a>   PointerProxy <a class="code" href="classcsRenderBufferLock.html#85303043ac965b13518375461fe8d48f" title="Set current element to the next, pre-increment version.">operator++ </a>(<span class="keywordtype">int</span>)
<a name="l00170"></a>00170   {
<a name="l00171"></a>00171     <span class="keywordtype">size_t</span> n = currElement;
<a name="l00172"></a>00172     currElement++;
<a name="l00173"></a>00173     <span class="keywordflow">return</span> PointerProxy (*<span class="keyword">this</span>, n);
<a name="l00174"></a>00174   }
<a name="l00175"></a>00175 
<a name="l00177"></a><a class="code" href="classcsRenderBufferLock.html#cd5687044f6efac6d1ea74f9be8c14a1">00177</a>   PointerProxy <a class="code" href="classcsRenderBufferLock.html#cd5687044f6efac6d1ea74f9be8c14a1" title="Add a value to the current element index.">operator+= </a>(<span class="keywordtype">int</span> n)
<a name="l00178"></a>00178   {
<a name="l00179"></a>00179     currElement += n;
<a name="l00180"></a>00180     <span class="keywordflow">return</span> PointerProxy (*<span class="keyword">this</span>, currElement);
<a name="l00181"></a>00181   }
<a name="l00182"></a>00182 
<a name="l00184"></a><a class="code" href="classcsRenderBufferLock.html#7b7fab34359f2f1d7a59847415b89464">00184</a>   T&amp; <a class="code" href="classcsRenderBufferLock.html#7b7fab34359f2f1d7a59847415b89464" title="Retrieve an item in the render buffer.">operator [] </a>(<span class="keywordtype">size_t</span> n)<span class="keyword"> const</span>
<a name="l00185"></a>00185 <span class="keyword">  </span>{
<a name="l00186"></a>00186     <span class="keywordflow">return</span> <a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (n);
<a name="l00187"></a>00187   }
<a name="l00188"></a>00188 
<a name="l00190"></a><a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383">00190</a>   T&amp; <a class="code" href="classcsRenderBufferLock.html#83ca5ea94e2a6210f51a24893d869383" title="Retrieve an item in the render buffer.">Get</a> (<span class="keywordtype">size_t</span> n)<span class="keyword"> const</span>
<a name="l00191"></a>00191 <span class="keyword">  </span>{
<a name="l00192"></a>00192     <a class="code" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1" title="Assertion.">CS_ASSERT</a> (n &lt; elements);
<a name="l00193"></a>00193     <span class="keywordflow">return</span> *((T*)((<a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a>*)<a class="code" href="classcsRenderBufferLock.html#7bcd17c2436839c0cc9f66d8423d2c56" title="Lock the renderbuffer.">Lock</a>() + n * bufStride));
<a name="l00194"></a>00194   }
<a name="l00195"></a>00195   
<a name="l00197"></a><a class="code" href="classcsRenderBufferLock.html#7ce76286c55962281f10dae66d02e4d2">00197</a>   <span class="keywordtype">size_t</span> <a class="code" href="classcsRenderBufferLock.html#7ce76286c55962281f10dae66d02e4d2" title="Retrieve number of items in buffer.">GetSize</a>()<span class="keyword"> const</span>
<a name="l00198"></a>00198 <span class="keyword">  </span>{
<a name="l00199"></a>00199     <span class="keywordflow">return</span> buffer ? buffer-&gt;GetElementCount() : 0;
<a name="l00200"></a>00200   }
<a name="l00201"></a>00201 
<a name="l00203"></a><a class="code" href="classcsRenderBufferLock.html#5a0f0a34872f04ef744f2c0e8a058834">00203</a>   <span class="keywordtype">bool</span> <a class="code" href="classcsRenderBufferLock.html#5a0f0a34872f04ef744f2c0e8a058834" title="Returns whether the buffer is valid (ie not null).">IsValid</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> buffer.IsValid(); }
<a name="l00204"></a>00204 };
<a name="l00205"></a>00205 
<a name="l00206"></a>00206 <span class="preprocessor">#endif // __CS_CSTOOL_RBUFLOCK_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional