From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxSceneReadLock.html | 190 +++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html new file mode 100644 index 00000000..f8ef11d4 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html @@ -0,0 +1,190 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSceneReadLock Class Reference + + + + + + + +
+

PxSceneReadLock Class Reference
+ +[Physics] +

RAII wrapper for the PxScene read lock. +More... +

+#include <PxSceneLock.h> +

+

+Collaboration diagram for PxSceneReadLock:
+
+

Collaboration graph
+ +PxScene +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + +

Public Member Functions

 PxSceneReadLock (PxScene &scene, const char *file=NULL, PxU32 line=0)
 Constructor.
 ~PxSceneReadLock ()

Private Member Functions

 PxSceneReadLock (const PxSceneReadLock &)
PxSceneReadLock & operator= (const PxSceneReadLock &)

Private Attributes

PxScene & mScene
+

Detailed Description

+RAII wrapper for the PxScene read lock. +

+Use this class as follows to lock the scene for reading by the current thread for the duration of the enclosing scope:

+PxSceneReadLock lock(sceneRef);

+

See also:
PxScene::lockRead(), PxScene::unlockRead(), PxSceneFlag::eREQUIRE_RW_LOCK
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
PxSceneReadLock::PxSceneReadLock (const PxSceneReadLock &   )  [private]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
PxSceneReadLock::PxSceneReadLock (PxScene &  scene,
const char *  file = NULL,
PxU32  line = 0 
) [inline]
+
+
+ +

+Constructor. +

+

Parameters:
+ + + + +
scene The scene to lock for reading
file Optional string for debugging purposes
line Optional line number for debugging purposes
+
+ +
+

+ +

+
+ + + + + + + + +
PxSceneReadLock::~PxSceneReadLock (  )  [inline]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
PxSceneReadLock& PxSceneReadLock::operator= (const PxSceneReadLock &   )  [private]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxScene& PxSceneReadLock::mScene [private]
+
+
+ +

+ +

+

+

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

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3