diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html new file mode 100644 index 00000000..82822f51 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html @@ -0,0 +1,267 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdTransport 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>PxPvdTransport Class Reference<br> +<small> +[<a class="el" href="group__pvd.html">Pvd</a>]</small> +</h1><!-- doxytag: class="PxPvdTransport" --><a class="el" href="classPxPvdTransport.html" title="PxPvdTransport is an interface representing the data transport mechanism. This class...">PxPvdTransport</a> is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault<...> methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are <a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface...">PxPvd</a> and PvdClient. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxPvdTransport_8h-source.html">PxPvdTransport.h</a>></code> +<p> + +<p> +<a href="classPxPvdTransport-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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#1871093d413951ee1d633d8372299162">connect</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#cf8e898a2f3b47581545e166015218b4">disconnect</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#e40dca8902fded07da0968be3eece05d">isConnected</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#0eebe29369524d988556768b0e744009">write</a> (const uint8_t *inBytes, uint32_t inLength)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#be35ed2fab8ee24cc75fa5ae4923125e">lock</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#b0b2edc04c6a7cbb45ef669e08d0e890">unlock</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#46a1dc45e8cf27e34f717ff2cb587fa6">flush</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#21db3b3932ca803b5232f34c503f4f4e">getWrittenDataSize</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#29b4aa7a8ad3566b8a4ef2839de2cfd9">release</a> ()=0</td></tr> + +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#969df5be18683a8805a24a6fa4699bc9">~PxPvdTransport</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="classPxPvdTransport.html" title="PxPvdTransport is an interface representing the data transport mechanism. This class...">PxPvdTransport</a> is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault<...> methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are <a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface...">PxPvd</a> and PvdClient. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="969df5be18683a8805a24a6fa4699bc9"></a><!-- doxytag: member="PxPvdTransport::~PxPvdTransport" ref="969df5be18683a8805a24a6fa4699bc9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxPvdTransport::~PxPvdTransport </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="1871093d413951ee1d633d8372299162"></a><!-- doxytag: member="PxPvdTransport::connect" ref="1871093d413951ee1d633d8372299162" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPvdTransport::connect </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Connects to the Visual Debugger application. return True if success +</div> +</div><p> +<a class="anchor" name="cf8e898a2f3b47581545e166015218b4"></a><!-- doxytag: member="PxPvdTransport::disconnect" ref="cf8e898a2f3b47581545e166015218b4" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdTransport::disconnect </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Disconnects from the Visual Debugger application. If we are still connected, this will kill the entire debugger connection. +</div> +</div><p> +<a class="anchor" name="46a1dc45e8cf27e34f717ff2cb587fa6"></a><!-- doxytag: member="PxPvdTransport::flush" ref="46a1dc45e8cf27e34f717ff2cb587fa6" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdTransport::flush </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +send any data and block until we know it is at least on the wire. +</div> +</div><p> +<a class="anchor" name="21db3b3932ca803b5232f34c503f4f4e"></a><!-- doxytag: member="PxPvdTransport::getWrittenDataSize" ref="21db3b3932ca803b5232f34c503f4f4e" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint64_t PxPvdTransport::getWrittenDataSize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return size of written data. +</div> +</div><p> +<a class="anchor" name="e40dca8902fded07da0968be3eece05d"></a><!-- doxytag: member="PxPvdTransport::isConnected" ref="e40dca8902fded07da0968be3eece05d" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPvdTransport::isConnected </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return if connection to PVD is created. +</div> +</div><p> +<a class="anchor" name="be35ed2fab8ee24cc75fa5ae4923125e"></a><!-- doxytag: member="PxPvdTransport::lock" ref="be35ed2fab8ee24cc75fa5ae4923125e" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>& PxPvdTransport::lock </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="29b4aa7a8ad3566b8a4ef2839de2cfd9"></a><!-- doxytag: member="PxPvdTransport::release" ref="29b4aa7a8ad3566b8a4ef2839de2cfd9" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdTransport::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b0b2edc04c6a7cbb45ef669e08d0e890"></a><!-- doxytag: member="PxPvdTransport::unlock" ref="b0b2edc04c6a7cbb45ef669e08d0e890" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdTransport::unlock </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="0eebe29369524d988556768b0e744009"></a><!-- doxytag: member="PxPvdTransport::write" ref="0eebe29369524d988556768b0e744009" args="(const uint8_t *inBytes, uint32_t inLength)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPvdTransport::write </td> + <td>(</td> + <td class="paramtype">const uint8_t * </td> + <td class="paramname"> <em>inBytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>inLength</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> +write bytes to the other endpoint of the connection. should lock before witre. If an error occurs this connection will assume to be dead. +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxPvdTransport_8h-source.html">PxPvdTransport.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 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> |