aboutsummaryrefslogtreecommitdiff
path: root/docs/source_docs/files/_nv_blast_memory_8h.html
blob: 522f1e9a2ef6bfa2d80ff8cf17c1105d15ed70fd (plain) (blame)
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<html>
	<head>
		<title>NVIDIA(R) Blast(R) SDK 1.1 Source Reference: sdk/common/NvBlastMemory.h File Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="blast_logo.png">
			<br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<!-- <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; //-->
				<a class="qindex" href="annotated.html">Class List</a> &nbsp; 
				<a class="qindex" href="functions.html">Class Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>User's&nbsp;Guide</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="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>sdk/common/NvBlastMemory.h File Reference</h1><code>#include &lt;math.h&gt;</code><br>

<p>
<a href="_nv_blast_memory_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_nv.html">Nv</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_nv_1_1_blast.html">Nv::Blast</a></td></tr>

<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#b1f69315874a0e6acc5ab7f4f0f443ad">NvBlastAllocaAligned16</a>(x)&nbsp;&nbsp;&nbsp;(void*)(((uintptr_t)PxAlloca(x + 0xF) + 0xF) &amp; ~(uintptr_t)0xF)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#44bc8a89246b1e7d824a4dd3a6e08edc">NvBlastBlockArrayData</a>(_dataType, _name, _accessor, _sizeExpr)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#3421677e17b73e6e0b7e3471fe6ad542">NvBlastBlockData</a>(_dataType, _name, _accessor)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#1a2910b0e69957e23c05e09a3ceb0436">NvBlastCreateOffsetAlign16</a>(_name, _size)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#924f54aafb03fdbd5a49693119fa86c2">NvBlastCreateOffsetEndAlign16</a>()&nbsp;&nbsp;&nbsp;align16(_lastOffset + _lastSize)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_nv_blast_memory_8h.html#6405c7730b3bae832e1883093fee3d5e">NvBlastCreateOffsetStart</a>(_baseOffset)</td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">NV_INLINE T&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_nv_1_1_blast.html#c0c6da9c519d92d57c310200989092dc">Nv::Blast::align16</a> (T value)</td></tr>

<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">NV_INLINE T&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_nv_1_1_blast.html#4dec47108a96068464a694e46a0dc1a2">Nv::Blast::pointerOffset</a> (const void *p, ptrdiff_t offset)</td></tr>

<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">NV_INLINE T&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_nv_1_1_blast.html#d1e732d6cd2e5f40a0187f05820e9e7e">Nv::Blast::pointerOffset</a> (void *p, ptrdiff_t offset)</td></tr>

</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="b1f69315874a0e6acc5ab7f4f0f443ad"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastAllocaAligned16" ref="b1f69315874a0e6acc5ab7f4f0f443ad" args="(x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastAllocaAligned16          </td>
          <td>(</td>
          <td class="paramtype">x&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;(void*)(((uintptr_t)PxAlloca(x + 0xF) + 0xF) &amp; ~(uintptr_t)0xF)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stack allocation 
</div>
</div><p>
<a class="anchor" name="44bc8a89246b1e7d824a4dd3a6e08edc"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastBlockArrayData" ref="44bc8a89246b1e7d824a4dd3a6e08edc" args="(_dataType, _name, _accessor, _sizeExpr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastBlockArrayData          </td>
          <td>(</td>
          <td class="paramtype">_dataType,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_name,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_accessor,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_sizeExpr&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<b>Value:</b><div class="fragment"><pre class="fragment">_dataType* _accessor() const \
{ \
    <span class="keywordflow">return</span> (_dataType*)((uintptr_t)<span class="keyword">this</span> + _name); \
} \
uint32_t _accessor##ArraySize() const \
{ \
    <span class="keywordflow">return</span> _sizeExpr; \
} \
uint32_t _name
</pre></div>Block data offset and accessor macro for an array (includes an _accessor#ArraySize() function which returns the last expression). 
</div>
</div><p>
<a class="anchor" name="3421677e17b73e6e0b7e3471fe6ad542"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastBlockData" ref="3421677e17b73e6e0b7e3471fe6ad542" args="(_dataType, _name, _accessor)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastBlockData          </td>
          <td>(</td>
          <td class="paramtype">_dataType,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_name,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_accessor&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<b>Value:</b><div class="fragment"><pre class="fragment">_dataType* _accessor() const \
{ \
    <span class="keywordflow">return</span> (_dataType*)((uintptr_t)<span class="keyword">this</span> + _name); \
} \
uint32_t _name
</pre></div>Block data offset and accessor macro. 
</div>
</div><p>
<a class="anchor" name="1a2910b0e69957e23c05e09a3ceb0436"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastCreateOffsetAlign16" ref="1a2910b0e69957e23c05e09a3ceb0436" args="(_name, _size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastCreateOffsetAlign16          </td>
          <td>(</td>
          <td class="paramtype">_name,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">_size&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<b>Value:</b><div class="fragment"><pre class="fragment">_name = <a class="code" href="namespace_nv_1_1_blast.html#c0c6da9c519d92d57c310200989092dc">align16</a>(_lastOffset + _lastSize); \
_lastOffset = _name; \
_lastSize = _size
</pre></div>Create the next offset generation with this. The value will be aligned to a 16-byte boundary. 
</div>
</div><p>
<a class="anchor" name="924f54aafb03fdbd5a49693119fa86c2"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastCreateOffsetEndAlign16" ref="924f54aafb03fdbd5a49693119fa86c2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastCreateOffsetEndAlign16          </td>
          <td>(</td>
&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td>&nbsp;&nbsp;&nbsp;align16(_lastOffset + _lastSize)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
End offset generation with this. It evaluates to the (16-byte aligned) total size of the data block. 
</div>
</div><p>
<a class="anchor" name="6405c7730b3bae832e1883093fee3d5e"></a><!-- doxytag: member="NvBlastMemory.h::NvBlastCreateOffsetStart" ref="6405c7730b3bae832e1883093fee3d5e" args="(_baseOffset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NvBlastCreateOffsetStart          </td>
          <td>(</td>
          <td class="paramtype">_baseOffset&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordtype">size_t</span> _lastOffset = _baseOffset; \
<span class="keywordtype">size_t</span> _lastSize = 0
</pre></div>Block data offset generation macros. Start offset generation with this. 
</div>
</div><p>
</div>
<!-- start footer part -->
<div class="footer">
Copyright &copy; 2015-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</div>
</body>
</html>