aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Source/Common/src/CmRefCountable.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Source/Common/src/CmRefCountable.h
downloadphysx-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/Source/Common/src/CmRefCountable.h')
-rw-r--r--PhysX_3.4/Source/Common/src/CmRefCountable.h102
1 files changed, 102 insertions, 0 deletions
diff --git a/PhysX_3.4/Source/Common/src/CmRefCountable.h b/PhysX_3.4/Source/Common/src/CmRefCountable.h
new file mode 100644
index 00000000..44087247
--- /dev/null
+++ b/PhysX_3.4/Source/Common/src/CmRefCountable.h
@@ -0,0 +1,102 @@
+// 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.
+// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+
+
+#ifndef PX_PHYSICS_COMMON_REFCOUNTABLE
+#define PX_PHYSICS_COMMON_REFCOUNTABLE
+
+#include "foundation/PxAssert.h"
+#include "PsAtomic.h"
+
+namespace physx
+{
+namespace Cm
+{
+
+ // simple thread-safe reference count
+ // when the ref count is zero, the object is in an undefined state (pending delete)
+
+ class RefCountable
+ {
+ //= ATTENTION! =====================================================================================
+ // Changing the data layout of this class breaks the binary serialization format. See comments for
+ // PX_BINARY_SERIAL_VERSION. If a modification is required, please adjust the getBinaryMetaData
+ // function. If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
+ // accordingly.
+ //==================================================================================================
+ public:
+// PX_SERIALIZATION
+ RefCountable(const PxEMPTY) : mRefCount(1) {}
+ static void getBinaryMetaData(PxOutputStream& stream);
+//~PX_SERIALIZATION
+ explicit RefCountable(PxU32 initialCount = 1)
+ : mRefCount(PxI32(initialCount))
+ {
+ PX_ASSERT(mRefCount!=0);
+ }
+
+ virtual ~RefCountable() {}
+
+ /**
+ Calls 'delete this;'. It needs to be overloaded for classes also deriving from
+ PxBase and call 'Cm::deletePxBase(this);' instead.
+ */
+ virtual void onRefCountZero()
+ {
+ delete this;
+ }
+
+ void incRefCount()
+ {
+ physx::shdfnd::atomicIncrement(&mRefCount);
+ // value better be greater than 1, or we've created a ref to an undefined object
+ PX_ASSERT(mRefCount>1);
+ }
+
+ void decRefCount()
+ {
+ PX_ASSERT(mRefCount>0);
+ if(physx::shdfnd::atomicDecrement(&mRefCount) == 0)
+ onRefCountZero();
+ }
+
+ PX_FORCE_INLINE PxU32 getRefCount() const
+ {
+ return PxU32(mRefCount);
+ }
+ private:
+ volatile PxI32 mRefCount;
+ };
+
+
+} // namespace Cm
+
+}
+
+#endif