0.9.6
Angle and Trigonometry Functions

Functions

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > acos (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > acosh (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > asin (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > asinh (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > atan (vecType< T, P > const &y, vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > atan (vecType< T, P > const &y_over_x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > atanh (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > cos (vecType< T, P > const &angle)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > cosh (vecType< T, P > const &angle)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > degrees (vecType< T, P > const &radians)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > radians (vecType< T, P > const &degrees)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > sin (vecType< T, P > const &angle)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > sinh (vecType< T, P > const &angle)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > tan (vecType< T, P > const &angle)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > tanh (vecType< T, P > const &angle)

Detailed Description

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.

Function Documentation

 GLM_FUNC_DECL vecType glm::acos ( vecType< T, P > 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.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL acos man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::acosh ( vecType< T, P > const & x )

Arc hyperbolic cosine; returns the non-negative inverse of cosh.

Results are undefined if x < 1.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL acosh man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::asin ( vecType< T, P > 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.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL asin man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::asinh ( vecType< T, P > const & x )

Arc hyperbolic sine; returns the inverse of sinh.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL asinh man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::atan ( vecType< T, P > const & y, vecType< T, P > 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.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL atan man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

Referenced by glm::atan2().

 GLM_FUNC_DECL vecType glm::atan ( vecType< T, P > 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].

Template Parameters
 genType Floating-point scalar or vector types.
GLSL atan man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::atanh ( vecType< T, P > const & x )

Arc hyperbolic tangent; returns the inverse of tanh.

Results are undefined if abs(x) >= 1.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL atanh man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::cos ( vecType< T, P > const & angle )

The standard trigonometric cosine function.

The values returned by this function will range from [-1, 1].

Template Parameters
 genType Floating-point scalar or vector types.
GLSL cos man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::cosh ( vecType< T, P > const & angle )

Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL cosh man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::degrees ( vecType< T, P > const & radians )

Converts radians to degrees and returns the result.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL degrees man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::radians ( vecType< T, P > const & degrees )

Converts degrees to radians and returns the result.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::sin ( vecType< T, P > const & angle )

The standard trigonometric sine function.

The values returned by this function will range from [-1, 1].

Template Parameters
 genType Floating-point scalar or vector types.
GLSL sin man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::sinh ( vecType< T, P > const & angle )

Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2.

Template Parameters
 genType Floating-point scalar or vector types.
GLSL sinh man page
GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions
 GLM_FUNC_DECL vecType glm::tan ( vecType< T, P > const & angle )

The standard trigonometric tangent function.

Template Parameters
 genType Floating-point scalar or vector types.