 |
0.9.9 API documentation
|
|
0.9.9 API documentation
|
Function parameters specified as angle are assumed to be in units of radians. More...
Functions | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | acos (vec< L, T, Q > const &x) |
| Arc cosine. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | acosh (vec< L, T, Q > const &x) |
| Arc hyperbolic cosine; returns the non-negative inverse of cosh. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | asin (vec< L, T, Q > const &x) |
| Arc sine. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | asinh (vec< L, T, Q > const &x) |
| Arc hyperbolic sine; returns the inverse of sinh. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | atan (vec< L, T, Q > const &y, vec< L, T, Q > const &x) |
| Arc tangent. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | atan (vec< L, T, Q > const &y_over_x) |
| Arc tangent. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | atanh (vec< L, T, Q > const &x) |
| Arc hyperbolic tangent; returns the inverse of tanh. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | cos (vec< L, T, Q > const &angle) |
| The standard trigonometric cosine function. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | cosh (vec< L, T, Q > const &angle) |
| Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > | degrees (vec< L, T, Q > const &radians) |
| Converts radians to degrees and returns the result. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > | radians (vec< L, T, Q > const °rees) |
| Converts degrees to radians and returns the result. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | sin (vec< L, T, Q > const &angle) |
| The standard trigonometric sine function. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | sinh (vec< L, T, Q > const &angle) |
| Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | tan (vec< L, T, Q > const &angle) |
| The standard trigonometric tangent function. | |
| template<length_t L, typename T , qualifier Q> | |
| GLM_FUNC_DECL vec< L, T, Q > | tanh (vec< L, T, Q > const &angle) |
| Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) | |
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.
Include <glm/trigonometric.hpp> to use these core features.
| GLM_FUNC_DECL vec< L, T, Q > acos | ( | vec< L, T, Q > 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.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > acosh | ( | vec< L, T, Q > const & | x | ) |
Arc hyperbolic cosine; returns the non-negative inverse of cosh.
Results are undefined if x < 1.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > asin | ( | vec< L, T, Q > const & | x | ) |
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.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > asinh | ( | vec< L, T, Q > const & | x | ) |
Arc hyperbolic sine; returns the inverse of sinh.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > atan | ( | vec< L, T, Q > const & | y, |
| vec< L, T, Q > 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.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
Referenced by glm::atan2(), glm::atan2(), glm::atan2(), and glm::atan2().
| GLM_FUNC_DECL vec< L, T, Q > atan | ( | vec< L, T, Q > const & | y_over_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].
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > atanh | ( | vec< L, T, Q > const & | x | ) |
Arc hyperbolic tangent; returns the inverse of tanh.
Results are undefined if abs(x) >= 1.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > cos | ( | vec< L, T, Q > const & | angle | ) |
The standard trigonometric cosine function.
The values returned by this function will range from [-1, 1].
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > cosh | ( | vec< L, T, Q > const & | angle | ) |
Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > degrees | ( | vec< L, T, Q > const & | radians | ) |
Converts radians to degrees and returns the result.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > radians | ( | vec< L, T, Q > const & | degrees | ) |
Converts degrees to radians and returns the result.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > sin | ( | vec< L, T, Q > const & | angle | ) |
The standard trigonometric sine function.
The values returned by this function will range from [-1, 1].
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > sinh | ( | vec< L, T, Q > const & | angle | ) |
Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > tan | ( | vec< L, T, Q > const & | angle | ) |
The standard trigonometric tangent function.
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
| GLM_FUNC_DECL vec< L, T, Q > tanh | ( | vec< L, T, Q > const & | angle | ) |
Returns the hyperbolic tangent function, sinh(angle) / cosh(angle)
| L | Integer between 1 and 4 included that qualify the dimension of the vector |
| T | Floating-point scalar types |
| Q | Value from qualifier enum |
1.9.8