From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxPvdTransport.html | 267 +++++++++++++++++++++ 1 file changed, 267 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdTransport.html') 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 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdTransport Class Reference + + + + + + + +
+

PxPvdTransport Class Reference
+ +[Pvd] +

PxPvdTransport 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 PxPvd and PvdClient. +More... +

+#include <PxPvdTransport.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual bool connect ()=0
virtual void disconnect ()=0
virtual bool isConnected ()=0
virtual bool write (const uint8_t *inBytes, uint32_t inLength)=0
virtual PxPvdTransport & lock ()=0
virtual void unlock ()=0
virtual void flush ()=0
virtual uint64_t getWrittenDataSize ()=0
virtual void release ()=0

Protected Member Functions

virtual ~PxPvdTransport ()
+

Detailed Description

+PxPvdTransport 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 PxPvd and PvdClient.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
virtual PxPvdTransport::~PxPvdTransport (  )  [inline, protected, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual bool PxPvdTransport::connect (  )  [pure virtual]
+
+
+ +

+Connects to the Visual Debugger application. return True if success +

+

+ +

+
+ + + + + + + + +
virtual void PxPvdTransport::disconnect (  )  [pure virtual]
+
+
+ +

+Disconnects from the Visual Debugger application. If we are still connected, this will kill the entire debugger connection. +

+

+ +

+
+ + + + + + + + +
virtual void PxPvdTransport::flush (  )  [pure virtual]
+
+
+ +

+send any data and block until we know it is at least on the wire. +

+

+ +

+
+ + + + + + + + +
virtual uint64_t PxPvdTransport::getWrittenDataSize (  )  [pure virtual]
+
+
+ +

+Return size of written data. +

+

+ +

+
+ + + + + + + + +
virtual bool PxPvdTransport::isConnected (  )  [pure virtual]
+
+
+ +

+Return if connection to PVD is created. +

+

+ +

+
+ + + + + + + + +
virtual PxPvdTransport& PxPvdTransport::lock (  )  [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual void PxPvdTransport::release (  )  [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual void PxPvdTransport::unlock (  )  [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual bool PxPvdTransport::write (const uint8_t *  inBytes,
uint32_t  inLength 
) [pure virtual]
+
+
+ +

+write bytes to the other endpoint of the connection. should lock before witre. If an error occurs this connection will assume to be dead. +

+

+

The documentation for this class was generated from the following file: +
+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3