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/classPxPvd.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/classPxPvd.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxPvd.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvd.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvd.html new file mode 100644 index 00000000..ea55731e --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvd.html @@ -0,0 +1,233 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvd 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>PxPvd Class Reference<br> +<small> +[<a class="el" href="group__pvd.html">Pvd</a>]</small> +</h1><!-- doxytag: class="PxPvd" --><!-- doxytag: inherits="physx::PxProfilerCallback" --><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="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxPvd_8h-source.html">PxPvd.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxPvd:</div> +<div class="dynsection"> +<p><center><img src="classPxPvd__inherit__graph.png" border="0" usemap="#PxPvd__inherit__map" alt="Inheritance graph"></center> +<map name="PxPvd__inherit__map"> +<area shape="rect" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling..." alt="physx::PxProfilerCallback" coords="7,16,161,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxPvd:</div> +<div class="dynsection"> +<p><center><img src="classPxPvd__coll__graph.png" border="0" usemap="#PxPvd__coll__map" alt="Collaboration graph"></center> +<map name="PxPvd__coll__map"> +<area shape="rect" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling..." alt="physx::PxProfilerCallback" coords="7,16,161,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxPvd-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="classPxPvd.html#23c137a2fe3c347382ea17a3b8bfa06d">connect</a> (<a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> &transport, <a class="el" href="classPxFlags.html">PxPvdInstrumentationFlags</a> flags)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#fe4f8510743ad3ac6b98ef0b94597299">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="classPxPvd.html#f6ab8818ce89858b70e6e7a868cbcf6f">isConnected</a> (bool useCachedStatus=true)=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="classPxPvd.html#bacb259344c650f6cdededbb9b9f7c27">getTransport</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxPvdInstrumentationFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#1824e29488871970252cdc2ed6bc54e5">getInstrumentationFlags</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="classPxPvd.html#43e5b5e2d72edb4a322caf6cfb55dd58">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the pvd instance. <a href="#43e5b5e2d72edb4a322caf6cfb55dd58"></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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#a96f4b9b5f46ee7447ac5eb7d9ca4f42">~PxPvd</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<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. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="a96f4b9b5f46ee7447ac5eb7d9ca4f42"></a><!-- doxytag: member="PxPvd::~PxPvd" ref="a96f4b9b5f46ee7447ac5eb7d9ca4f42" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxPvd::~PxPvd </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="23c137a2fe3c347382ea17a3b8bfa06d"></a><!-- doxytag: member="PxPvd::connect" ref="23c137a2fe3c347382ea17a3b8bfa06d" args="(PxPvdTransport &transport, PxPvdInstrumentationFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPvd::connect </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> & </td> + <td class="paramname"> <em>transport</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxPvdInstrumentationFlags</a> </td> + <td class="paramname"> <em>flags</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> +Connects the SDK to the PhysX Visual Debugger application. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>transport</em> </td><td>transport for pvd captured data. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flags to set. return True if success </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="fe4f8510743ad3ac6b98ef0b94597299"></a><!-- doxytag: member="PxPvd::disconnect" ref="fe4f8510743ad3ac6b98ef0b94597299" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvd::disconnect </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Disconnects the SDK from the PhysX Visual Debugger application. If we are still connected, this will kill the entire debugger connection. +</div> +</div><p> +<a class="anchor" name="1824e29488871970252cdc2ed6bc54e5"></a><!-- doxytag: member="PxPvd::getInstrumentationFlags" ref="1824e29488871970252cdc2ed6bc54e5" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxPvdInstrumentationFlags</a> PxPvd::getInstrumentationFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the PVD flags. See PxPvdInstrumentationFlags. +</div> +</div><p> +<a class="anchor" name="bacb259344c650f6cdededbb9b9f7c27"></a><!-- doxytag: member="PxPvd::getTransport" ref="bacb259344c650f6cdededbb9b9f7c27" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* PxPvd::getTransport </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +returns the PVD data transport returns NULL if no transport is present. +</div> +</div><p> +<a class="anchor" name="f6ab8818ce89858b70e6e7a868cbcf6f"></a><!-- doxytag: member="PxPvd::isConnected" ref="f6ab8818ce89858b70e6e7a868cbcf6f" args="(bool useCachedStatus=true)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxPvd::isConnected </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>useCachedStatus</em> = <code>true</code> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return if connection to PVD is created. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>useCachedStatus</em> </td><td>1> When useCachedStaus is false, <a class="el" href="classPxPvd.html#f6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> checks the lowlevel network status. This can be slow because it needs to lock the lowlevel network stream. If <a class="el" href="classPxPvd.html#f6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> is called frequently, the expense of locking can be significant. 2> When useCachedStatus is true, <a class="el" href="classPxPvd.html#f6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> checks the highlevel cached status with atomic access. It is faster than locking, but the status may be different from the lowlevel network with latency of up to one frame. The reason for this is that the cached status is changed inside socket listener, which is not called immediately when the lowlevel connection status changes. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="43e5b5e2d72edb4a322caf6cfb55dd58"></a><!-- doxytag: member="PxPvd::release" ref="43e5b5e2d72edb4a322caf6cfb55dd58" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvd::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases the pvd instance. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxPvd_8h-source.html">PxPvd.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> |