physx::shdfnd::MutexT< Alloc > Class Template Reference
#include <PsMutex.h>
Inheritance diagram for physx::shdfnd::MutexT< Alloc >:
Classes | |
class | ScopedLock |
Public Member Functions | |
MutexT (const Alloc &alloc=Alloc()) | |
~MutexT () | |
void | lock () const |
bool | trylock () const |
void | unlock () const |
template<typename Alloc = ReflectionAllocator<MutexImpl>>
class physx::shdfnd::MutexT< Alloc >
Constructor & Destructor Documentation
template<typename Alloc = ReflectionAllocator<MutexImpl>>
physx::shdfnd::MutexT< Alloc >::MutexT | ( | const Alloc & | alloc = Alloc() |
) | [inline] |
The constructor for Mutex creates a mutex. It is initially unlocked.
template<typename Alloc = ReflectionAllocator<MutexImpl>>
physx::shdfnd::MutexT< Alloc >::~MutexT | ( | ) | [inline] |
The destructor for Mutex deletes the mutex.
Member Function Documentation
template<typename Alloc = ReflectionAllocator<MutexImpl>>
void physx::shdfnd::MutexT< 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.
template<typename Alloc = ReflectionAllocator<MutexImpl>>
bool physx::shdfnd::MutexT< 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
template<typename Alloc = ReflectionAllocator<MutexImpl>>
void physx::shdfnd::MutexT< 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:
- E:/p4/sw/physx/PxShared/1.0/trunk/src/foundation/include/PsMutex.h
Generated on Tue Jul 28 14:21:59 2015 for NVIDIA(R) PsFoundation Reference by 1.5.8