166 lines
3.9 KiB
C++
166 lines
3.9 KiB
C++
/// @ref gtc_constants
|
|
/// @file glm/gtc/constants.hpp
|
|
///
|
|
/// @see core (dependence)
|
|
///
|
|
/// @defgroup gtc_constants GLM_GTC_constants
|
|
/// @ingroup gtc
|
|
///
|
|
/// Include <glm/gtc/constants.hpp> to use the features of this extension.
|
|
///
|
|
/// Provide a list of constants and precomputed useful values.
|
|
|
|
#pragma once
|
|
|
|
// Dependencies
|
|
#include "../ext/scalar_constants.hpp"
|
|
|
|
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
|
|
# pragma message("GLM: GLM_GTC_constants extension included")
|
|
#endif
|
|
|
|
namespace glm
|
|
{
|
|
/// @addtogroup gtc_constants
|
|
/// @{
|
|
|
|
/// Return 0.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType zero();
|
|
|
|
/// Return 1.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType one();
|
|
|
|
/// Return pi * 2.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType two_pi();
|
|
|
|
/// Return square root of pi.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_pi();
|
|
|
|
/// Return pi / 2.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType half_pi();
|
|
|
|
/// Return pi / 2 * 3.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType three_over_two_pi();
|
|
|
|
/// Return pi / 4.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType quarter_pi();
|
|
|
|
/// Return 1 / pi.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_pi();
|
|
|
|
/// Return 1 / (pi * 2).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_two_pi();
|
|
|
|
/// Return 2 / pi.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_pi();
|
|
|
|
/// Return 4 / pi.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType four_over_pi();
|
|
|
|
/// Return 2 / sqrt(pi).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_root_pi();
|
|
|
|
/// Return 1 / sqrt(2).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_root_two();
|
|
|
|
/// Return sqrt(pi / 2).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_half_pi();
|
|
|
|
/// Return sqrt(2 * pi).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_two_pi();
|
|
|
|
/// Return sqrt(ln(4)).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_ln_four();
|
|
|
|
/// Return e constant.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType e();
|
|
|
|
/// Return Euler's constant.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType euler();
|
|
|
|
/// Return sqrt(2).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_two();
|
|
|
|
/// Return sqrt(3).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_three();
|
|
|
|
/// Return sqrt(5).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType root_five();
|
|
|
|
/// Return ln(2).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_two();
|
|
|
|
/// Return ln(10).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ten();
|
|
|
|
/// Return ln(ln(2)).
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ln_two();
|
|
|
|
/// Return 1 / 3.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType third();
|
|
|
|
/// Return 2 / 3.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType two_thirds();
|
|
|
|
/// Return the golden ratio constant.
|
|
/// @see gtc_constants
|
|
template<typename genType>
|
|
GLM_FUNC_DECL GLM_CONSTEXPR genType golden_ratio();
|
|
|
|
/// @}
|
|
} //namespace glm
|
|
|
|
#include "constants.inl"
|