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_color_space
     24 /// @file glm/gtx/color_space.hpp
     25 /// @date 2005-12-21 / 2011-06-07
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 ///
     30 /// @defgroup gtx_color_space GLM_GTX_color_space
     31 /// @ingroup gtx
     32 ///
     33 /// @brief Related to RGB to HSV conversions and operations.
     34 ///
     35 /// <glm/gtx/color_space.hpp> need to be included to use these functionalities.
     36 ///////////////////////////////////////////////////////////////////////////////////
     37 
     38 #ifndef GLM_GTX_color_space
     39 #define GLM_GTX_color_space
     40 
     41 // Dependency:
     42 #include "../glm.hpp"
     43 
     44 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     45 #	pragma message("GLM: GLM_GTX_color_space extension included")
     46 #endif
     47 
     48 namespace glm
     49 {
     50 	/// @addtogroup gtx_color_space
     51 	/// @{
     52 
     53 	/// Converts a color from HSV color space to its color in RGB color space.
     54 	/// @see gtx_color_space
     55 	template <typename T, precision P>
     56 	GLM_FUNC_DECL detail::tvec3<T, P> rgbColor(
     57 		detail::tvec3<T, P> const & hsvValue);
     58 
     59 	/// Converts a color from RGB color space to its color in HSV color space.
     60 	/// @see gtx_color_space
     61 	template <typename T, precision P>
     62 	GLM_FUNC_DECL detail::tvec3<T, P> hsvColor(
     63 		detail::tvec3<T, P> const & rgbValue);
     64 
     65 	/// Build a saturation matrix.
     66 	/// @see gtx_color_space
     67 	template <typename T, precision P>
     68 	GLM_FUNC_DECL detail::tmat4x4<T, P> saturation(
     69 		T const s);
     70 
     71 	/// Modify the saturation of a color.
     72 	/// @see gtx_color_space
     73 	template <typename T, precision P>
     74 	GLM_FUNC_DECL detail::tvec3<T, P> saturation(
     75 		T const s,
     76 		detail::tvec3<T, P> const & color);
     77 
     78 	/// Modify the saturation of a color.
     79 	/// @see gtx_color_space
     80 	template <typename T, precision P>
     81 	GLM_FUNC_DECL detail::tvec4<T, P> saturation(
     82 		T const s,
     83 		detail::tvec4<T, P> const & color);
     84 
     85 	/// Compute color luminosity associating ratios (0.33, 0.59, 0.11) to RGB canals.
     86 	/// @see gtx_color_space
     87 	template <typename T, precision P>
     88 	GLM_FUNC_DECL T luminosity(
     89 		detail::tvec3<T, P> const & color);
     90 
     91 	/// @}
     92 }//namespace glm
     93 
     94 #include "color_space.inl"
     95 
     96 #endif//GLM_GTX_color_space
     97