Home | History | Annotate | Download | only in gtx
      1 ///////////////////////////////////////////////////////////////////////////////////
      2 /// OpenGL Mathematics (glm.g-truc.net)
      3 ///
      4 /// Copyright (c) 2005 - 2014 G-Truc Creation (www.g-truc.net)
      5 /// Permission is hereby granted, free of charge, to any person obtaining a copy
      6 /// of this software and associated documentation files (the "Software"), to deal
      7 /// in the Software without restriction, including without limitation the rights
      8 /// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      9 /// copies of the Software, and to permit persons to whom the Software is
     10 /// furnished to do so, subject to the following conditions:
     11 ///
     12 /// The above copyright notice and this permission notice shall be included in
     13 /// all copies or substantial portions of the Software.
     14 ///
     15 /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     16 /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     17 /// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     18 /// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     19 /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     20 /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     21 /// THE SOFTWARE.
     22 ///
     23 /// @ref gtx_optimum_pow
     24 /// @file glm/gtx/optimum_pow.hpp
     25 /// @date 2005-12-21 / 2011-06-07
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 ///
     30 /// @defgroup gtx_optimum_pow GLM_GTX_optimum_pow
     31 /// @ingroup gtx
     32 ///
     33 /// @brief Integer exponentiation of power functions.
     34 ///
     35 /// <glm/gtx/optimum_pow.hpp> need to be included to use these functionalities.
     36 ///////////////////////////////////////////////////////////////////////////////////
     37 
     38 #ifndef GLM_GTX_optimum_pow
     39 #define GLM_GTX_optimum_pow
     40 
     41 // Dependency:
     42 #include "../glm.hpp"
     43 
     44 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     45 #	pragma message("GLM: GLM_GTX_optimum_pow extension included")
     46 #endif
     47 
     48 namespace glm{
     49 namespace gtx
     50 {
     51 	/// @addtogroup gtx_optimum_pow
     52 	/// @{
     53 
     54 	//! Returns x raised to the power of 2.
     55 	//! From GLM_GTX_optimum_pow extension.
     56 	template <typename genType>
     57 	GLM_FUNC_DECL genType pow2(const genType& x);
     58 
     59 	//! Returns x raised to the power of 3.
     60 	//! From GLM_GTX_optimum_pow extension.
     61 	template <typename genType>
     62 	GLM_FUNC_DECL genType pow3(const genType& x);
     63 
     64 	//! Returns x raised to the power of 4.
     65 	//! From GLM_GTX_optimum_pow extension.
     66 	template <typename genType>
     67 	GLM_FUNC_DECL genType pow4(const genType& x);
     68 
     69 	//! Checks if the parameter is a power of 2 number.
     70 	//! From GLM_GTX_optimum_pow extension.
     71 	GLM_FUNC_DECL bool powOfTwo(int num);
     72 
     73 	//! Checks to determine if the parameter component are power of 2 numbers.
     74 	//! From GLM_GTX_optimum_pow extension.
     75 	template <precision P>
     76 	GLM_FUNC_DECL detail::tvec2<bool, P> powOfTwo(detail::tvec2<int, P> const & x);
     77 
     78 	//! Checks to determine if the parameter component are power of 2 numbers.
     79 	//! From GLM_GTX_optimum_pow extension.
     80 	template <precision P>
     81 	GLM_FUNC_DECL detail::tvec3<bool, P> powOfTwo(detail::tvec3<int, P> const & x);
     82 
     83 	//! Checks to determine if the parameter component are power of 2 numbers.
     84 	//! From GLM_GTX_optimum_pow extension.
     85 	template <precision P>
     86 	GLM_FUNC_DECL detail::tvec4<bool, P> powOfTwo(detail::tvec4<int, P> const & x);
     87 
     88 	/// @}
     89 }//namespace gtx
     90 }//namespace glm
     91 
     92 #include "optimum_pow.inl"
     93 
     94 #endif//GLM_GTX_optimum_pow
     95