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/Documentation/PhysXAPI/files/classPxSceneReadLock.html | |
| 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/Documentation/PhysXAPI/files/classPxSceneReadLock.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneReadLock.html | 190 |
1 files changed, 190 insertions, 0 deletions
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 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSceneReadLock Class Reference</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="images/PhysXlogo.png" align="middle"> <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxSceneReadLock Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxSceneReadLock" -->RAII wrapper for the <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a> read lock. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxSceneLock_8h-source.html">PxSceneLock.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxSceneReadLock:</div> +<div class="dynsection"> +<p><center><img src="classPxSceneReadLock__coll__graph.png" border="0" usemap="#PxSceneReadLock__coll__map" alt="Collaboration graph"></center> +<map name="PxSceneReadLock__coll__map"> +<area shape="rect" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact..." alt="PxScene" coords="36,16,97,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxSceneReadLock-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneReadLock.html#c6f82c5407164675be3fc767c4e9cecd">PxSceneReadLock</a> (<a class="el" href="classPxScene.html">PxScene</a> &scene, const char *file=NULL, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> line=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#c6f82c5407164675be3fc767c4e9cecd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneReadLock.html#c2c7cda40fe1ebcb45a8c771ab00644f">~PxSceneReadLock</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneReadLock.html#ef1281bce24a99ed88fc45e88c702266">PxSceneReadLock</a> (const <a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a> &)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneReadLock.html#3d9fede7ae012ba282191510d78bc263">operator=</a> (const <a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a> &)</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxScene.html">PxScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSceneReadLock.html#7ab5a151068accac3c32694c01b40a34">mScene</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +RAII wrapper for the <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a> read lock. +<p> +Use this class as follows to lock the scene for reading by the current thread for the duration of the enclosing scope:<p> +<a class="el" href="classPxSceneReadLock.html" title="RAII wrapper for the PxScene read lock.">PxSceneReadLock</a> lock(sceneRef);<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html#088a9978be5b160b79665d4fb471ec81" title="Lock the scene for reading from the calling thread.">PxScene::lockRead()</a>, <a class="el" href="classPxScene.html#ca7f8e7bc71ad39645b787bc41ab8c13" title="Unlock the scene from reading.">PxScene::unlockRead()</a>, <a class="el" href="structPxSceneFlag.html#b4c347372b4433d34d983da780916c5397a4bafb1db3bba4b8ff373e16d67c5b" title="Require scene-level locking.">PxSceneFlag::eREQUIRE_RW_LOCK</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="ef1281bce24a99ed88fc45e88c702266"></a><!-- doxytag: member="PxSceneReadLock::PxSceneReadLock" ref="ef1281bce24a99ed88fc45e88c702266" args="(const PxSceneReadLock &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxSceneReadLock::PxSceneReadLock </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="c6f82c5407164675be3fc767c4e9cecd"></a><!-- doxytag: member="PxSceneReadLock::PxSceneReadLock" ref="c6f82c5407164675be3fc767c4e9cecd" args="(PxScene &scene, const char *file=NULL, PxU32 line=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxSceneReadLock::PxSceneReadLock </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxScene.html">PxScene</a> & </td> + <td class="paramname"> <em>scene</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>file</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>line</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>scene</em> </td><td>The scene to lock for reading </td></tr> + <tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>Optional string for debugging purposes </td></tr> + <tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>Optional line number for debugging purposes </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="c2c7cda40fe1ebcb45a8c771ab00644f"></a><!-- doxytag: member="PxSceneReadLock::~PxSceneReadLock" ref="c2c7cda40fe1ebcb45a8c771ab00644f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxSceneReadLock::~PxSceneReadLock </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="3d9fede7ae012ba282191510d78bc263"></a><!-- doxytag: member="PxSceneReadLock::operator=" ref="3d9fede7ae012ba282191510d78bc263" args="(const PxSceneReadLock &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a>& PxSceneReadLock::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxSceneReadLock.html">PxSceneReadLock</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="7ab5a151068accac3c32694c01b40a34"></a><!-- doxytag: member="PxSceneReadLock::mScene" ref="7ab5a151068accac3c32694c01b40a34" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxScene.html">PxScene</a>& <a class="el" href="classPxSceneReadLock.html#7ab5a151068accac3c32694c01b40a34">PxSceneReadLock::mScene</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxSceneLock_8h-source.html">PxSceneLock.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</body> +</html> |