diff options
| author | Nathan Hoobler <[email protected]> | 2016-03-22 11:40:34 -0400 |
|---|---|---|
| committer | Nathan Hoobler <[email protected]> | 2016-03-22 11:40:34 -0400 |
| commit | b4ab266c9010aaff5404f6a508a2e592eb367d36 (patch) | |
| tree | 1e9eefa78e90485397b50ce5e780a1d0cb38b493 /external/NvFoundation/1.1/include/NvFlags.h | |
| download | volumetriclighting-b4ab266c9010aaff5404f6a508a2e592eb367d36.tar.xz volumetriclighting-b4ab266c9010aaff5404f6a508a2e592eb367d36.zip | |
initial commit
Diffstat (limited to 'external/NvFoundation/1.1/include/NvFlags.h')
| -rw-r--r-- | external/NvFoundation/1.1/include/NvFlags.h | 375 |
1 files changed, 375 insertions, 0 deletions
diff --git a/external/NvFoundation/1.1/include/NvFlags.h b/external/NvFoundation/1.1/include/NvFlags.h new file mode 100644 index 0000000..b2ec31c --- /dev/null +++ b/external/NvFoundation/1.1/include/NvFlags.h @@ -0,0 +1,375 @@ +// This code contains NVIDIA Confidential Information and is disclosed to you +// under a form of NVIDIA software license agreement provided separately to you. +// +// Notice +// NVIDIA Corporation and its licensors retain all intellectual property and +// proprietary rights in and to this software and related documentation and +// any modifications thereto. Any use, reproduction, disclosure, or +// distribution of this software and related documentation without an express +// license agreement from NVIDIA Corporation is strictly prohibited. +// +// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES +// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO +// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, +// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. +// +// Information and code furnished is believed to be accurate and reliable. +// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such +// information or for any infringement of patents or other rights of third parties that may +// result from its use. No license is granted by implication or otherwise under any patent +// or patent rights of NVIDIA Corporation. Details are subject to change without notice. +// This code supersedes and replaces all information previously supplied. +// NVIDIA Corporation products are not authorized for use as critical +// components in life support devices or systems without express written approval of +// NVIDIA Corporation. +// +// Copyright (c) 2008-2014 NVIDIA Corporation. All rights reserved. +// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved. +// Copyright (c) 2001-2004 NovodeX AG. All rights reserved. + +#ifndef NV_NVFOUNDATION_NVFLAGS_H +#define NV_NVFOUNDATION_NVFLAGS_H + +/** \addtogroup foundation + @{ +*/ + +#include "Nv.h" + +#if !NV_DOXYGEN +namespace nvidia +{ +#endif +/** +\brief Container for bitfield flag variables associated with a specific enum type. + +This allows for type safe manipulation for bitfields. + +<h3>Example</h3> + // enum that defines each bit... + struct MyEnum + { + enum Enum + { + eMAN = 1, + eBEAR = 2, + ePIG = 4, + }; + }; + + // implements some convenient global operators. + NV_FLAGS_OPERATORS(MyEnum::Enum, uint8_t); + + NvFlags<MyEnum::Enum, uint8_t> myFlags; + myFlags |= MyEnum::eMAN; + myFlags |= MyEnum::eBEAR | MyEnum::ePIG; + if(myFlags & MyEnum::eBEAR) + { + doSomething(); + } +*/ + +template <typename enumtype, typename storagetype = uint32_t> +class NvFlags +{ + public: + typedef storagetype InternalType; + + NV_INLINE explicit NvFlags(const NvEMPTY) + { + } + NV_INLINE NvFlags(void); + NV_INLINE NvFlags(enumtype e); + NV_INLINE NvFlags(const NvFlags<enumtype, storagetype>& f); + NV_INLINE explicit NvFlags(storagetype b); + + NV_INLINE bool isSet(enumtype e) const; + NV_INLINE NvFlags<enumtype, storagetype>& set(enumtype e); + NV_INLINE bool operator==(enumtype e) const; + NV_INLINE bool operator==(const NvFlags<enumtype, storagetype>& f) const; + NV_INLINE bool operator==(bool b) const; + NV_INLINE bool operator!=(enumtype e) const; + NV_INLINE bool operator!=(const NvFlags<enumtype, storagetype>& f) const; + + NV_INLINE NvFlags<enumtype, storagetype>& operator=(const NvFlags<enumtype, storagetype>& f); + NV_INLINE NvFlags<enumtype, storagetype>& operator=(enumtype e); + + NV_INLINE NvFlags<enumtype, storagetype>& operator|=(enumtype e); + NV_INLINE NvFlags<enumtype, storagetype>& operator|=(const NvFlags<enumtype, storagetype>& f); + NV_INLINE NvFlags<enumtype, storagetype> operator|(enumtype e) const; + NV_INLINE NvFlags<enumtype, storagetype> operator|(const NvFlags<enumtype, storagetype>& f) const; + + NV_INLINE NvFlags<enumtype, storagetype>& operator&=(enumtype e); + NV_INLINE NvFlags<enumtype, storagetype>& operator&=(const NvFlags<enumtype, storagetype>& f); + NV_INLINE NvFlags<enumtype, storagetype> operator&(enumtype e) const; + NV_INLINE NvFlags<enumtype, storagetype> operator&(const NvFlags<enumtype, storagetype>& f) const; + + NV_INLINE NvFlags<enumtype, storagetype>& operator^=(enumtype e); + NV_INLINE NvFlags<enumtype, storagetype>& operator^=(const NvFlags<enumtype, storagetype>& f); + NV_INLINE NvFlags<enumtype, storagetype> operator^(enumtype e) const; + NV_INLINE NvFlags<enumtype, storagetype> operator^(const NvFlags<enumtype, storagetype>& f) const; + + NV_INLINE NvFlags<enumtype, storagetype> operator~(void) const; + + NV_INLINE operator bool(void) const; + NV_INLINE operator uint8_t(void) const; + NV_INLINE operator uint16_t(void) const; + NV_INLINE operator uint32_t(void) const; + + NV_INLINE void clear(enumtype e); + + public: + friend NV_INLINE NvFlags<enumtype, storagetype> operator&(enumtype a, NvFlags<enumtype, storagetype>& b) + { + NvFlags<enumtype, storagetype> out; + out.mBits = a & b.mBits; + return out; + } + + private: + storagetype mBits; +}; + +#define NV_FLAGS_OPERATORS(enumtype, storagetype) \ + NV_INLINE NvFlags<enumtype, storagetype> operator|(enumtype a, enumtype b) \ + { \ + NvFlags<enumtype, storagetype> r(a); \ + r |= b; \ + return r; \ + } \ + NV_INLINE NvFlags<enumtype, storagetype> operator&(enumtype a, enumtype b) \ + { \ + NvFlags<enumtype, storagetype> r(a); \ + r &= b; \ + return r; \ + } \ + NV_INLINE NvFlags<enumtype, storagetype> operator~(enumtype a) \ + { \ + return ~NvFlags<enumtype, storagetype>(a); \ + } + +#define NV_FLAGS_TYPEDEF(x, y) \ + typedef NvFlags<x::Enum, y> x##s; \ + NV_FLAGS_OPERATORS(x::Enum, y) + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::NvFlags(void) +{ + mBits = 0; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::NvFlags(enumtype e) +{ + mBits = static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::NvFlags(const NvFlags<enumtype, storagetype>& f) +{ + mBits = f.mBits; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::NvFlags(storagetype b) +{ + mBits = b; +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::isSet(enumtype e) const +{ + return (mBits & static_cast<storagetype>(e)) == static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::set(enumtype e) +{ + mBits = static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::operator==(enumtype e) const +{ + return mBits == static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::operator==(const NvFlags<enumtype, storagetype>& f) const +{ + return mBits == f.mBits; +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::operator==(bool b) const +{ + return bool(*this) == b; +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::operator!=(enumtype e) const +{ + return mBits != static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +NV_INLINE bool NvFlags<enumtype, storagetype>::operator!=(const NvFlags<enumtype, storagetype>& f) const +{ + return mBits != f.mBits; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::operator=(enumtype e) +{ + mBits = static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::operator=(const NvFlags<enumtype, storagetype>& f) +{ + mBits = f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::operator|=(enumtype e) +{ + mBits |= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>:: +operator|=(const NvFlags<enumtype, storagetype>& f) +{ + mBits |= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>::operator|(enumtype e) const +{ + NvFlags<enumtype, storagetype> out(*this); + out |= e; + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>:: +operator|(const NvFlags<enumtype, storagetype>& f) const +{ + NvFlags<enumtype, storagetype> out(*this); + out |= f; + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::operator&=(enumtype e) +{ + mBits &= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>:: +operator&=(const NvFlags<enumtype, storagetype>& f) +{ + mBits &= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>::operator&(enumtype e) const +{ + NvFlags<enumtype, storagetype> out = *this; + out.mBits &= static_cast<storagetype>(e); + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>:: +operator&(const NvFlags<enumtype, storagetype>& f) const +{ + NvFlags<enumtype, storagetype> out = *this; + out.mBits &= f.mBits; + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>::operator^=(enumtype e) +{ + mBits ^= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>& NvFlags<enumtype, storagetype>:: +operator^=(const NvFlags<enumtype, storagetype>& f) +{ + mBits ^= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>::operator^(enumtype e) const +{ + NvFlags<enumtype, storagetype> out = *this; + out.mBits ^= static_cast<storagetype>(e); + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>:: +operator^(const NvFlags<enumtype, storagetype>& f) const +{ + NvFlags<enumtype, storagetype> out = *this; + out.mBits ^= f.mBits; + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype> NvFlags<enumtype, storagetype>::operator~(void) const +{ + NvFlags<enumtype, storagetype> out; + out.mBits = storagetype(~mBits); + return out; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::operator bool(void) const +{ + return mBits ? true : false; +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::operator uint8_t(void) const +{ + return static_cast<uint8_t>(mBits); +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::operator uint16_t(void) const +{ + return static_cast<uint16_t>(mBits); +} + +template <typename enumtype, typename storagetype> +NV_INLINE NvFlags<enumtype, storagetype>::operator uint32_t(void) const +{ + return static_cast<uint32_t>(mBits); +} + +template <typename enumtype, typename storagetype> +NV_INLINE void NvFlags<enumtype, storagetype>::clear(enumtype e) +{ + mBits &= ~static_cast<storagetype>(e); +} + +#if !NV_DOXYGEN +} // namespace nvidia +#endif + +/** @} */ +#endif // #ifndef NV_NVFOUNDATION_NVFLAGS_H |