Defined in include/pvd/PxPvd.h

Inheritance Relationships

Base Type

  • public PxProfilerCallback

class PxPvd : public PxProfilerCallback

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.

Public Functions

virtual bool connect(PxPvdTransport &transport, PxPvdInstrumentationFlags flags) = 0

Connects the SDK to the PhysX Visual Debugger application.

  • transport – transport for pvd captured data.

  • flags – Flags to set. return True if success

virtual void disconnect() = 0

Disconnects the SDK from the PhysX Visual Debugger application.

If we are still connected, this will kill the entire debugger connection.

virtual bool isConnected(bool useCachedStatus = true) = 0

Return if connection to PVD is created.


useCachedStatus – 1> When useCachedStaus is false, isConnected() checks the lowlevel network status. This can be slow because it needs to lock the lowlevel network stream. If isConnected() is called frequently, the expense of locking can be significant. 2> When useCachedStatus is true, isConnected() 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.

virtual PxPvdTransport *getTransport() = 0

returns the PVD data transport returns NULL if no transport is present.

virtual PxPvdInstrumentationFlags getInstrumentationFlags() = 0

Retrieves the PVD flags.

See PxPvdInstrumentationFlags.

virtual void release() = 0

Releases the pvd instance.

Protected Functions

inline virtual ~PxPvd()