| 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_PXMEMORY_H |
| 31 | #define PXFOUNDATION_PXMEMORY_H |
| 32 | |
| 33 | /** \addtogroup foundation |
| 34 | @{ |
| 35 | */ |
| 36 | |
| 37 | #include "foundation/Px.h" |
| 38 | #include "foundation/PxIntrinsics.h" |
| 39 | #include "foundation/PxSimpleTypes.h" |
| 40 | |
| 41 | #if !PX_DOXYGEN |
| 42 | namespace physx |
| 43 | { |
| 44 | #endif |
| 45 | |
| 46 | /** |
| 47 | \brief Sets the bytes of the provided buffer to zero. |
| 48 | |
| 49 | \param dest Pointer to block of memory to set zero. |
| 50 | \param count Number of bytes to set to zero. |
| 51 | |
| 52 | \return Pointer to memory block (same as input) |
| 53 | */ |
| 54 | PX_FORCE_INLINE void* PxMemZero(void* dest, PxU32 count) |
| 55 | { |
| 56 | return physx::intrinsics::memZero(dest, count); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | \brief Sets the bytes of the provided buffer to the specified value. |
| 61 | |
| 62 | \param dest Pointer to block of memory to set to the specified value. |
| 63 | \param c Value to set the bytes of the block of memory to. |
| 64 | \param count Number of bytes to set to the specified value. |
| 65 | |
| 66 | \return Pointer to memory block (same as input) |
| 67 | */ |
| 68 | PX_FORCE_INLINE void* PxMemSet(void* dest, PxI32 c, PxU32 count) |
| 69 | { |
| 70 | return physx::intrinsics::memSet(dest, c, count); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | \brief Copies the bytes of one memory block to another. The memory blocks must not overlap. |
| 75 | |
| 76 | \note Use #PxMemMove if memory blocks overlap. |
| 77 | |
| 78 | \param dest Pointer to block of memory to copy to. |
| 79 | \param src Pointer to block of memory to copy from. |
| 80 | \param count Number of bytes to copy. |
| 81 | |
| 82 | \return Pointer to destination memory block |
| 83 | */ |
| 84 | PX_FORCE_INLINE void* PxMemCopy(void* dest, const void* src, PxU32 count) |
| 85 | { |
| 86 | return physx::intrinsics::memCopy(dest, src, count); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | \brief Copies the bytes of one memory block to another. The memory blocks can overlap. |
| 91 | |
| 92 | \note Use #PxMemCopy if memory blocks do not overlap. |
| 93 | |
| 94 | \param dest Pointer to block of memory to copy to. |
| 95 | \param src Pointer to block of memory to copy from. |
| 96 | \param count Number of bytes to copy. |
| 97 | |
| 98 | \return Pointer to destination memory block |
| 99 | */ |
| 100 | PX_FORCE_INLINE void* PxMemMove(void* dest, const void* src, PxU32 count) |
| 101 | { |
| 102 | return physx::intrinsics::memMove(dest, src, count); |
| 103 | } |
| 104 | |
| 105 | #if !PX_DOXYGEN |
| 106 | } // namespace physx |
| 107 | #endif |
| 108 | |
| 109 | /** @} */ |
| 110 | #endif // PXFOUNDATION_PXMEMORY_H |
| 111 | |