diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html new file mode 100644 index 00000000..89a60ff1 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html @@ -0,0 +1,216 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Pvd</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>Pvd</h1> +<p> +<div class="dynheader"> +Collaboration diagram for Pvd:</div> +<div class="dynsection"> +<center><table><tr><td><img src="group__pvd.png" border="0" alt="" usemap="#group____pvd_map"> +<map name="group____pvd_map"> +<area shape="rect" href="group__foundation.html" title="Foundation" alt="Foundation" coords="152,16,224,37"></map></td></tr></table></center> +</div> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdSceneFlag.html">PxPvdSceneFlag</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">PVD scene Flags. <a href="structPxPvdSceneFlag.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html">PxPvdSceneClient</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates. <a href="classPxPvdSceneClient.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxPvdInstrumentationFlag.html">PxPvdInstrumentationFlag</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">types of instrumentation that PVD can do. <a href="structPxPvdInstrumentationFlag.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html">PxPvd</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface...">PxPvd</a> is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application. <a href="classPxPvd.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html">PxPvdTransport</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><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="classPxPvdTransport.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacephysx.html">physx</a></td></tr> + +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a>, PxU8 > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#g23ddab69994886fb588a139635bff64b">PxPvdSceneFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. <a href="#g23ddab69994886fb588a139635bff64b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classPxFlags.html">PxFlags</a><br class="typebreak"> +< <a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede">PxPvdInstrumentationFlag::Enum</a>, <br class="typebreak"> +uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#g4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do.">PxPvdInstrumentationFlag</a>. <a href="#g4e8b7695b7145523688243b39da116c9"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_PVDSDK_API <a class="el" href="classPxPvd.html">PxPvd</a> *PX_CALL_CONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#g19c817bf23bd0d127a29d2a0e392bd6b">PxCreatePvd</a> (<a class="el" href="classPxFoundation.html">PxFoundation</a> &foundation)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pvd instance. <a href="#g19c817bf23bd0d127a29d2a0e392bd6b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_PVDSDK_API <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> <br class="typebreak"> +*PX_CALL_CONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#g919e770f1d871366dd095c94d9613314">PxDefaultPvdSocketTransportCreate</a> (const char *host, int port, unsigned int timeoutInMilliseconds)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a default socket transport. <a href="#g919e770f1d871366dd095c94d9613314"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_PVDSDK_API <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> <br class="typebreak"> +*PX_CALL_CONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pvd.html#g1a107a94b25a6bce053c3549908b8103">PxDefaultPvdFileTransportCreate</a> (const char *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a default file transport. <a href="#g1a107a94b25a6bce053c3549908b8103"></a><br></td></tr> +</table> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="g4e8b7695b7145523688243b39da116c9"></a><!-- doxytag: member="PxPvd.h::PxPvdInstrumentationFlags" ref="g4e8b7695b7145523688243b39da116c9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxPvdInstrumentationFlag.html#e5be1bcb179a96c601194126230aeede">PxPvdInstrumentationFlag::Enum</a>, uint8_t> <a class="el" href="classPxFlags.html">PxPvdInstrumentationFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do.">PxPvdInstrumentationFlag</a>. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxPvdInstrumentationFlag.html" title="types of instrumentation that PVD can do.">PxPvdInstrumentationFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g23ddab69994886fb588a139635bff64b"></a><!-- doxytag: member="PxPvdSceneClient.h::PxPvdSceneFlags" ref="g23ddab69994886fb588a139635bff64b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="classPxFlags.html">PxFlags</a><<a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a>, PxU8> <a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Bitfield that contains a set of raised flags defined in <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="g19c817bf23bd0d127a29d2a0e392bd6b"></a><!-- doxytag: member="PxPvd.h::PxCreatePvd" ref="g19c817bf23bd0d127a29d2a0e392bd6b" args="(PxFoundation &foundation)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_PVDSDK_API <a class="el" href="classPxPvd.html">PxPvd</a>* PX_CALL_CONV PxCreatePvd </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFoundation.html">PxFoundation</a> & </td> + <td class="paramname"> <em>foundation</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a pvd instance. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>foundation</em> </td><td>is the foundation instance that stores the allocator and error callbacks. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g1a107a94b25a6bce053c3549908b8103"></a><!-- doxytag: member="PxPvdTransport.h::PxDefaultPvdFileTransportCreate" ref="g1a107a94b25a6bce053c3549908b8103" args="(const char *name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_PVDSDK_API <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* PX_CALL_CONV PxDefaultPvdFileTransportCreate </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a default file transport. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>full path filename used save captured pvd data. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="g919e770f1d871366dd095c94d9613314"></a><!-- doxytag: member="PxPvdTransport.h::PxDefaultPvdSocketTransportCreate" ref="g919e770f1d871366dd095c94d9613314" args="(const char *host, int port, unsigned int timeoutInMilliseconds)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_PVDSDK_API <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* PX_CALL_CONV PxDefaultPvdSocketTransportCreate </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>host</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>timeoutInMilliseconds</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a default socket transport. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>host address of the pvd application. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>ip port used for pvd, should same as the port setting in pvd application. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>timeoutInMilliseconds</em> </td><td>timeout when connect to pvd host. </td></tr> + </table> +</dl> + +</div> +</div><p> +</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> |