diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h')
| -rw-r--r-- | PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h b/PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h new file mode 100644 index 00000000..060d18a9 --- /dev/null +++ b/PhysX_3.4/Snippets/SnippetUtils/SnippetUtils.h @@ -0,0 +1,128 @@ +// This code contains NVIDIA Confidential Information and is disclosed to you +// under a form of NVIDIA software license agreement provided separately to you. +// +// Notice +// NVIDIA Corporation and its licensors retain all intellectual property and +// proprietary rights in and to this software and related documentation and +// any modifications thereto. Any use, reproduction, disclosure, or +// distribution of this software and related documentation without an express +// license agreement from NVIDIA Corporation is strictly prohibited. +// +// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES +// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO +// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, +// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. +// +// Information and code furnished is believed to be accurate and reliable. +// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such +// information or for any infringement of patents or other rights of third parties that may +// result from its use. No license is granted by implication or otherwise under any patent +// or patent rights of NVIDIA Corporation. Details are subject to change without notice. +// This code supersedes and replaces all information previously supplied. +// NVIDIA Corporation products are not authorized for use as critical +// components in life support devices or systems without express written approval of +// NVIDIA Corporation. +// +// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved. + +#include "foundation/PxSimpleTypes.h" + +namespace physx +{ + namespace SnippetUtils + { + + /* Increment the specified location. Return the incremented value. */ + PxI32 atomicIncrement(volatile PxI32* val); + + /* Decrement the specified location. Return the decremented value. */ + PxI32 atomicDecrement(volatile PxI32* val); + + //******************************************************************************// + + /* Return the number of physical cores (does not include hyper-threaded cores), returns 0 on failure. */ + PxU32 getNbPhysicalCores(); + + //******************************************************************************// + + /* Return the id of a thread. */ + PxU32 getThreadId(); + + //******************************************************************************// + + /* Return the current time */ + PxU64 getCurrentTimeCounterValue(); + + /* Convert to milliseconds an elapsed time computed from the difference of the times returned from two calls to getCurrentTimeCounterValue. */ + PxReal getElapsedTimeInMilliseconds(const PxU64 elapsedTime); + + /* Convert to microseconds an elapsed time computed from the difference of the times returned from two calls to getCurrentTimeCounterValue. */ + PxReal getElapsedTimeInMicroSeconds(const PxU64 elapsedTime); + + //******************************************************************************// + + struct Sync; + + /* Create a sync object. Returns a unique handle to the sync object so that it may be addressed through syncWait etc. */ + Sync* syncCreate(); + + /* Wait indefinitely until the specified sync object is signaled. */ + void syncWait(Sync* sync); + + /* Signal the specified synchronization object, waking all threads waiting on it. */ + void syncSet(Sync* sync); + + /** Reset the specified synchronization object. */ + void syncReset(Sync* sync); + + /* Release the specified sync object so that it may be reused with syncCreate. */ + void syncRelease(Sync* sync); + + + //******************************************************************************// + + struct Thread; + + /* Prototype of callback passed to threadCreate. */ + typedef void (*ThreadEntryPoint)(void*); + + /* Create a thread object and return a unique handle to the thread object so that it may be addressed through threadStart etc. + entryPoint implements ThreadEntryPoint and data will be passed as a function argument, POSIX-style. */ + Thread* threadCreate(ThreadEntryPoint entryPoint, void* data); + + /* Cleanly shut down the specified thread. Called in the context of the spawned thread. */ + void threadQuit(Thread* thread); + + /* Stop the specified thread. Signals the spawned thread that it should stop, so the + thread should check regularly. */ + void threadSignalQuit(Thread* thread); + + /* Wait for the specified thread to stop. Should be called in the context of the spawning + thread. Returns false if the thread has not been started.*/ + bool threadWaitForQuit(Thread* thread); + + /* Check whether the thread is signalled to quit. Called in the context of the + spawned thread. */ + bool threadQuitIsSignalled(Thread* thread); + + /* Release the specified thread object so that it may be reused with threadCreate. */ + void threadRelease(Thread* thread); + + //******************************************************************************// + + struct Mutex; + + /* Create a mutex object and return a unique handle to the mutex object so that it may be addressed through mutexLock etc. */ + Mutex* mutexCreate(); + + /* Acquire (lock) the specified mutex. If the mutex is already locked by another thread, this method blocks until the mutex is unlocked.*/ + void mutexLock(Mutex* mutex); + + /* Release (unlock) the specified mutex, the calling thread must have previously called lock() or method will error. */ + void mutexUnlock(Mutex* mutex); + + /* Release the specified mutex so that it may be reused with mutexCreate. */ + void mutexRelease(Mutex* mutex); + + } +} |