0.9.8: Common functions

| 0.9.8

- Main Page
- Modules
- Files

Functions
Common functions
GLM Core

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

## Detailed Description

These all operate component-wise.

The description is per component.

## Function Documentation

GLM_FUNC_DECL genType glm::abs | ( | genType | 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

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

GLM_FUNC_DECL genType glm::clamp | ( | genType | x,
|  | genType | minVal,
|  | genType | 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

Referenced by glm::saturate().

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

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

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

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

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

GLM_FUNC_DECL genType glm::fract | ( | genType | 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

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

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

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

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

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

GLM_FUNC_DECL genType glm::max | ( | genType | x,
|  | genType | 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

GLM_FUNC_DECL genType glm::min | ( | genType | x,
|  | genType | 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

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.

Referenced by glm::lerp().

GLM_FUNC_DECL genType glm::mod | ( | genType | x,
|  | genType | 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

GLM_FUNC_DECL genType glm::modf | ( | genType | 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

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

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

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

GLM_FUNC_DECL genType glm::smoothstep | ( | genType | edge0,
|  | genType | edge1,
|  | genType | 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

GLM_FUNC_DECL genType glm::step | ( | genType | edge,
|  | genType | 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

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

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

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

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