• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_gradient_paint
24 /// @file glm/gtx/gradient_paint.hpp
25 /// @date 2009-03-06 / 2011-06-07
26 /// @author Christophe Riccio
27 ///
28 /// @see core (dependence)
29 /// @see gtx_optimum_pow (dependence)
30 ///
31 /// @defgroup gtx_gradient_paint GLM_GTX_gradient_paint
32 /// @ingroup gtx
33 ///
34 /// @brief Functions that return the color of procedural gradient for specific coordinates.
35 /// <glm/gtx/gradient_paint.hpp> need to be included to use these functionalities.
36 ///////////////////////////////////////////////////////////////////////////////////
37 
38 #ifndef GLM_GTX_gradient_paint
39 #define GLM_GTX_gradient_paint
40 
41 // Dependency:
42 #include "../glm.hpp"
43 #include "../gtx/optimum_pow.hpp"
44 
45 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
46 #	pragma message("GLM: GLM_GTX_gradient_paint extension included")
47 #endif
48 
49 namespace glm
50 {
51 	/// @addtogroup gtx_gradient_paint
52 	/// @{
53 
54 	/// Return a color from a radial gradient.
55 	/// @see - gtx_gradient_paint
56 	template <typename T, precision P>
57 	GLM_FUNC_DECL T radialGradient(
58 		detail::tvec2<T, P> const & Center,
59 		T const & Radius,
60 		detail::tvec2<T, P> const & Focal,
61 		detail::tvec2<T, P> const & Position);
62 
63 	/// Return a color from a linear gradient.
64 	/// @see - gtx_gradient_paint
65 	template <typename T, precision P>
66 	GLM_FUNC_DECL T linearGradient(
67 		detail::tvec2<T, P> const & Point0,
68 		detail::tvec2<T, P> const & Point1,
69 		detail::tvec2<T, P> const & Position);
70 
71 	/// @}
72 }// namespace glm
73 
74 #include "gradient_paint.inl"
75 
76 #endif//GLM_GTX_gradient_paint
77