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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxInputStream 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>PxInputStream Class Reference<br>
<small>
[<a class="el" href="group__common.html">Common</a>]</small>
</h1><!-- doxytag: class="PxInputStream" -->Input stream class for I/O.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxIO_8h-source.html">PxIO.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxInputStream:</div>
<div class="dynsection">
<p><center><img src="classPxInputStream__inherit__graph.png" border="0" usemap="#PxInputStream__inherit__map" alt="Inheritance graph"></center>
<map name="PxInputStream__inherit__map">
<area shape="rect" href="classPxInputData.html" title="Input data class for I/O which provides random read access." alt="PxInputData" coords="125,85,205,106"><area shape="rect" href="classPxDefaultFileInputData.html" title="default implementation of a file read stream" alt="PxDefaultFileInputData" coords="7,154,148,176"><area shape="rect" href="classPxDefaultMemoryInputData.html" title="default implementation of a memory read stream" alt="PxDefaultMemoryInputData" coords="172,154,337,176"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxInputStream-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 uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputStream.html#74fdc1e5af87577e7cc13cc99894b2b3">read</a> (void *dest, uint32_t count)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read from the stream. The number of bytes read may be less than the number requested. <a href="#74fdc1e5af87577e7cc13cc99894b2b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputStream.html#e9bbfe54d3bd96668f6dd19b30737e26">~PxInputStream</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Input stream class for I/O.
<p>
The user needs to supply a <a class="el" href="classPxInputStream.html" title="Input stream class for I/O.">PxInputStream</a> implementation to a number of methods to allow the SDK to read data. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e9bbfe54d3bd96668f6dd19b30737e26"></a><!-- doxytag: member="PxInputStream::~PxInputStream" ref="e9bbfe54d3bd96668f6dd19b30737e26" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxInputStream::~PxInputStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="74fdc1e5af87577e7cc13cc99894b2b3"></a><!-- doxytag: member="PxInputStream::read" ref="74fdc1e5af87577e7cc13cc99894b2b3" args="(void *dest, uint32_t count)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t PxInputStream::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>count</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>
read from the stream. The number of bytes read may be less than the number requested.
<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>dest</em> </td><td>the destination address to which the data will be read </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>count</em> </td><td>the number of bytes requested</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes read from the stream. </dd></dl>
<p>Implemented in <a class="el" href="classPxDefaultMemoryInputData.html#f668db47bc18351643ae6a78820d014c">PxDefaultMemoryInputData</a>, and <a class="el" href="classPxDefaultFileInputData.html#53cec0da0055e7a996c6d85dd9ab427b">PxDefaultFileInputData</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxIO_8h-source.html">PxIO.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>
|