blob: 719cff0bd932b5e18ca414a6e0e6df22ccb8f84f [file] [log] [blame]
 /// @ref core /// @file glm/detail/func_trigonometric.hpp /// /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions /// /// @defgroup core_func_trigonometric Angle and Trigonometry Functions /// @ingroup core /// /// Function parameters specified as angle are assumed to be in units of radians. /// In no case will any of these functions result in a divide by zero error. If /// the divisor of a ratio is 0, then results will be undefined. /// /// These all operate component-wise. The description is per component. #pragma once #include "setup.hpp" #include "precision.hpp" namespace glm { /// @addtogroup core_func_trigonometric /// @{ /// Converts degrees to radians and returns the result. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL radians man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL GLM_CONSTEXPR vecType radians(vecType const & degrees); /// Converts radians to degrees and returns the result. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL degrees man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL GLM_CONSTEXPR vecType degrees(vecType const & radians); /// The standard trigonometric sine function. /// The values returned by this function will range from [-1, 1]. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL sin man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType sin(vecType const & angle); /// The standard trigonometric cosine function. /// The values returned by this function will range from [-1, 1]. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL cos man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType cos(vecType const & angle); /// The standard trigonometric tangent function. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL tan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType tan(vecType const & angle); /// Arc sine. Returns an angle whose sine is x. /// The range of values returned by this function is [-PI/2, PI/2]. /// Results are undefined if |x| > 1. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL asin man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType asin(vecType const & x); /// Arc cosine. Returns an angle whose sine is x. /// The range of values returned by this function is [0, PI]. /// Results are undefined if |x| > 1. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL acos man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType acos(vecType const & x); /// Arc tangent. Returns an angle whose tangent is y/x. /// The signs of x and y are used to determine what /// quadrant the angle is in. The range of values returned /// by this function is [-PI, PI]. Results are undefined /// if x and y are both 0. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL atan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType atan(vecType const & y, vecType const & x); /// Arc tangent. Returns an angle whose tangent is y_over_x. /// The range of values returned by this function is [-PI/2, PI/2]. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL atan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType atan(vecType const & y_over_x); /// Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2 /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL sinh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType sinh(vecType const & angle); /// Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2 /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL cosh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType cosh(vecType const & angle); /// Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL tanh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType tanh(vecType const & angle); /// Arc hyperbolic sine; returns the inverse of sinh. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL asinh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType asinh(vecType const & x); /// Arc hyperbolic cosine; returns the non-negative inverse /// of cosh. Results are undefined if x < 1. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL acosh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType acosh(vecType const & x); /// Arc hyperbolic tangent; returns the inverse of tanh. /// Results are undefined if abs(x) >= 1. /// /// @tparam genType Floating-point scalar or vector types. /// /// @see GLSL atanh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions template class vecType> GLM_FUNC_DECL vecType atanh(vecType const & x); /// @} }//namespace glm #include "func_trigonometric.inl"