detail_func_trigonometric

global functions

glm::acos(...)

vecType< T, P > glm::acos(const vecType< T, P > &x=P)

Documentation from code comments


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.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL acos man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::acosh(...)

vecType< T, P > glm::acosh(const vecType< T, P > &x=P)

Documentation from code comments


Arc hyperbolic cosine; returns the non-negative inverse of cosh. Results are undefined if x < 1.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL acosh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::asin(...)

vecType< T, P > glm::asin(const vecType< T, P > &x=P)

Documentation from code comments


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.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL asin man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::asinh(...)

vecType< T, P > glm::asinh(const vecType< T, P > &x=P)

Documentation from code comments


Arc hyperbolic sine; returns the inverse of sinh.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL asinh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::atan(...)

vecType< T, P > glm::atan(const vecType< T, P > &y=P, const vecType< T, P > &x=P)

Documentation from code comments


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.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL atan man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::atan(...)

vecType< T, P > glm::atan(const vecType< T, P > &y_over_x=P)

Documentation from code comments


Arc tangent. Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL atan man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::atanh(...)

vecType< T, P > glm::atanh(const vecType< T, P > &x=P)

Documentation from code comments


Arc hyperbolic tangent; returns the inverse of tanh. Results are undefined if abs(x) >= 1.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL atanh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::cos(...)

vecType< T, P > glm::cos(const vecType< T, P > &angle=P)

Documentation from code comments


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

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL cos man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::cosh(...)

vecType< T, P > glm::cosh(const vecType< T, P > &angle=P)

Documentation from code comments


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

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL cosh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::degrees(...)

vecType< T, P > glm::degrees(const vecType< T, P > &radians=P)

Documentation from code comments


Converts radians to degrees and returns the result.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL degrees man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::radians(...)

vecType< T, P > glm::radians(const vecType< T, P > &degrees=P)

Documentation from code comments


Converts degrees to radians and returns the result.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL radians man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::sin(...)

vecType< T, P > glm::sin(const vecType< T, P > &angle=P)

Documentation from code comments


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

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL sin man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::sinh(...)

vecType< T, P > glm::sinh(const vecType< T, P > &angle=P)

Documentation from code comments


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

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL sinh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::tan(...)

vecType< T, P > glm::tan(const vecType< T, P > &angle=P)

Documentation from code comments


The standard trigonometric tangent function.

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL tan man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

glm::tanh(...)

vecType< T, P > glm::tanh(const vecType< T, P > &angle=P)

Documentation from code comments


Returns the hyperbolic tangent function, sinh(angle) / cosh(angle)

Type parameters:

genType Floating-point scalar or vector types.

See also: GLSL tanh man page

See also: GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions

If you have any doubt about the usage of this module you can ask in the forum.

If you want to contribute better documentation or start documenting this section you can do so here

If you find anything wrong with this docs you can report any error by opening an issue