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_multiple
     24 /// @file glm/gtx/multiple.hpp
     25 /// @date 2009-10-26 / 2011-06-07
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 /// @see gtx_extented_min_max (dependence)
     30 ///
     31 /// @defgroup gtx_multiple GLM_GTX_multiple
     32 /// @ingroup gtx
     33 ///
     34 /// @brief Find the closest number of a number multiple of other number.
     35 ///
     36 /// <glm/gtx/multiple.hpp> need to be included to use these functionalities.
     37 ///////////////////////////////////////////////////////////////////////////////////
     38 
     39 #ifndef GLM_GTX_multiple
     40 #define GLM_GTX_multiple
     41 
     42 // Dependency:
     43 #include "../glm.hpp"
     44 
     45 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     46 #	pragma message("GLM: GLM_GTX_multiple extension included")
     47 #endif
     48 
     49 namespace glm
     50 {
     51 	/// @addtogroup gtx_multiple
     52 	/// @{
     53 
     54 	/// Higher multiple number of Source.
     55 	///
     56 	/// @tparam genType Floating-point or integer scalar or vector types.
     57 	/// @param Source
     58 	/// @param Multiple Must be a null or positive value
     59 	///
     60 	/// @see gtx_multiple
     61 	template <typename genType>
     62 	GLM_FUNC_DECL genType higherMultiple(
     63 		genType const & Source,
     64 		genType const & Multiple);
     65 
     66 	/// Lower multiple number of Source.
     67 	///
     68 	/// @tparam genType Floating-point or integer scalar or vector types.
     69 	/// @param Source
     70 	/// @param Multiple Must be a null or positive value
     71 	///
     72 	/// @see gtx_multiple
     73 	template <typename genType>
     74 	GLM_FUNC_DECL genType lowerMultiple(
     75 		genType const & Source,
     76 		genType const & Multiple);
     77 
     78 	/// @}
     79 }//namespace glm
     80 
     81 #include "multiple.inl"
     82 
     83 #endif//GLM_GTX_multiple
     84