constants.hpp 4.96 KB
Newer Older
1 2 3
///////////////////////////////////////////////////////////////////////////////////
/// OpenGL Mathematics (glm.g-truc.net)
///
4
/// Copyright (c) 2005 - 2013 G-Truc Creation (www.g-truc.net)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to deal
/// in the Software without restriction, including without limitation the rights
/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
/// copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
/// 
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
/// 
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
/// THE SOFTWARE.
///
/// @ref gtc_constants
/// @file glm/gtc/constants.hpp
/// @date 2011-09-30 / 2012-01-25
/// @author Christophe Riccio
///
/// @see core (dependence)
/// @see gtc_half_float (dependence)
///
/// @defgroup gtc_constants GLM_GTC_constants
/// @ingroup gtc
/// 
/// @brief Allow to perform bit operations on integer values
/// 
/// <glm/gtc/constants.hpp> need to be included to use these features.
///////////////////////////////////////////////////////////////////////////////////

#ifndef GLM_GTC_constants
#define GLM_GTC_constants GLM_VERSION

// Dependency:
#include "../glm.hpp"
#include "../gtc/half_float.hpp"

#if(defined(GLM_MESSAGES) && !defined(glm_ext))
#	pragma message("GLM: GLM_GTC_constants extension included")
#endif

namespace glm
{
	/// @addtogroup gtc_constants
	/// @{

	/// Return the epsilon constant for floating point types.
	/// @todo Implement epsilon for half-precision floating point type.
	/// @see gtc_constants
	template <typename genType>
59
	GLM_FUNC_DECL genType epsilon();
60 61 62 63

	/// Return 0.
	/// @see gtc_constants
	template <typename genType>
64
	GLM_FUNC_DECL genType zero();
65 66 67 68

	/// Return 1.
	/// @see gtc_constants
	template <typename genType>
69
	GLM_FUNC_DECL genType one();
70 71 72 73

	/// Return the pi constant.
	/// @see gtc_constants
	template <typename genType>
74
	GLM_FUNC_DECL genType pi();
75 76 77 78

	/// Return square root of pi.
	/// @see gtc_constants
	template <typename genType>
79
	GLM_FUNC_DECL genType root_pi();
80 81 82 83

	/// Return pi / 2.
	/// @see gtc_constants
	template <typename genType>
84
	GLM_FUNC_DECL genType half_pi();
85 86 87 88

	/// Return pi / 4.
	/// @see gtc_constants
	template <typename genType>
89
	GLM_FUNC_DECL genType quarter_pi();
90 91 92 93

	/// Return 1 / pi.
	/// @see gtc_constants
	template <typename genType>
94
	GLM_FUNC_DECL genType one_over_pi();
95 96 97 98

	/// Return 2 / pi.
	/// @see gtc_constants
	template <typename genType>
99
	GLM_FUNC_DECL genType two_over_pi();
100 101 102 103

	/// Return 2 / sqrt(pi).
	/// @see gtc_constants
	template <typename genType>
104
	GLM_FUNC_DECL genType two_over_root_pi();
105 106 107 108

	/// Return 1 / sqrt(2).
	/// @see gtc_constants
	template <typename genType>
109
	GLM_FUNC_DECL genType one_over_root_two();
110 111 112 113

	/// Return sqrt(pi / 2).
	/// @see gtc_constants
	template <typename genType>
114
	GLM_FUNC_DECL genType root_half_pi();
115 116 117 118

	/// Return sqrt(2 * pi).
	/// @see gtc_constants
	template <typename genType>
119
	GLM_FUNC_DECL genType root_two_pi();
120 121 122 123

	/// Return sqrt(ln(4)).
	/// @see gtc_constants
	template <typename genType>
124
	GLM_FUNC_DECL genType root_ln_four();
125 126 127 128

	/// Return e constant.
	/// @see gtc_constants
	template <typename genType>
129
	GLM_FUNC_DECL genType e();
130 131 132 133

	/// Return Euler's constant.
	/// @see gtc_constants
	template <typename genType>
134
	GLM_FUNC_DECL genType euler();
135 136 137 138

	/// Return sqrt(2).
	/// @see gtc_constants
	template <typename genType>
139
	GLM_FUNC_DECL genType root_two();
140 141 142 143

	/// Return sqrt(3).
	/// @see gtc_constants
	template <typename genType>
144
	GLM_FUNC_DECL genType root_three();
145 146 147 148

	/// Return sqrt(5).
	/// @see gtc_constants
	template <typename genType>
149
	GLM_FUNC_DECL genType root_five();
150 151 152 153

	/// Return ln(2).
	/// @see gtc_constants
	template <typename genType>
154
	GLM_FUNC_DECL genType ln_two();
155 156 157 158

	/// Return ln(10).
	/// @see gtc_constants
	template <typename genType>
159
	GLM_FUNC_DECL genType ln_ten();
160 161 162 163

	/// Return ln(ln(2)).
	/// @see gtc_constants
	template <typename genType>
164
	GLM_FUNC_DECL genType ln_ln_two();
165 166 167 168

	/// Return 1 / 3.
	/// @see gtc_constants
	template <typename genType>
169
	GLM_FUNC_DECL genType third();
170 171 172 173

	/// Return 2 / 3.
	/// @see gtc_constants
	template <typename genType>
174
	GLM_FUNC_DECL genType two_thirds();
175 176 177 178

	/// Return the golden ratio constant.
	/// @see gtc_constants
	template <typename genType>
179
	GLM_FUNC_DECL genType golden_ratio();
180 181 182 183 184 185 186

	/// @}
} //namespace glm

#include "constants.inl"

#endif//GLM_GTC_constants