1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5 6<title>rs_allocation.rsh File Reference</title> 7<link href="tabs.css" rel="stylesheet" type="text/css"/> 8<link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 10 11 12</head> 13<body> 14<div id="top"><!-- do not remove this div! --> 15 16 17<!-- Generated by Doxygen 1.7.5.1 --> 18 <div id="navrow1" class="tabs"> 19 <ul class="tablist"> 20 <li><a href="index.html"><span>Overview</span></a></li> 21 <li class="current"><a href="globals.html"><span>Globals</span></a></li> 22 <li><a href="annotated.html"><span>Structs</span></a></li> 23 </ul> 24 </div> 25</div> 26<div class="header"> 27 <div class="summary"> 28<a href="#func-members">Functions</a> </div> 29 <div class="headertitle"> 30<div class="title">rs_allocation.rsh File Reference</div> </div> 31</div> 32<div class="contents"> 33<table class="memberdecls"> 34<tr><td colspan="2"><h2><a name="func-members"></a> 35Functions</h2></td></tr> 36<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#aadad7654929c451be299df125061c9ba">rsGetAllocation</a> (const void *)</td></tr> 37<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#a3ca7f505a97d5b7f477bc65b9e77dafb">rsAllocationGetDimX</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>)</td></tr> 38<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#ac889b866b465580eb313e5d2a9fcac3d">rsAllocationGetDimY</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>)</td></tr> 39<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#acd6f1a2b2443e6ea39e6154577645d2c">rsAllocationGetDimZ</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>)</td></tr> 40<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#ac42a07c079d6b3c6bb21975170d4e11c">rsAllocationGetDimLOD</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>)</td></tr> 41<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#ac85f7ed88f38b35482c6d63b56d470fe">rsAllocationGetDimFaces</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>)</td></tr> 42<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#a3fd30b4388748601e025bb3566ce0cbc">rsGetElementAt</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> x)</td></tr> 43<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#a7e0a1753a930557f6dc87f25ed3fd23b">rsGetElementAt</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> x, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> y)</td></tr> 44<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="rs__allocation_8rsh.html#a049ba2f6e6e18d47f2267474b2092822">rsGetElementAt</a> (<a class="el" href="structrs__allocation.html">rs_allocation</a>, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> x, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> y, <a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> z)</td></tr> 45</table> 46<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 47<div class="textblock"><p>Allocation routines. </p> 48 49<p>Definition in file <a class="el" href="rs__allocation_8rsh_source.html">rs_allocation.rsh</a>.</p> 50</div><hr/><h2>Function Documentation</h2> 51<a class="anchor" id="ac85f7ed88f38b35482c6d63b56d470fe"></a><!-- doxytag: member="rs_allocation.rsh::rsAllocationGetDimFaces" ref="ac85f7ed88f38b35482c6d63b56d470fe" args="(rs_allocation)" --> 52<div class="memitem"> 53<div class="memproto"> 54 <table class="memname"> 55 <tr> 56 <td class="memname"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> rsAllocationGetDimFaces </td> 57 <td>(</td> 58 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 59 <td class="paramname"></td><td>)</td> 60 <td></td> 61 </tr> 62 </table> 63</div> 64<div class="memdoc"> 65<p>Query an allocation for the presence of more than one face.</p> 66<dl class="return"><dt><b>Returns:</b></dt><dd>uint32_t Returns 1 if more than one face is present, 0 otherwise. </dd></dl> 67 68</div> 69</div> 70<a class="anchor" id="ac42a07c079d6b3c6bb21975170d4e11c"></a><!-- doxytag: member="rs_allocation.rsh::rsAllocationGetDimLOD" ref="ac42a07c079d6b3c6bb21975170d4e11c" args="(rs_allocation)" --> 71<div class="memitem"> 72<div class="memproto"> 73 <table class="memname"> 74 <tr> 75 <td class="memname"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> rsAllocationGetDimLOD </td> 76 <td>(</td> 77 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 78 <td class="paramname"></td><td>)</td> 79 <td></td> 80 </tr> 81 </table> 82</div> 83<div class="memdoc"> 84<p>Query an allocation for the presence of more than one LOD.</p> 85<dl class="return"><dt><b>Returns:</b></dt><dd>uint32_t Returns 1 if more than one LOD is present, 0 otherwise. </dd></dl> 86 87</div> 88</div> 89<a class="anchor" id="a3ca7f505a97d5b7f477bc65b9e77dafb"></a><!-- doxytag: member="rs_allocation.rsh::rsAllocationGetDimX" ref="a3ca7f505a97d5b7f477bc65b9e77dafb" args="(rs_allocation)" --> 90<div class="memitem"> 91<div class="memproto"> 92 <table class="memname"> 93 <tr> 94 <td class="memname"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> rsAllocationGetDimX </td> 95 <td>(</td> 96 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 97 <td class="paramname"></td><td>)</td> 98 <td></td> 99 </tr> 100 </table> 101</div> 102<div class="memdoc"> 103<p>Query the dimension of an allocation.</p> 104<dl class="return"><dt><b>Returns:</b></dt><dd>uint32_t The X dimension of the allocation. </dd></dl> 105 106</div> 107</div> 108<a class="anchor" id="ac889b866b465580eb313e5d2a9fcac3d"></a><!-- doxytag: member="rs_allocation.rsh::rsAllocationGetDimY" ref="ac889b866b465580eb313e5d2a9fcac3d" args="(rs_allocation)" --> 109<div class="memitem"> 110<div class="memproto"> 111 <table class="memname"> 112 <tr> 113 <td class="memname"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> rsAllocationGetDimY </td> 114 <td>(</td> 115 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 116 <td class="paramname"></td><td>)</td> 117 <td></td> 118 </tr> 119 </table> 120</div> 121<div class="memdoc"> 122<p>Query the dimension of an allocation.</p> 123<dl class="return"><dt><b>Returns:</b></dt><dd>uint32_t The Y dimension of the allocation. </dd></dl> 124 125</div> 126</div> 127<a class="anchor" id="acd6f1a2b2443e6ea39e6154577645d2c"></a><!-- doxytag: member="rs_allocation.rsh::rsAllocationGetDimZ" ref="acd6f1a2b2443e6ea39e6154577645d2c" args="(rs_allocation)" --> 128<div class="memitem"> 129<div class="memproto"> 130 <table class="memname"> 131 <tr> 132 <td class="memname"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> rsAllocationGetDimZ </td> 133 <td>(</td> 134 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 135 <td class="paramname"></td><td>)</td> 136 <td></td> 137 </tr> 138 </table> 139</div> 140<div class="memdoc"> 141<p>Query the dimension of an allocation.</p> 142<dl class="return"><dt><b>Returns:</b></dt><dd>uint32_t The Z dimension of the allocation. </dd></dl> 143 144</div> 145</div> 146<a class="anchor" id="aadad7654929c451be299df125061c9ba"></a><!-- doxytag: member="rs_allocation.rsh::rsGetAllocation" ref="aadad7654929c451be299df125061c9ba" args="(const void *)" --> 147<div class="memitem"> 148<div class="memproto"> 149 <table class="memname"> 150 <tr> 151 <td class="memname"><a class="el" href="structrs__allocation.html">rs_allocation</a> rsGetAllocation </td> 152 <td>(</td> 153 <td class="paramtype">const void * </td> 154 <td class="paramname"></td><td>)</td> 155 <td></td> 156 </tr> 157 </table> 158</div> 159<div class="memdoc"> 160<p>Returns the Allocation for a given pointer. The pointer should point within a valid allocation. The results are undefined if the pointer is not from a valid allocation. </p> 161 162</div> 163</div> 164<a class="anchor" id="a3fd30b4388748601e025bb3566ce0cbc"></a><!-- doxytag: member="rs_allocation.rsh::rsGetElementAt" ref="a3fd30b4388748601e025bb3566ce0cbc" args="(rs_allocation, uint32_t x)" --> 165<div class="memitem"> 166<div class="memproto"> 167 <table class="memname"> 168 <tr> 169 <td class="memname">const void* rsGetElementAt </td> 170 <td>(</td> 171 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 172 <td class="paramname">, </td> 173 </tr> 174 <tr> 175 <td class="paramkey"></td> 176 <td></td> 177 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 178 <td class="paramname"><em>x</em> </td> 179 </tr> 180 <tr> 181 <td></td> 182 <td>)</td> 183 <td></td><td></td> 184 </tr> 185 </table> 186</div> 187<div class="memdoc"> 188<p>Extract a single element from an allocation. </p> 189 190</div> 191</div> 192<a class="anchor" id="a7e0a1753a930557f6dc87f25ed3fd23b"></a><!-- doxytag: member="rs_allocation.rsh::rsGetElementAt" ref="a7e0a1753a930557f6dc87f25ed3fd23b" args="(rs_allocation, uint32_t x, uint32_t y)" --> 193<div class="memitem"> 194<div class="memproto"> 195 <table class="memname"> 196 <tr> 197 <td class="memname">const void* rsGetElementAt </td> 198 <td>(</td> 199 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 200 <td class="paramname">, </td> 201 </tr> 202 <tr> 203 <td class="paramkey"></td> 204 <td></td> 205 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 206 <td class="paramname"><em>x</em>, </td> 207 </tr> 208 <tr> 209 <td class="paramkey"></td> 210 <td></td> 211 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 212 <td class="paramname"><em>y</em> </td> 213 </tr> 214 <tr> 215 <td></td> 216 <td>)</td> 217 <td></td><td></td> 218 </tr> 219 </table> 220</div> 221<div class="memdoc"> 222<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> 223 224</div> 225</div> 226<a class="anchor" id="a049ba2f6e6e18d47f2267474b2092822"></a><!-- doxytag: member="rs_allocation.rsh::rsGetElementAt" ref="a049ba2f6e6e18d47f2267474b2092822" args="(rs_allocation, uint32_t x, uint32_t y, uint32_t z)" --> 227<div class="memitem"> 228<div class="memproto"> 229 <table class="memname"> 230 <tr> 231 <td class="memname">const void* rsGetElementAt </td> 232 <td>(</td> 233 <td class="paramtype"><a class="el" href="structrs__allocation.html">rs_allocation</a> </td> 234 <td class="paramname">, </td> 235 </tr> 236 <tr> 237 <td class="paramkey"></td> 238 <td></td> 239 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 240 <td class="paramname"><em>x</em>, </td> 241 </tr> 242 <tr> 243 <td class="paramkey"></td> 244 <td></td> 245 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 246 <td class="paramname"><em>y</em>, </td> 247 </tr> 248 <tr> 249 <td class="paramkey"></td> 250 <td></td> 251 <td class="paramtype"><a class="el" href="rs__types_8rsh.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> </td> 252 <td class="paramname"><em>z</em> </td> 253 </tr> 254 <tr> 255 <td></td> 256 <td>)</td> 257 <td></td><td></td> 258 </tr> 259 </table> 260</div> 261<div class="memdoc"> 262<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> 263 264</div> 265</div> 266</div> 267 268</body> 269</html> 270