physx::PxMutexT< Alloc > Class Template Reference

Inheritance diagram for physx::PxMutexT< Alloc >:

Collaboration diagram for physx::PxMutexT< Alloc >:

Classes
class	ScopedLock

Public Member Functions
	PxMutexT (const Alloc &alloc=Alloc())
	~PxMutexT ()
PX_FORCE_INLINE void	lock () const
PX_FORCE_INLINE bool	trylock () const
PX_FORCE_INLINE void	unlock () const

Additional Inherited Members
Protected Member Functions inherited from physx::PxReflectionAllocator< T >
	PxReflectionAllocator (const PxEMPTY)
	PxReflectionAllocator (const char *=0)
	PxReflectionAllocator (const PxReflectionAllocator &)
PX_FORCE_INLINE void *	allocate (size_t size, const char *filename, int line)
PX_FORCE_INLINE void	deallocate (void *ptr)

Constructor & Destructor Documentation

PxMutexT()

template<typename Alloc = PxReflectionAllocator<PxMutexImpl>>

physx::PxMutexT< Alloc >::PxMutexT ( const Alloc &  alloc = Alloc() )

inline

The constructor for Mutex creates a mutex. It is initially unlocked.

~PxMutexT()

template<typename Alloc = PxReflectionAllocator<PxMutexImpl>>

physx::PxMutexT< Alloc >::~PxMutexT ( )

inline

The destructor for Mutex deletes the mutex.

Member Function Documentation

lock()

template<typename Alloc = PxReflectionAllocator<PxMutexImpl>>

PX_FORCE_INLINE void physx::PxMutexT< Alloc >::lock ( ) const

inline

Acquire (lock) the mutex. If the mutex is already locked by another thread, this method blocks until the mutex is unlocked.

trylock()

template<typename Alloc = PxReflectionAllocator<PxMutexImpl>>

PX_FORCE_INLINE bool physx::PxMutexT< Alloc >::trylock ( ) const

inline

Acquire (lock) the mutex. If the mutex is already locked by another thread, this method returns false without blocking, returns true if lock is successfully acquired

unlock()

template<typename Alloc = PxReflectionAllocator<PxMutexImpl>>

PX_FORCE_INLINE void physx::PxMutexT< Alloc >::unlock ( ) const

inline

Release (unlock) the mutex, the calling thread must have previously called lock() or method will error

---

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

• RavEngine/deps/physx/physx/include/foundation/PxMutex.h