core_func_common Module Reference
Provides GLSL common functions
These all operate componentwise. The description is per component.
Include < glm/common.hpp > to use these core features.
Public Member Functions

GLM_FUNC_DECL GLM_CONSTEXPR genTypeabs (genType x)
Returns x if x >= 0; otherwise, it returns x.
genType
floatingpoint or signed integer; scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >abs (vec< L, T, Q > const &x)
Returns x if x >= 0; otherwise, it returns x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or signed integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >sign (vec< L, T, Q > const &x)
Returns 1.0 if x > 0, 0.0 if x == 0, or 1.0 if x < 0.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >floor (vec< L, T, Q > const &x)
Returns a value equal to the nearest integer that is less then or equal to x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >trunc (vec< L, T, Q > const &x)
Returns a value equal to the nearest integer to x whose absolute value is not larger than the absolute value of x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >round (vec< L, T, Q > 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.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >roundEven (vec< L, T, Q > 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.)
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >ceil (vec< L, T, Q > const &x)
Returns a value equal to the nearest integer that is greater than or equal to x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypefract (genType x)
Return x  floor(x).
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >fract (vec< L, T, Q > const &x)
Return x  floor(x).
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypemod (genType x, genType y)

GLM_FUNC_DECL vec< L, T, Q >mod (vec< L, T, Q > const &x, T y)

GLM_FUNC_DECL vec< L, T, Q >mod (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
Modulus. Returns x  y * floor(x / y) for each component in x using the floating point value y.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types, include glm/gtc/integer for integer scalar types support
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypemodf (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.
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR genTypemin (genType x, genType y)
Returns y if y < x; otherwise, it returns x.
genType
Floatingpoint or integer; scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >min (vec< L, T, Q > const &x, T y)
Returns y if y < x; otherwise, it returns x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >min (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
Returns y if y < x; otherwise, it returns x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR genTypemax (genType x, genType y)
Returns y if x < y; otherwise, it returns x.
genType
Floatingpoint or integer; scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >max (vec< L, T, Q > const &x, T y)
Returns y if x < y; otherwise, it returns x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >max (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
Returns y if x < y; otherwise, it returns x.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR genTypeclamp (genType x, genType minVal, genType maxVal)
Returns min(max(x, minVal), maxVal) for each component in x using the floatingpoint values minVal and maxVal.
genType
Floatingpoint or integer; scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >clamp (vec< L, T, Q > const &x, T minVal, T maxVal)
Returns min(max(x, minVal), maxVal) for each component in x using the floatingpoint values minVal and maxVal.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q >clamp (vec< L, T, Q > const &x, vec< L, T, Q > const &minVal, vec< L, T, Q > const &maxVal)
Returns min(max(x, minVal), maxVal) for each component in x using the floatingpoint values minVal and maxVal.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint or integer scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypeTmix (genTypeT x, genTypeT y, genTypeU 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 floatingpoint 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 'a' 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
 See Also
xValue to interpolate.
yValue to interpolate.
aInterpolant.
genTypeTFloating point scalar or vector.
genTypeUFloating 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 floatingpoint scalar two vectors. glm::vec4 s = glm::mix(g, h, b); // Returns 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.

GLM_FUNC_DECL vec< L, T, Q >mix (vec< L, T, Q > const &x, vec< L, T, Q > const &y, vec< L, U, Q > const &a)

GLM_FUNC_DECL vec< L, T, Q >mix (vec< L, T, Q > const &x, vec< L, T, Q > const &y, U a)

GLM_FUNC_DECL genTypestep (genType edge, genType x)
Returns 0.0 if x < edge, otherwise it returns 1.0 for each component of a genType.
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >step (T edge, vec< L, T, Q > const &x)
Returns 0.0 if x < edge, otherwise it returns 1.0.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >step (vec< L, T, Q > const &edge, vec< L, T, Q > const &x)
Returns 0.0 if x < edge, otherwise it returns 1.0.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypesmoothstep (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.
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >smoothstep (T edge0, T edge1, vec< L, T, Q > const &x)

GLM_FUNC_DECL vec< L, T, Q >smoothstep (vec< L, T, Q > const &edge0, vec< L, T, Q > const &edge1, vec< L, T, Q > const &x)

GLM_FUNC_DECL vec< L, bool, Q >isnan (vec< L, T, Q > 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.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL vec< L, bool, Q >isinf (vec< L, T, Q > 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.
L
Integer between 1 and 4 included that qualify the dimension of the vector
TFloatingpoint scalar types
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL intfloatBitsToInt (float const &v)
Returns a signed integer value representing the encoding of a floatingpoint value. The floatingpoint value's bitlevel representation is preserved.
 See Also
 See Also

GLM_FUNC_DECL vec< L, int, Q >floatBitsToInt (vec< L, float, Q > const &v)
Returns a signed integer value representing the encoding of a floatingpoint value. The floatingpoint value's bitlevel representation is preserved.
L
Integer between 1 and 4 included that qualify the dimension of the vector
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL uintfloatBitsToUint (float const &v)
Returns a unsigned integer value representing the encoding of a floatingpoint value. The floatingpoint value's bitlevel representation is preserved.
 See Also
 See Also

GLM_FUNC_DECL vec< L, uint, Q >floatBitsToUint (vec< L, float, Q > const &v)
Returns a unsigned integer value representing the encoding of a floatingpoint value. The floatingpoint value's bitlevel representation is preserved.
L
Integer between 1 and 4 included that qualify the dimension of the vector
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL floatintBitsToFloat (int const &v)
Returns a floatingpoint value corresponding to a signed integer encoding of a floatingpoint value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bitlevel representation is preserved.
 See Also
 See Also

GLM_FUNC_DECL vec< L, float, Q >intBitsToFloat (vec< L, int, Q > const &v)
Returns a floatingpoint value corresponding to a signed integer encoding of a floatingpoint value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bitlevel representation is preserved.
L
Integer between 1 and 4 included that qualify the dimension of the vector
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL floatuintBitsToFloat (uint const &v)
Returns a floatingpoint value corresponding to a unsigned integer encoding of a floatingpoint value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bitlevel representation is preserved.
 See Also
 See Also

GLM_FUNC_DECL vec< L, float, Q >uintBitsToFloat (vec< L, uint, Q > const &v)
Returns a floatingpoint value corresponding to a unsigned integer encoding of a floatingpoint value. If an inf or NaN is passed in, it will not signal, and the resulting floating point value is unspecified. Otherwise, the bitlevel representation is preserved.
L
Integer between 1 and 4 included that qualify the dimension of the vector
QValue from qualifier enum
 See Also
 See Also

GLM_FUNC_DECL genTypefma (genType const &a, genType const &b, genType const &c)
Computes and returns a * b + c.
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL genTypefrexp (genType x, int &exp)
Splits x into a floatingpoint 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 floatingpoint value of zero, the significant and exponent are both zero. For a floatingpoint value that is an infinity or is not a number, the results are undefined.
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >frexp (vec< L, T, Q > const &v, vec< L, int, Q > &exp)

GLM_FUNC_DECL genTypeldexp (genType const &x, int const &exp)
Builds a floatingpoint 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 floatingpoint type, the result is undefined.
genType
Floatingpoint scalar or vector types.
 See Also
 See Also

GLM_FUNC_DECL vec< L, T, Q >ldexp (vec< L, T, Q > const &v, vec< L, int, Q > const &exp)