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 PXFOUNDATION_PXALLOCATORCALLBACK_H |
31 | #define PXFOUNDATION_PXALLOCATORCALLBACK_H |
32 | |
33 | /** \addtogroup foundation |
34 | @{ |
35 | */ |
36 | |
37 | #include "foundation/Px.h" |
38 | #if !PX_DOXYGEN |
39 | namespace physx |
40 | { |
41 | #endif |
42 | |
43 | /** |
44 | \brief Abstract base class for an application defined memory allocator that can be used by the Nv library. |
45 | |
46 | \note The SDK state should not be modified from within any allocation/free function. |
47 | |
48 | <b>Threading:</b> All methods of this class should be thread safe as it can be called from the user thread |
49 | or the physics processing thread(s). |
50 | */ |
51 | |
52 | class PxAllocatorCallback |
53 | { |
54 | public: |
55 | /** |
56 | \brief destructor |
57 | */ |
58 | virtual ~PxAllocatorCallback() |
59 | { |
60 | } |
61 | |
62 | /** |
63 | \brief Allocates size bytes of memory, which must be 16-byte aligned. |
64 | |
65 | This method should never return NULL. If you run out of memory, then |
66 | you should terminate the app or take some other appropriate action. |
67 | |
68 | <b>Threading:</b> This function should be thread safe as it can be called in the context of the user thread |
69 | and physics processing thread(s). |
70 | |
71 | \param size Number of bytes to allocate. |
72 | \param typeName Name of the datatype that is being allocated |
73 | \param filename The source file which allocated the memory |
74 | \param line The source line which allocated the memory |
75 | \return The allocated block of memory. |
76 | */ |
77 | virtual void* allocate(size_t size, const char* typeName, const char* filename, int line) = 0; |
78 | |
79 | /** |
80 | \brief Frees memory previously allocated by allocate(). |
81 | |
82 | <b>Threading:</b> This function should be thread safe as it can be called in the context of the user thread |
83 | and physics processing thread(s). |
84 | |
85 | \param ptr Memory to free. |
86 | */ |
87 | virtual void deallocate(void* ptr) = 0; |
88 | }; |
89 | |
90 | #if !PX_DOXYGEN |
91 | } // namespace physx |
92 | #endif |
93 | |
94 | /** @} */ |
95 | #endif // #ifndef PXFOUNDATION_PXALLOCATORCALLBACK_H |
96 | |