1//
2// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions
4// are met:
5// * Redistributions of source code must retain the above copyright
6// notice, this list of conditions and the following disclaimer.
7// * Redistributions in binary form must reproduce the above copyright
8// notice, this list of conditions and the following disclaimer in the
9// documentation and/or other materials provided with the distribution.
10// * Neither the name of NVIDIA CORPORATION nor the names of its
11// contributors may be used to endorse or promote products derived
12// from this software without specific prior written permission.
13//
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25//
26// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29
30#ifndef PX_FOUNDATION_PX_FOUNDATION_H
31#define PX_FOUNDATION_PX_FOUNDATION_H
32
33/** \addtogroup foundation
34 @{
35*/
36
37#include "foundation/Px.h"
38#include "foundation/PxErrors.h"
39#include "foundation/PxFoundationConfig.h"
40
41#if !PX_DOXYGEN
42namespace physx
43{
44#endif
45
46/**
47\brief Foundation SDK singleton class.
48
49You need to have an instance of this class to instance the higher level SDKs.
50*/
51class PX_FOUNDATION_API PxFoundation
52{
53 public:
54 /**
55 \brief Destroys the instance it is called on.
56
57 The operation will fail, if there are still modules referencing the foundation object. Release all dependent modules
58 prior
59 to calling this method.
60
61 @see PxCreateFoundation()
62 */
63 virtual void release() = 0;
64
65 /**
66 retrieves error callback
67 */
68 virtual PxErrorCallback& getErrorCallback() = 0;
69
70 /**
71 Sets mask of errors to report.
72 */
73 virtual void setErrorLevel(PxErrorCode::Enum mask = PxErrorCode::eMASK_ALL) = 0;
74
75 /**
76 Retrieves mask of errors to be reported.
77 */
78 virtual PxErrorCode::Enum getErrorLevel() const = 0;
79
80 /**
81 Retrieves the allocator this object was created with.
82 */
83 virtual PxAllocatorCallback& getAllocatorCallback() = 0;
84
85 /**
86 Retrieves if allocation names are being passed to allocator callback.
87 */
88 virtual bool getReportAllocationNames() const = 0;
89
90 /**
91 Set if allocation names are being passed to allocator callback.
92 \details Enabled by default in debug and checked build, disabled by default in profile and release build.
93 */
94 virtual void setReportAllocationNames(bool value) = 0;
95
96 protected:
97 virtual ~PxFoundation()
98 {
99 }
100};
101
102#if !PX_DOXYGEN
103} // namespace physx
104#endif
105
106/**
107\brief Creates an instance of the foundation class
108
109The foundation class is needed to initialize higher level SDKs. There may be only one instance per process.
110Calling this method after an instance has been created already will result in an error message and NULL will be
111returned.
112
113\param version Version number we are expecting (should be #PX_PHYSICS_VERSION)
114\param allocator User supplied interface for allocating memory(see #PxAllocatorCallback)
115\param errorCallback User supplied interface for reporting errors and displaying messages(see #PxErrorCallback)
116\return Foundation instance on success, NULL if operation failed
117
118@see PxFoundation
119*/
120
121PX_C_EXPORT PX_FOUNDATION_API physx::PxFoundation* PX_CALL_CONV
122PxCreateFoundation(physx::PxU32 version, physx::PxAllocatorCallback& allocator, physx::PxErrorCallback& errorCallback);
123/**
124\brief Retrieves the Foundation SDK after it has been created.
125
126\note The behavior of this method is undefined if the foundation instance has not been created already.
127
128@see PxCreateFoundation()
129*/
130#if PX_CLANG
131#if PX_LINUX
132#pragma clang diagnostic push
133#pragma clang diagnostic ignored "-Wreturn-type-c-linkage"
134#endif // PX_LINUX
135#endif // PX_CLANG
136PX_C_EXPORT PX_FOUNDATION_API physx::PxFoundation& PX_CALL_CONV PxGetFoundation();
137#if PX_CLANG
138#if PX_LINUX
139#pragma clang diagnostic pop
140#endif // PX_LINUX
141#endif // PX_CLANG
142
143namespace physx
144{
145class PxProfilerCallback;
146}
147
148/**
149\brief Get the callback that will be used for all profiling.
150*/
151PX_C_EXPORT PX_FOUNDATION_API physx::PxProfilerCallback* PX_CALL_CONV PxGetProfilerCallback();
152
153/**
154\brief Set the callback that will be used for all profiling.
155*/
156PX_C_EXPORT PX_FOUNDATION_API void PX_CALL_CONV PxSetProfilerCallback(physx::PxProfilerCallback* profiler);
157
158/** @} */
159#endif // PX_FOUNDATION_PX_FOUNDATION_H
160

source code of qtquick3dphysics/src/3rdparty/PhysX/include/PxFoundation.h