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] --- .../Documentation/PhysXAPI/files/group__pvd.html | 216 +++++++++++++++++++++ 1 file changed, 216 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__pvd.html') 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 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Pvd + + + + + + + +
+

Pvd

+

+

+Collaboration diagram for Pvd:
+
+
+ +Foundation
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  PxPvdSceneFlag
 PVD scene Flags. More...
class  PxPvdSceneClient
 Special client for PxScene. It provides access to the PxPvdSceneFlag. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates. More...
struct  PxPvdInstrumentationFlag
 types of instrumentation that PVD can do. More...
class  PxPvd
 PxPvd 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. More...
class  PxPvdTransport
 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...

Namespaces

namespace  physx

Typedefs

typedef PxFlags
+< PxPvdSceneFlag::Enum, PxU8 > 		PxPvdSceneFlags
 Bitfield that contains a set of raised flags defined in PxPvdSceneFlag.
typedef PxFlags
+< PxPvdInstrumentationFlag::Enum,
+uint8_t > 		PxPvdInstrumentationFlags
 Bitfield that contains a set of raised flags defined in PxPvdInstrumentationFlag.

Functions

PX_PVDSDK_API PxPvd *PX_CALL_CONV PxCreatePvd (PxFoundation &foundation)
 Create a pvd instance.
PX_PVDSDK_API PxPvdTransport
+*PX_CALL_CONV 		PxDefaultPvdSocketTransportCreate (const char *host, int port, unsigned int timeoutInMilliseconds)
 Create a default socket transport.
PX_PVDSDK_API PxPvdTransport
+*PX_CALL_CONV 		PxDefaultPvdFileTransportCreate (const char *name)
 Create a default file transport.
+

Typedef Documentation

+ +
+
+ + + + +
typedef PxFlags<PxPvdInstrumentationFlag::Enum, uint8_t> PxPvdInstrumentationFlags
+
+
+ +

+Bitfield that contains a set of raised flags defined in PxPvdInstrumentationFlag. +

+

See also:
PxPvdInstrumentationFlag
+ +
+

+ +

+
+ + + + +
typedef PxFlags<PxPvdSceneFlag::Enum, PxU8> PxPvdSceneFlags
+
+
+ +

+Bitfield that contains a set of raised flags defined in PxPvdSceneFlag. +

+

See also:
PxPvdSceneFlag
+ +
+

+

Function Documentation

+ +
+
+ + + + + + + + + +
PX_PVDSDK_API PxPvd* PX_CALL_CONV PxCreatePvd (PxFoundation &  foundation  ) 
+
+
+ +

+Create a pvd instance. +

+

Parameters:
+ + +
foundation is the foundation instance that stores the allocator and error callbacks.
+
+ +
+

+ +

+
+ + + + + + + + + +
PX_PVDSDK_API PxPvdTransport* PX_CALL_CONV PxDefaultPvdFileTransportCreate (const char *  name  ) 
+
+
+ +

+Create a default file transport. +

+

Parameters:
+ + +
name full path filename used save captured pvd data.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
PX_PVDSDK_API PxPvdTransport* PX_CALL_CONV PxDefaultPvdSocketTransportCreate (const char *  host,
int  port,
unsigned int  timeoutInMilliseconds 
)
+
+
+ +

+Create a default socket transport. +

+

Parameters:
+ + + + +
host host address of the pvd application.
port ip port used for pvd, should same as the port setting in pvd application.
timeoutInMilliseconds timeout when connect to pvd host.
+
+ +
+

+

+ +

+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