Collaboration diagram for Common functions:

Functions
template<typename genType >
GLM_FUNC_DECL genType	glm::abs (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::ceil (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::clamp (genType const &x, genType const &minVal, genType const &maxVal)
template<typename genType , precision P>
GLM_FUNC_DECL genType	glm::clamp (genType const &x, typename genType::value_type const &minVal, typename genType::value_type const &maxVal)
GLM_FUNC_DECL int	glm::floatBitsToInt (float const &v)
template<template< typename, precision > class vecType, precision P>
GLM_FUNC_DECL vecType< int, P >	glm::floatBitsToInt (vecType< float, P > const &v)
GLM_FUNC_DECL uint	glm::floatBitsToUint (float const &v)
template<template< typename, precision > class vecType, precision P>
GLM_FUNC_DECL vecType< uint, P >	glm::floatBitsToUint (vecType< float, P > const &v)
template<typename genType >
GLM_FUNC_DECL genType	glm::floor (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::fma (genType const &a, genType const &b, genType const &c)
template<typename genType >
GLM_FUNC_DECL genType	glm::fract (genType const &x)
template<typename genType , typename genIType >
GLM_FUNC_DECL genType	glm::frexp (genType const &x, genIType &exp)
GLM_FUNC_DECL float	glm::intBitsToFloat (int const &v)
template<template< typename, precision > class vecType, precision P>
GLM_FUNC_DECL vecType< float, P >	glm::intBitsToFloat (vecType< int, P > const &v)
template<typename genType >
GLM_FUNC_DECL genType::bool_type	glm::isinf (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType::bool_type	glm::isnan (genType const &x)
template<typename genType , typename genIType >
GLM_FUNC_DECL genType	glm::ldexp (genType const &x, genIType const &exp)
template<typename genType >
GLM_FUNC_DECL genType	glm::max (genType const &x, genType const &y)
template<typename genType >
GLM_FUNC_DECL genType	glm::max (genType const &x, typename genType::value_type const &y)
template<typename genType >
GLM_FUNC_DECL genType	glm::min (genType const &x, genType const &y)
template<typename genType >
GLM_FUNC_DECL genType	glm::min (genType const &x, typename genType::value_type const &y)
template<typename T , typename U , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P >	glm::mix (vecType< T, P > const &x, vecType< T, P > const &y, vecType< U, P > const &a)
template<typename T , typename U , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P >	glm::mix (vecType< T, P > const &x, vecType< T, P > const &y, U const &a)
template<typename genTypeT , typename genTypeU >
GLM_FUNC_DECL genTypeT	glm::mix (genTypeT const &x, genTypeT const &y, genTypeU const &a)
template<typename genType >
GLM_FUNC_DECL genType	glm::mod (genType const &x, genType const &y)
template<typename genType >
GLM_FUNC_DECL genType	glm::mod (genType const &x, typename genType::value_type const &y)
template<typename genType >
GLM_FUNC_DECL genType	glm::modf (genType const &x, genType &i)
template<typename genType >
GLM_FUNC_DECL genType	glm::round (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::roundEven (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::sign (genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::smoothstep (genType const &edge0, genType const &edge1, genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::smoothstep (typename genType::value_type const &edge0, typename genType::value_type const &edge1, genType const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::step (genType const &edge, genType const &x)
template<template< typename, precision > class vecType, typename T , precision P>
GLM_FUNC_DECL vecType< T, P >	glm::step (T const &edge, vecType< T, P > const &x)
template<typename genType >
GLM_FUNC_DECL genType	glm::trunc (genType const &x)
GLM_FUNC_DECL float	glm::uintBitsToFloat (uint const &v)
template<template< typename, precision > class vecType, precision P>
GLM_FUNC_DECL vecType< float, P >	glm::uintBitsToFloat (vecType< uint, P > const &v)

Detailed Description

These all operate component-wise. The description is per component.

Function Documentation

template<typename genType >

GLM_FUNC_DECL genType glm::abs ( genType const & x )

Returns x if x >= 0; otherwise, it returns -x.

Template Parameters:

genType floating-point or signed integer; scalar or vector types.

See also:: GLSL abs man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::ceil ( genType const & x )

Returns a value equal to the nearest integer that is greater than or equal to x.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL ceil man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::clamp	(	genType const &	x,
		genType const &	minVal,
		genType const &	maxVal
	)

Returns min(max(x, minVal), maxVal) for each component in x using the floating-point values minVal and maxVal.

Template Parameters:

genType Floating-point or integer; scalar or vector types.

See also:: GLSL clamp man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType , precision P>

GLM_FUNC_DECL genType glm::clamp	(	genType const &	x,
		typename genType::value_type const &	minVal,
		typename genType::value_type const &	maxVal
	)

GLM_FUNC_DECL int glm::floatBitsToInt ( float const & v )

Returns a signed integer value representing the encoding of a floating-point value. The floating-point value's bit-level representation is preserved.

See also:: GLSL floatBitsToInt man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<template< typename, precision > class vecType, precision P>

GLM_FUNC_DECL vecType<int, P> glm::floatBitsToInt ( vecType< float, P > const & v )

Returns a signed integer value representing the encoding of a floating-point value. The floatingpoint value's bit-level representation is preserved.

See also:: GLSL floatBitsToInt man page; GLSL 4.20.8 specification, section 8.3 Common Functions

GLM_FUNC_DECL uint glm::floatBitsToUint ( float const & v )

Returns a unsigned integer value representing the encoding of a floating-point value. The floatingpoint value's bit-level representation is preserved.

See also:: GLSL floatBitsToUint man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<template< typename, precision > class vecType, precision P>

GLM_FUNC_DECL vecType<uint, P> glm::floatBitsToUint ( vecType< float, P > const & v )

Returns a unsigned integer value representing the encoding of a floating-point value. The floatingpoint value's bit-level representation is preserved.

See also:: GLSL floatBitsToUint man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::floor ( genType const & x )

Returns a value equal to the nearest integer that is less then or equal to x.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL floor man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::fma	(	genType const &	a,
		genType const &	b,
		genType const &	c
	)

Computes and returns a * b + c.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL fma man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::fract ( genType const & x )

Return x - floor(x).

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL fract man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType , typename genIType >

GLM_FUNC_DECL genType glm::frexp	(	genType const &	x,
		genIType &	exp
	)

Splits x into a floating-point significand in the range [0.5, 1.0) and an integral exponent of two, such that: x = significand * exp(2, exponent)

The significand is returned by the function and the exponent is returned in the parameter exp. For a floating-point value of zero, the significant and exponent are both zero. For a floating-point value that is an infinity or is not a number, the results are undefined.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL frexp man page; GLSL 4.20.8 specification, section 8.3 Common Functions

GLM_FUNC_DECL float glm::intBitsToFloat ( int const & v )

Returns a floating-point value corresponding to a signed integer encoding of a floating-point value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bit-level representation is preserved.

See also:: GLSL intBitsToFloat man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<template< typename, precision > class vecType, precision P>

GLM_FUNC_DECL vecType<float, P> glm::intBitsToFloat ( vecType< int, P > const & v )

Returns a floating-point value corresponding to a signed integer encoding of a floating-point value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bit-level representation is preserved.

See also:: GLSL intBitsToFloat man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType::bool_type glm::isinf ( genType const & x )

Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no infinity representations.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL isinf man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType::bool_type glm::isnan ( genType const & x )

Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no NaN representations.

/!\ When using compiler fast math, this function may fail.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL isnan man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType , typename genIType >

GLM_FUNC_DECL genType glm::ldexp	(	genType const &	x,
		genIType const &	exp
	)

Builds a floating-point number from x and the corresponding integral exponent of two in exp, returning: significand * exp(2, exponent)

If this product is too large to be represented in the floating-point type, the result is undefined.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL ldexp man page;; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::max	(	genType const &	x,
		genType const &	y
	)

Returns y if x < y; otherwise, it returns x.

Template Parameters:

genType Floating-point or integer; scalar or vector types.

See also:: GLSL max man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::max	(	genType const &	x,
		typename genType::value_type const &	y
	)

template<typename genType >

GLM_FUNC_DECL genType glm::min	(	genType const &	x,
		genType const &	y
	)

Returns y if y < x; otherwise, it returns x.

Template Parameters:

genType Floating-point or integer; scalar or vector types.

See also:: GLSL min man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::min	(	genType const &	x,
		typename genType::value_type const &	y
	)

template<typename T , typename U , precision P, template< typename, precision > class vecType>

GLM_FUNC_DECL vecType<T, P> glm::mix	(	vecType< T, P > const &	x,
		vecType< T, P > const &	y,
		vecType< U, P > const &	a
	)

If genTypeU is a floating scalar or vector: Returns x * (1.0 - a) + y * a, i.e., the linear blend of x and y using the floating-point value a. The value for a is not restricted to the range [0, 1].

If genTypeU is a boolean scalar or vector: Selects which vector each returned component comes from. For a component of that is false, the corresponding component of x is returned. For a component of a that is true, the corresponding component of y is returned. Components of x and y that are not selected are allowed to be invalid floating point values and will have no effect on the results. Thus, this provides different functionality than genType mix(genType x, genType y, genType(a)) where a is a Boolean vector.

See also:: GLSL mix man page; GLSL 4.20.8 specification, section 8.3 Common Functions

Parameters:

[in]	x	Value to interpolate.
[in]	y	Value to interpolate.
[in]	a	Interpolant.

Template Parameters:

genTypeT	Floating point scalar or vector.
genTypeU	Floating point or boolean scalar or vector. It can't be a vector if it is the length of genTypeT.

 #include <glm/glm.hpp>
 ...
 float a;
 bool b;
 glm::dvec3 e;
 glm::dvec3 f;
 glm::vec4 g;
 glm::vec4 h;
 ...
 glm::vec4 r = glm::mix(g, h, a); // Interpolate with a floating-point scalar two vectors. 
 glm::vec4 s = glm::mix(g, h, b); // Teturns g or h;
 glm::dvec3 t = glm::mix(e, f, a); // Types of the third parameter is not required to match with the first and the second.
 glm::vec4 u = glm::mix(g, h, r); // Interpolations can be perform per component with a vector for the last parameter.

template<typename T , typename U , precision P, template< typename, precision > class vecType>

GLM_FUNC_DECL vecType<T, P> glm::mix	(	vecType< T, P > const &	x,
		vecType< T, P > const &	y,
		U const &	a
	)

template<typename genTypeT , typename genTypeU >

GLM_FUNC_DECL genTypeT glm::mix	(	genTypeT const &	x,
		genTypeT const &	y,
		genTypeU const &	a
	)

template<typename genType >

GLM_FUNC_DECL genType glm::mod	(	genType const &	x,
		genType const &	y
	)

Modulus. Returns x - y * floor(x / y) for each component in x using the floating point value y.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL mod man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::mod	(	genType const &	x,
		typename genType::value_type const &	y
	)

Modulus. Returns x - y * floor(x / y) for each component in x using the floating point value y.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL mod man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::modf	(	genType const &	x,
		genType &	i
	)

Returns the fractional part of x and sets i to the integer part (as a whole number floating point value). Both the return value and the output parameter will have the same sign as x.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL modf man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::round ( genType const & x )

Returns a value equal to the nearest integer to x. The fraction 0.5 will round in a direction chosen by the implementation, presumably the direction that is fastest. This includes the possibility that round(x) returns the same value as roundEven(x) for all values of x.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL round man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::roundEven ( genType const & x )

Returns a value equal to the nearest integer to x. A fractional part of 0.5 will round toward the nearest even integer. (Both 3.5 and 4.5 for x will return 4.0.)

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL roundEven man page; GLSL 4.20.8 specification, section 8.3 Common Functions; New round to even technique

template<typename genType >

GLM_FUNC_DECL genType glm::sign ( genType const & x )

Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0.

Template Parameters:

genType Floating-point or signed integer; scalar or vector types.

See also:: GLSL sign man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::smoothstep	(	genType const &	edge0,
		genType const &	edge1,
		genType const &	x
	)

Returns 0.0 if x <= edge0 and 1.0 if x >= edge1 and performs smooth Hermite interpolation between 0 and 1 when edge0 < x < edge1. This is useful in cases where you would want a threshold function with a smooth transition. This is equivalent to: genType t; t = clamp ((x - edge0) / (edge1 - edge0), 0, 1); return t * t * (3 - 2 * t); Results are undefined if edge0 >= edge1.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL smoothstep man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::smoothstep	(	typename genType::value_type const &	edge0,
		typename genType::value_type const &	edge1,
		genType const &	x
	)

template<typename genType >

GLM_FUNC_DECL genType glm::step	(	genType const &	edge,
		genType const &	x
	)

Returns 0.0 if x < edge, otherwise it returns 1.0 for each component of a genType.

See also:: GLSL step man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<template< typename, precision > class vecType, typename T , precision P>

GLM_FUNC_DECL vecType<T, P> glm::step	(	T const &	edge,
		vecType< T, P > const &	x
	)

Returns 0.0 if x < edge, otherwise it returns 1.0.

See also:: GLSL step man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<typename genType >

GLM_FUNC_DECL genType glm::trunc ( genType const & x )

Returns a value equal to the nearest integer to x whose absolute value is not larger than the absolute value of x.

Template Parameters:

genType Floating-point scalar or vector types.

See also:: GLSL trunc man page; GLSL 4.20.8 specification, section 8.3 Common Functions

GLM_FUNC_DECL float glm::uintBitsToFloat ( uint const & v )

Returns a floating-point value corresponding to a unsigned integer encoding of a floating-point value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bit-level representation is preserved.

See also:: GLSL uintBitsToFloat man page; GLSL 4.20.8 specification, section 8.3 Common Functions

template<template< typename, precision > class vecType, precision P>

GLM_FUNC_DECL vecType<float, P> glm::uintBitsToFloat ( vecType< uint, P > const & v )

Returns a floating-point value corresponding to a unsigned integer encoding of a floating-point value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bit-level representation is preserved.

See also:: GLSL uintBitsToFloat man page; GLSL 4.20.8 specification, section 8.3 Common Functions

Functions

Detailed Description

Function Documentation