PhysX_3.4/Documentation/PhysXAPI/files/classPxFoundation.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFoundation 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> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxFoundation Class Reference<br>
<small>
[<a class="el" href="group__foundation.html">Foundation</a>]</small>
</h1><!-- doxytag: class="PxFoundation" -->Foundation SDK singleton class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxFoundation_8h-source.html">PxFoundation.h</a>&gt;</code>
<p>

<p>
<a href="classPxFoundation-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a0158936b990e4e766a6eb2947720305">release</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the instance it is called on.  <a href="#a0158936b990e4e766a6eb2947720305"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxErrorCallback.html">PxErrorCallback</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a7c4f39a69dc0a64735af1d02c021c0f">getErrorCallback</a> ()=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#ac16a599bd1ffc725f849703e7eb5696">setErrorLevel</a> (<a class="el" href="structPxErrorCode.html#01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a> mask=PxErrorCode::eMASK_ALL)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxErrorCode.html#01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#e44c51d4547f4437dbcaf3db68b16bac">getErrorLevel</a> () const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#8e4381d58ae863b36f53dded4bf694c9">getAllocatorCallback</a> ()=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#99d8ace08bda782da561bc14c6e9075b">getReportAllocationNames</a> () const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#10a9bd2dc04b64b17a6bb624872b565d">setReportAllocationNames</a> (bool value)=0</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#525b818f28e61890a574aa0c501f5991">~PxFoundation</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Foundation SDK singleton class. 
<p>
You need to have an instance of this class to instance the higher level SDKs. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="525b818f28e61890a574aa0c501f5991"></a><!-- doxytag: member="PxFoundation::~PxFoundation" ref="525b818f28e61890a574aa0c501f5991" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxFoundation::~PxFoundation           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8e4381d58ae863b36f53dded4bf694c9"></a><!-- doxytag: member="PxFoundation::getAllocatorCallback" ref="8e4381d58ae863b36f53dded4bf694c9" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a>&amp; PxFoundation::getAllocatorCallback           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrieves the allocator this object was created with. 
</div>
</div><p>
<a class="anchor" name="a7c4f39a69dc0a64735af1d02c021c0f"></a><!-- doxytag: member="PxFoundation::getErrorCallback" ref="a7c4f39a69dc0a64735af1d02c021c0f" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxErrorCallback.html">PxErrorCallback</a>&amp; PxFoundation::getErrorCallback           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
retrieves error callback 
</div>
</div><p>
<a class="anchor" name="e44c51d4547f4437dbcaf3db68b16bac"></a><!-- doxytag: member="PxFoundation::getErrorLevel" ref="e44c51d4547f4437dbcaf3db68b16bac" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structPxErrorCode.html#01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a> PxFoundation::getErrorLevel           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrieves mask of errors to be reported. 
</div>
</div><p>
<a class="anchor" name="99d8ace08bda782da561bc14c6e9075b"></a><!-- doxytag: member="PxFoundation::getReportAllocationNames" ref="99d8ace08bda782da561bc14c6e9075b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxFoundation::getReportAllocationNames           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrieves if allocation names are being passed to allocator callback. 
</div>
</div><p>
<a class="anchor" name="a0158936b990e4e766a6eb2947720305"></a><!-- doxytag: member="PxFoundation::release" ref="a0158936b990e4e766a6eb2947720305" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::release           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destroys the instance it is called on. 
<p>
The operation will fail, if there are still modules referencing the foundation object. Release all dependent modules prior to calling this method.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__foundation.html#g9deda8eaad9681fc9eb456adc5225668" title="Creates an instance of the foundation class.">PxCreateFoundation()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="ac16a599bd1ffc725f849703e7eb5696"></a><!-- doxytag: member="PxFoundation::setErrorLevel" ref="ac16a599bd1ffc725f849703e7eb5696" args="(PxErrorCode::Enum mask=PxErrorCode::eMASK_ALL)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::setErrorLevel           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxErrorCode.html#01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>mask</em> = <code>PxErrorCode::eMASK_ALL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets mask of errors to report. 
</div>
</div><p>
<a class="anchor" name="10a9bd2dc04b64b17a6bb624872b565d"></a><!-- doxytag: member="PxFoundation::setReportAllocationNames" ref="10a9bd2dc04b64b17a6bb624872b565d" args="(bool value)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::setReportAllocationNames           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>value</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set if allocation names are being passed to allocator callback. Enabled by default in debug and checked build, disabled by default in profile and release build. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxFoundation_8h-source.html">PxFoundation.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 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>