Files
PhysX4.1/physx/documentation/PhysXAPI/files/classPxDefaultMemoryInputData.html
2025-11-28 23:13:44 +05:30

408 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxDefaultMemoryInputData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxDefaultMemoryInputData.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPxDefaultMemoryInputData-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxDefaultMemoryInputData Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>default implementation of a memory read stream
<a href="classPxDefaultMemoryInputData.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxDefaultStreams_8h_source.html">PxDefaultStreams.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxDefaultMemoryInputData:</div>
<div class="dyncontent">
<div class="center"><img src="classPxDefaultMemoryInputData__inherit__graph.png" border="0" usemap="#PxDefaultMemoryInputData_inherit__map" alt="Inheritance graph"/></div>
<map name="PxDefaultMemoryInputData_inherit__map" id="PxDefaultMemoryInputData_inherit__map">
<area shape="rect" id="node2" href="classPxInputData.html" title="Input data class for I/O which provides random read access. " alt="" coords="49,80,142,107"/>
<area shape="rect" id="node3" href="classPxInputStream.html" title="Input stream class for I/O. " alt="" coords="41,5,149,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxDefaultMemoryInputData:</div>
<div class="dyncontent">
<div class="center"><img src="classPxDefaultMemoryInputData__coll__graph.png" border="0" usemap="#PxDefaultMemoryInputData_coll__map" alt="Collaboration graph"/></div>
<map name="PxDefaultMemoryInputData_coll__map" id="PxDefaultMemoryInputData_coll__map">
<area shape="rect" id="node2" href="classPxInputData.html" title="Input data class for I/O which provides random read access. " alt="" coords="49,80,142,107"/>
<area shape="rect" id="node3" href="classPxInputStream.html" title="Input stream class for I/O. " alt="" coords="41,5,149,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac8fb2f18c72eeac8eddcd2e018705de4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#ac8fb2f18c72eeac8eddcd2e018705de4">PxDefaultMemoryInputData</a> (PxU8 *data, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> length)</td></tr>
<tr class="separator:ac8fb2f18c72eeac8eddcd2e018705de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af668db47bc18351643ae6a78820d014c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#af668db47bc18351643ae6a78820d014c">read</a> (void *dest, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> count)</td></tr>
<tr class="memdesc:af668db47bc18351643ae6a78820d014c"><td class="mdescLeft">&#160;</td><td class="mdescRight">read from the stream. The number of bytes read may be less than the number requested. <a href="#af668db47bc18351643ae6a78820d014c">More...</a><br /></td></tr>
<tr class="separator:af668db47bc18351643ae6a78820d014c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c286611150b45e7a40005ba39faeeea"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#a8c286611150b45e7a40005ba39faeeea">getLength</a> () const</td></tr>
<tr class="memdesc:a8c286611150b45e7a40005ba39faeeea"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the length of the input data <a href="#a8c286611150b45e7a40005ba39faeeea">More...</a><br /></td></tr>
<tr class="separator:a8c286611150b45e7a40005ba39faeeea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7344d413c8bdf97731fd63d06ba26b54"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#a7344d413c8bdf97731fd63d06ba26b54">seek</a> (<a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> pos)</td></tr>
<tr class="memdesc:a7344d413c8bdf97731fd63d06ba26b54"><td class="mdescLeft">&#160;</td><td class="mdescRight">seek to the given offset from the start of the data. <a href="#a7344d413c8bdf97731fd63d06ba26b54">More...</a><br /></td></tr>
<tr class="separator:a7344d413c8bdf97731fd63d06ba26b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade8d997f98d1f6deff7311637ac140a9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#ade8d997f98d1f6deff7311637ac140a9">tell</a> () const</td></tr>
<tr class="memdesc:ade8d997f98d1f6deff7311637ac140a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the current offset from the start of the data <a href="#ade8d997f98d1f6deff7311637ac140a9">More...</a><br /></td></tr>
<tr class="separator:ade8d997f98d1f6deff7311637ac140a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxInputData"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxInputData')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxInputData.html">PxInputData</a></td></tr>
<tr class="memitem:ae82db2806183495ecc5b22adc3386b3a inherit pub_methods_classPxInputData"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#ae82db2806183495ecc5b22adc3386b3a">~PxInputData</a> ()</td></tr>
<tr class="separator:ae82db2806183495ecc5b22adc3386b3a inherit pub_methods_classPxInputData"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxInputStream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxInputStream')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxInputStream.html">PxInputStream</a></td></tr>
<tr class="memitem:ae9bbfe54d3bd96668f6dd19b30737e26 inherit pub_methods_classPxInputStream"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputStream.html#ae9bbfe54d3bd96668f6dd19b30737e26">~PxInputStream</a> ()</td></tr>
<tr class="separator:ae9bbfe54d3bd96668f6dd19b30737e26 inherit pub_methods_classPxInputStream"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a5d64ba75b217d982a1b8b589c0231977"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#a5d64ba75b217d982a1b8b589c0231977">mSize</a></td></tr>
<tr class="separator:a5d64ba75b217d982a1b8b589c0231977"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a247c643f455325808808536711001d8e"><td class="memItemLeft" align="right" valign="top">const PxU8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#a247c643f455325808808536711001d8e">mData</a></td></tr>
<tr class="separator:a247c643f455325808808536711001d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d0fc8bcea095380c4fc2fc8af51510f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#a7d0fc8bcea095380c4fc2fc8af51510f">mPos</a></td></tr>
<tr class="separator:a7d0fc8bcea095380c4fc2fc8af51510f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>default implementation of a memory read stream </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access. ">PxInputData</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac8fb2f18c72eeac8eddcd2e018705de4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8fb2f18c72eeac8eddcd2e018705de4">&#9670;&nbsp;</a></span>PxDefaultMemoryInputData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxDefaultMemoryInputData::PxDefaultMemoryInputData </td>
<td>(</td>
<td class="paramtype">PxU8 *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8c286611150b45e7a40005ba39faeeea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c286611150b45e7a40005ba39faeeea">&#9670;&nbsp;</a></span>getLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::getLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return the length of the input data </p>
<dl class="section return"><dt>Returns</dt><dd>size in bytes of the input data </dd></dl>
<p>Implements <a class="el" href="classPxInputData.html#abab049ab736da6c5880426f3d977698b">PxInputData</a>.</p>
</div>
</div>
<a id="af668db47bc18351643ae6a78820d014c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af668db47bc18351643ae6a78820d014c">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::read </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dest</td><td>the destination address to which the data will be read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>the number of bytes requested</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read from the stream. </dd></dl>
<p>Implements <a class="el" href="classPxInputStream.html#a74fdc1e5af87577e7cc13cc99894b2b3">PxInputStream</a>.</p>
</div>
</div>
<a id="a7344d413c8bdf97731fd63d06ba26b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7344d413c8bdf97731fd63d06ba26b54">&#9670;&nbsp;</a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void PxDefaultMemoryInputData::seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>seek to the given offset from the start of the data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the offset to seek to. If greater than the length of the data, this call is equivalent to seek(length); </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classPxInputData.html#ac80d55021a6bae02a1cc64d27a98c575">PxInputData</a>.</p>
</div>
</div>
<a id="ade8d997f98d1f6deff7311637ac140a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8d997f98d1f6deff7311637ac140a9">&#9670;&nbsp;</a></span>tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::tell </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return the current offset from the start of the data </p>
<dl class="section return"><dt>Returns</dt><dd>the offset to seek to. </dd></dl>
<p>Implements <a class="el" href="classPxInputData.html#a5ce54bcfb43ca0e9dd22bf15fcf75cab">PxInputData</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a247c643f455325808808536711001d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a247c643f455325808808536711001d8e">&#9670;&nbsp;</a></span>mData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const PxU8* PxDefaultMemoryInputData::mData</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7d0fc8bcea095380c4fc2fc8af51510f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d0fc8bcea095380c4fc2fc8af51510f">&#9670;&nbsp;</a></span>mPos</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::mPos</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5d64ba75b217d982a1b8b589c0231977"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d64ba75b217d982a1b8b589c0231977">&#9670;&nbsp;</a></span>mSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::mSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxDefaultStreams_8h_source.html">PxDefaultStreams.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPxDefaultMemoryInputData.html">PxDefaultMemoryInputData</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>