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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBinaryConverter Class 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="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxBinaryConverter Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxBinaryConverter" -->Binary converter for serialized streams.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxBinaryConverter_8h-source.html">PxBinaryConverter.h</a>></code>
<p>
<p>
<a href="classPxBinaryConverter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#c45504933db13e78c7dd12e68fab304f">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases binary converter. <a href="#c45504933db13e78c7dd12e68fab304f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#ba26eda3b46071eca65fa38cabee2a09">setReportMode</a> (<a class="el" href="structPxConverterReportMode.html#abe051209d39df379f39bbe45bf4f1a3">PxConverterReportMode::Enum</a> mode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets desired report mode. <a href="#ba26eda3b46071eca65fa38cabee2a09"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#475c6a6dc11b63b3570f2fc5d21b5c0e">setMetaData</a> (<a class="el" href="classPxInputStream.html">PxInputStream</a> &srcMetaData, <a class="el" href="classPxInputStream.html">PxInputStream</a> &dstMetaData)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setups source and target meta-data streams. <a href="#475c6a6dc11b63b3570f2fc5d21b5c0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#c39cc433f7d1db69e1c17e401adec9cc">compareMetaData</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test utility function to compare two sets of meta data. <a href="#c39cc433f7d1db69e1c17e401adec9cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#9890d7f61fceb47d154e203291cd08fd">convert</a> (<a class="el" href="classPxInputStream.html">PxInputStream</a> &srcStream, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> srcSize, <a class="el" href="classPxOutputStream.html">PxOutputStream</a> &targetStream)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts binary stream from source platform to target platform. <a href="#9890d7f61fceb47d154e203291cd08fd"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#76e9b36969e46ef131f22d2d95aa31cb">PxBinaryConverter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#30333f47d0897b3728442e915eaaba81">~PxBinaryConverter</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Binary converter for serialized streams.
<p>
The binary converter class is targeted at converting binary streams from authoring platforms, such as windows, osx or linux to any game runtime platform supported by PhysX. Particularly it is currently not supported to run the converter on a platforms that has an endian mismatch with the platform corresponding to the source binary file and source meta data.<p>
If you want to use multiple threads for batch conversions, please create one instance of this class for each thread.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSerialization.html#9014b476bfd9e3e9bc7ea755df232bfd" title="Creates binary converter for re-targeting binary-serialized data.">PxSerialization.createBinaryConverter</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="76e9b36969e46ef131f22d2d95aa31cb"></a><!-- doxytag: member="PxBinaryConverter::PxBinaryConverter" ref="76e9b36969e46ef131f22d2d95aa31cb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxBinaryConverter::PxBinaryConverter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="30333f47d0897b3728442e915eaaba81"></a><!-- doxytag: member="PxBinaryConverter::~PxBinaryConverter" ref="30333f47d0897b3728442e915eaaba81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxBinaryConverter::~PxBinaryConverter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c39cc433f7d1db69e1c17e401adec9cc"></a><!-- doxytag: member="PxBinaryConverter::compareMetaData" ref="c39cc433f7d1db69e1c17e401adec9cc" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxBinaryConverter::compareMetaData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test utility function to compare two sets of meta data.
<p>
The meta data needs to be set before calling the compareMetaData method. This method will issue <a class="el" href="structPxErrorCode.html#01157d5d2eca2cede61ecbbc32c7b2a3b822d9fb3b06cb1032cc65da86bef532" title="An informational message.">PxErrorCode::eDEBUG_INFO</a> messages if mismatches are encountered.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if meta data is equivalend </dd></dl>
</div>
</div><p>
<a class="anchor" name="9890d7f61fceb47d154e203291cd08fd"></a><!-- doxytag: member="PxBinaryConverter::convert" ref="9890d7f61fceb47d154e203291cd08fd" args="(PxInputStream &srcStream, PxU32 srcSize, PxOutputStream &targetStream)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxBinaryConverter::convert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td>
<td class="paramname"> <em>srcStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>srcSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> & </td>
<td class="paramname"> <em>targetStream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Converts binary stream from source platform to target platform.
<p>
The converter needs to be configured with source and destination meta data before calling the conversion method. The source meta data needs to correspond to the same platform as the source binary data.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcStream</em> </td><td>Source stream </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcSize</em> </td><td>Number of bytes to convert </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>targetStream</em> </td><td>Target stream</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl>
</div>
</div><p>
<a class="anchor" name="c45504933db13e78c7dd12e68fab304f"></a><!-- doxytag: member="PxBinaryConverter::release" ref="c45504933db13e78c7dd12e68fab304f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxBinaryConverter::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases binary converter.
<p>
</div>
</div><p>
<a class="anchor" name="475c6a6dc11b63b3570f2fc5d21b5c0e"></a><!-- doxytag: member="PxBinaryConverter::setMetaData" ref="475c6a6dc11b63b3570f2fc5d21b5c0e" args="(PxInputStream &srcMetaData, PxInputStream &dstMetaData)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxBinaryConverter::setMetaData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td>
<td class="paramname"> <em>srcMetaData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td>
<td class="paramname"> <em>dstMetaData</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Setups source and target meta-data streams.
<p>
The source meta data provided needs to have the same endianness as the platform the converter is run on. The meta data needs to be set before calling the conversion method.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcMetaData</em> </td><td>Source platform's meta-data stream </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dstMetaData</em> </td><td>Target platform's meta-data stream</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl>
</div>
</div><p>
<a class="anchor" name="ba26eda3b46071eca65fa38cabee2a09"></a><!-- doxytag: member="PxBinaryConverter::setReportMode" ref="ba26eda3b46071eca65fa38cabee2a09" args="(PxConverterReportMode::Enum mode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxBinaryConverter::setReportMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPxConverterReportMode.html#abe051209d39df379f39bbe45bf4f1a3">PxConverterReportMode::Enum</a> </td>
<td class="paramname"> <em>mode</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets desired report mode.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>mode</em> </td><td>Report mode </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxBinaryConverter_8h-source.html">PxBinaryConverter.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 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>
</body>
</html>
|