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 | |
31 | #ifndef PX_PHYSICS_NX_LOCKED_DATA |
32 | #define PX_PHYSICS_NX_LOCKED_DATA |
33 | /** \addtogroup physics |
34 | @{ |
35 | */ |
36 | |
37 | #include "PxPhysXConfig.h" |
38 | #include "foundation/PxFlags.h" |
39 | |
40 | #if !PX_DOXYGEN |
41 | namespace physx |
42 | { |
43 | #endif |
44 | |
45 | struct PxDataAccessFlag |
46 | { |
47 | enum Enum |
48 | { |
49 | eREADABLE = (1 << 0), |
50 | eWRITABLE = (1 << 1), |
51 | eDEVICE = (1 << 2) |
52 | }; |
53 | }; |
54 | |
55 | /** |
56 | \brief collection of set bits defined in PxDataAccessFlag. |
57 | |
58 | @see PxDataAccessFlag |
59 | */ |
60 | typedef PxFlags<PxDataAccessFlag::Enum,PxU8> PxDataAccessFlags; |
61 | PX_FLAGS_OPERATORS(PxDataAccessFlag::Enum,PxU8) |
62 | |
63 | |
64 | /** |
65 | \brief Parent class for bulk data that is shared between the SDK and the application. |
66 | */ |
67 | class PxLockedData |
68 | { |
69 | public: |
70 | |
71 | /** |
72 | \brief Any combination of PxDataAccessFlag::eREADABLE and PxDataAccessFlag::eWRITABLE |
73 | @see PxDataAccessFlag |
74 | */ |
75 | virtual PxDataAccessFlags getDataAccessFlags() = 0; |
76 | |
77 | /** |
78 | \brief Unlocks the bulk data. |
79 | */ |
80 | virtual void unlock() = 0; |
81 | |
82 | /** |
83 | \brief virtual destructor |
84 | */ |
85 | virtual ~PxLockedData() {} |
86 | }; |
87 | |
88 | #if !PX_DOXYGEN |
89 | } // namespace physx |
90 | #endif |
91 | |
92 | /** @} */ |
93 | #endif |
94 | |