RavEngine
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
physx::PxSyncImpl Class Reference

#include <PxSync.h>

Public Member Functions

bool wait (uint32_t milliseconds=waitForever)
 
void set ()
 
void reset ()
 

Static Public Member Functions

static uint32_t getSize ()
 

Static Public Attributes

static const uint32_t waitForever = 0xffffffff
 

Detailed Description

Implementation notes:

  • Calling set() on an already signaled Sync does not change its state.
  • Calling reset() on an already reset Sync does not change its state.
  • Calling set() on a reset Sync wakes all waiting threads (potential for thread contention).
  • Calling wait() on an already signaled Sync will return true immediately.
  • NOTE: be careful when pulsing an event with set() followed by reset(), because a thread that is not waiting on the event will miss the signal.

Member Function Documentation

◆ getSize()

uint32_t physx::PxSyncImpl::getSize ( )
static

Size of this class.

◆ reset()

void physx::PxSyncImpl::reset ( )

Reset the synchronization object

◆ set()

void physx::PxSyncImpl::set ( )

Signal the synchronization object, waking all threads waiting on it

◆ wait()

bool physx::PxSyncImpl::wait ( uint32_t  milliseconds = waitForever)

Wait on the object for at most the given number of ms. Returns true if the object is signaled. Sync::waitForever will block forever or until the object is signaled.

The documentation for this class was generated from the following files: