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/classPxFlags.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/classPxFlags.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxFlags.html | 242 |
1 files changed, 242 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxFlags.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFlags.html new file mode 100644 index 00000000..9b6e1fff --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFlags.html @@ -0,0 +1,242 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFlags< enumtype, storagetype > Class Template 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>PxFlags< enumtype, storagetype > Class Template Reference<br> +<small> +[<a class="el" href="group__foundation.html">Foundation</a>]</small> +</h1><!-- doxytag: class="PxFlags" -->Container for bitfield flag variables associated with a specific enum type. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxFlags_8h-source.html">PxFlags.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxFlags< enumtype, storagetype >:</div> +<div class="dynsection"> +<p><center><img src="classPxFlags__coll__graph.png" border="0" usemap="#PxFlags_3_01enumtype_00_01storagetype_01_4__coll__map" alt="Collaboration graph"></center> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxFlags-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 Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef storagetype </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFlags.html#b25f3aefb7bfaf3513b737a438c684fe">InternalType</a></td></tr> + +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFlags.html#5772810962f40450a773af8c5aaf9b52">PxFlags</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g48154e58845bdd886c83a90d9c7e07f6">PxFlags</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gb1746d4b633b7aa399fbd53e567556e3">PxFlags</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g51d02f16eacd58ed2742a0976a745a2e">PxFlags</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g98b1632cc78ea23ff93f8cfebebe5cba">PxFlags</a> (storagetype b)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gfbe6f7433a04ab5106990e0f31ee0278">isSet</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gf9d14cf14cd5e1a4c3849f323d4a5c71">set</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gf5c9e1d73aa95053872a305221ecaec8">operator==</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g110ffd967a01bc544cbf8c04850ede25">operator==</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g2f70f667ef2a90aeceab733297e71a1e">operator==</a> (bool b) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g29b679340d9ee4a57e10483bc2153a34">operator!=</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g8cf54d2180c82902586d5d3fe20fcc1a">operator!=</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g2931b1ac387a4417fb6053704b2ef327">operator=</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ga695b4a8b303290a0e28b7b493d1c02d">operator=</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#ged43737118e117c9959a2a7dfd13df02">operator|=</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g4c56b47b1a4cadc05d94cd1ef850dd4f">operator|=</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gff3ab524c497628d53b76cc57cc4c31e">operator|</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g64ea68943f74aa2fe52fa126ca873b88">operator|</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gf9ae5051982a6db8a6590e1c2bbb1600">operator&=</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gd9bbf8a0709c109b948b8671b01a44d6">operator&=</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g9ed93d25e5f6ec23113217b1bd7c9dd9">operator&</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g5d9d22aaa75180e1e32b540741dc34bd">operator&</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gfbe5e3fb5d82008c8c193d37709980d7">operator^=</a> (enumtype e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g40c9a674d20163242c9ffe4ac15568af">operator^=</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g6865e66d61ec6a6adc8fc8eb807c8b9a">operator^</a> (enumtype e) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gfaa73291f9dab13b84d9e3353f58b012">operator^</a> (const <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &f) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE <br class="typebreak"> +<a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g372ff7f25a1aa152c934b0a325054f0d">operator~</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g8325890deb9f1a04e2a37b5a42799c04">operator bool</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g828a9fa63ac043321de9e58e5661d0f1">operator uint8_t</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g8c3f8f1c8055c288e111badf17b55406">operator uint16_t</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#g016618adc8b0362686538f2dbd5d567e">operator uint32_t</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__foundation.html#gc66173de22806e20a666d3ab289597be">clear</a> (enumtype e)</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">storagetype </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFlags.html#28a90c1f3474fd1d610d77b7cf4f5537">mBits</a></td></tr> + +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, <br class="typebreak"> +storagetype > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFlags.html#92dbabfae6fb935047b9d753264c8bc0">operator&</a> (enumtype a, <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > &b)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<h3>template<typename enumtype, typename storagetype = uint32_t><br> + class PxFlags< enumtype, storagetype ></h3> + +Container for bitfield flag variables associated with a specific enum type. +<p> +This allows for type safe manipulation for bitfields.<p> +<h3>Example</h3> +<p> +enum that defines each bit... struct MyEnum { enum Enum { eMAN = 1, eBEAR = 2, ePIG = 4, }; };<p> +implements some convenient global operators. <a class="el" href="group__foundation.html#g092f922a63fdc7a95ae4f4e24b3768c1">PX_FLAGS_OPERATORS(MyEnum::Enum, uint8_t)</a>;<p> +<a class="el" href="classPxFlags.html#5772810962f40450a773af8c5aaf9b52">PxFlags<MyEnum::Enum, uint8_t></a> myFlags; myFlags |= MyEnum::eMAN; myFlags |= MyEnum::eBEAR | MyEnum::ePIG; if(myFlags & MyEnum::eBEAR) { doSomething(); } <hr><h2>Member Typedef Documentation</h2> +<a class="anchor" name="b25f3aefb7bfaf3513b737a438c684fe"></a><!-- doxytag: member="PxFlags::InternalType" ref="b25f3aefb7bfaf3513b737a438c684fe" args="" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename enumtype, typename storagetype = uint32_t> </div> + <table class="memname"> + <tr> + <td class="memname">typedef storagetype <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype >::<a class="el" href="classPxFlags.html#b25f3aefb7bfaf3513b737a438c684fe">InternalType</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="5772810962f40450a773af8c5aaf9b52"></a><!-- doxytag: member="PxFlags::PxFlags" ref="5772810962f40450a773af8c5aaf9b52" args="(const PxEMPTY)" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename enumtype, typename storagetype = uint32_t> </div> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_INLINE <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype >::<a class="el" href="classPxFlags.html">PxFlags</a> </td> + <td>(</td> + <td class="paramtype">const </td> + <td class="paramname"> <em>PxEMPTY</em> </td> + <td> ) </td> + <td><code> [inline, explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="92dbabfae6fb935047b9d753264c8bc0"></a><!-- doxytag: member="PxFlags::operator&" ref="92dbabfae6fb935047b9d753264c8bc0" args="(enumtype a, PxFlags< enumtype, storagetype > &b)" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename enumtype, typename storagetype = uint32_t> </div> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE <a class="el" href="classPxFlags.html">PxFlags</a><enumtype, storagetype> operator& </td> + <td>(</td> + <td class="paramtype">enumtype </td> + <td class="paramname"> <em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype > & </td> + <td class="paramname"> <em>b</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="28a90c1f3474fd1d610d77b7cf4f5537"></a><!-- doxytag: member="PxFlags::mBits" ref="28a90c1f3474fd1d610d77b7cf4f5537" args="" --> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename enumtype, typename storagetype = uint32_t> </div> + <table class="memname"> + <tr> + <td class="memname">storagetype <a class="el" href="classPxFlags.html">PxFlags</a>< enumtype, storagetype >::<a class="el" href="classPxFlags.html#28a90c1f3474fd1d610d77b7cf4f5537">mBits</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>Referenced by <a class="el" href="PxFlags_8h-source.html#l00365">PxFlags< enumtype, storagetype >::clear()</a>, <a class="el" href="PxFlags_8h-source.html#l00180">PxFlags< enumtype, storagetype >::isSet()</a>, <a class="el" href="PxFlags_8h-source.html#l00341">PxFlags< enumtype, storagetype >::operator bool()</a>, <a class="el" href="PxFlags_8h-source.html#l00353">PxFlags< enumtype, storagetype >::operator uint16_t()</a>, <a class="el" href="PxFlags_8h-source.html#l00359">PxFlags< enumtype, storagetype >::operator uint32_t()</a>, <a class="el" href="PxFlags_8h-source.html#l00347">PxFlags< enumtype, storagetype >::operator uint8_t()</a>, <a class="el" href="PxFlags_8h-source.html#l00211">PxFlags< enumtype, storagetype >::operator!=()</a>, <a class="el" href="PxFlags_8h-source.html#l00284">PxFlags< enumtype, storagetype >::operator&()</a>, <a class="el" href="PxFlags_8h-source.html#l00269">PxFlags< enumtype, storagetype >::operator&=()</a>, <a class="el" href="PxFlags_8h-source.html#l00223">PxFlags< enumtype, storagetype >::operator=()</a>, <a class="el" href="PxFlags_8h-source.html#l00193">PxFlags< enumtype, storagetype >::operator==()</a>, <a class="el" href="PxFlags_8h-source.html#l00316">PxFlags< enumtype, storagetype >::operator^()</a>, <a class="el" href="PxFlags_8h-source.html#l00301">PxFlags< enumtype, storagetype >::operator^=()</a>, <a class="el" href="PxFlags_8h-source.html#l00237">PxFlags< enumtype, storagetype >::operator|=()</a>, <a class="el" href="PxFlags_8h-source.html#l00333">PxFlags< enumtype, storagetype >::operator~()</a>, <a class="el" href="PxFlags_8h-source.html#l00156">PxFlags< enumtype, storagetype >::PxFlags()</a>, and <a class="el" href="PxFlags_8h-source.html#l00186">PxFlags< enumtype, storagetype >::set()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxFlags_8h-source.html">PxFlags.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> |