Namespaces | Typedefs | Enumerations | Functions

glm Namespace Reference

GLM namespace, it contains all GLSL based features. More...

Namespaces

namespace  core
namespace  gtc
namespace  gtx
namespace  virtrev

Typedefs

typedef detail::tvec2< bool > bvec2
typedef detail::tvec3< bool > bvec3
typedef detail::tvec4< bool > bvec4
typedef detail::tmat2x2< double > dmat2
typedef detail::tmat2x2< double > dmat2x2
typedef detail::tmat2x3< double > dmat2x3
typedef detail::tmat2x4< double > dmat2x4
typedef detail::tmat3x3< double > dmat3
typedef detail::tmat3x2< double > dmat3x2
typedef detail::tmat3x3< double > dmat3x3
typedef detail::tmat3x4< double > dmat3x4
typedef detail::tmat4x4< double > dmat4
typedef detail::tmat4x2< double > dmat4x2
typedef detail::tmat4x3< double > dmat4x3
typedef detail::tmat4x4< double > dmat4x4
typedef detail::tvec2< double > dvec2
typedef detail::tvec3< double > dvec3
typedef detail::tvec4< double > dvec4
typedef precision::mediump_ivec2 ivec2
typedef precision::mediump_ivec3 ivec3
typedef precision::mediump_ivec4 ivec4
typedef mat2x2 mat2
typedef precision::mediump_mat2x2 mat2x2
typedef precision::mediump_mat2x3 mat2x3
typedef precision::mediump_mat2x4 mat2x4
typedef mat3x3 mat3
typedef precision::mediump_mat3x2 mat3x2
typedef precision::mediump_mat3x3 mat3x3
typedef precision::mediump_mat3x4 mat3x4
typedef mat4x4 mat4
typedef precision::mediump_mat4x2 mat4x2
typedef precision::mediump_mat4x3 mat4x3
typedef precision::mediump_mat4x4 mat4x4
typedef precision::mediump_uvec2 uvec2
typedef precision::mediump_uvec3 uvec3
typedef precision::mediump_uvec4 uvec4
typedef precision::mediump_vec3 vec3
typedef precision::mediump_vec4 vec4

Enumerations

enum  comp { , T = 1 }

Functions

template<template< typename > class vecType>
GLM_FUNC_QUALIFIER bool all (vecType< bool > const &v)
template<template< typename > class vecType>
GLM_FUNC_QUALIFIER bool any (vecType< bool > const &v)
template<typename genType >
genType ceil (genType const &x)
template<typename genType >
genType clamp (genType const &x, genType const &minVal, genType const &maxVal)
template<typename T , template< typename > class vecType>
GLM_FUNC_QUALIFIER vecType< T >
::bool_type 		equal (vecType< T > const &x, vecType< T > const &y)
template<typename genType , typename genIType >
genIType floatBitsToInt (genType const &value)
template<typename genType , typename genUType >
genUType floatBitsToUint (genType const &value)
template<typename genType >
genType floor (genType const &x)
template<typename genType >
genType fma (genType const &a, genType const &b, genType const &c)
template<typename genType >
genType fract (genType const &x)
template<typename genType , typename genIType >
genType frexp (genType const &x, genIType &exp)
template<typename T , template< typename > class vecType>
GLM_FUNC_QUALIFIER vecType< T >
::bool_type 		greaterThan (vecType< T > const &x, vecType< T > const &y)
template<typename T , template< typename > class vecType>
GLM_FUNC_QUALIFIER vecType< T >
::bool_type 		greaterThanEqual (vecType< T > const &x, vecType< T > const &y)
template<typename genType , typename genIType >
genType intBitsToFloat (genIType const &value)
template<typename genType >
genType::bool_type isinf (genType const &x)
template<typename genType >
genType::bool_type isnan (genType const &x)
template<typename genType , typename genIType >
genType ldexp (genType const &x, genIType const &exp)
template<typename genType >
genType max (genType const &x, genType const &y)
template<typename genType >
genType min (genType const &x, genType const &y)
template<typename genTypeT , typename genTypeU >
genTypeT mix (genTypeT const &x, genTypeT const &y, genTypeU const &a)
template<typename genType >
genType mod (genType const &x, typename genType::value_type const &y)
template<typename genType >
genType mod (genType const &x, genType const &y)
template<typename genType >
genType modf (genType const &x, genType &i)
template<template< typename > class vecType>
GLM_FUNC_QUALIFIER vecType< bool > not_ (vecType< bool > const &v)
template<typename T , template< typename > class vecType>
GLM_FUNC_QUALIFIER vecType< T >
::bool_type 		notEqual (vecType< T > const &x, vecType< T > const &y)
template<typename genType >
genType round (genType const &x)
template<typename genType >
genType roundEven (genType const &x)
template<typename genFIType >
genFIType sign (genFIType const &x)
template<typename genType >
genType smoothstep (genType const &edge0, genType const &edge1, genType const &x)
template<typename genType >
genType step (genType const &edge, genType const &x)
template<typename genType >
genType trunc (genType const &x)
template<typename genType , typename genUType >
genType uintBitsToFloat (genUType const &value)

Detailed Description

GLM namespace, it contains all GLSL based features.

Enumeration Type Documentation

enum comp
Enumerator:
T 

Returns the component-wise comparison of result x <= y.

Definition at line 15 of file _swizzle.hpp.

Function Documentation

GLM_FUNC_QUALIFIER bool glm::all ( vecType< bool > const &  v)

Returns true if all components of x are true.

Definition at line 177 of file func_vector_relational.hpp.

GLM_FUNC_QUALIFIER bool glm::any ( vecType< bool > const &  v)

Returns true if any component of x is true.

Definition at line 161 of file func_vector_relational.hpp.

genType glm::ceil ( genType const &  x)

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

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.

Referenced by glm::gtx::compatibility::saturate().

GLM_FUNC_QUALIFIER vecType<T>::bool_type glm::equal ( vecType< T > const &  x,
vecType< T > const &  y 
)

Returns the component-wise comparison of result x == y.

Definition at line 122 of file func_vector_relational.hpp.

genIType glm::floatBitsToInt ( genType const &  value)

Returns a signed integer value representing the encoding of a floating-point value.

The floatingpoint value's bit-level representation is preserved.

genUType glm::floatBitsToUint ( genType const &  value)

Returns a unsigned integer value representing the encoding of a floating-point value.

The floatingpoint value's bit-level representation is preserved.

genType glm::floor ( genType const &  x)

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

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

Computes and returns a * b + c.

genType glm::fract ( genType const &  x)

Return x - floor(x).

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.

GLM_FUNC_QUALIFIER vecType<T>::bool_type glm::greaterThan ( vecType< T > const &  x,
vecType< T > const &  y 
)

Returns the component-wise comparison of result x > y.

Definition at line 78 of file func_vector_relational.hpp.

GLM_FUNC_QUALIFIER vecType<T>::bool_type glm::greaterThanEqual ( vecType< T > const &  x,
vecType< T > const &  y 
)

Returns the component-wise comparison of result x >= y.

Definition at line 100 of file func_vector_relational.hpp.

genType glm::intBitsToFloat ( genIType const &  value)

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.

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.

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.

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.

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

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

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

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

genTypeT glm::mix ( genTypeT const &  x,
genTypeT const &  y,
genTypeU const &  a 
)
Returns:
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 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.
Parameters:
[in]xFloating point scalar or vector.
[in]yFloating point scalar or vector.
[in]aFloating point or boolean scalar or vector.

Referenced by glm::gtx::compatibility::lerp().

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.

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.

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.

GLM_FUNC_QUALIFIER vecType<bool> glm::not_ ( vecType< bool > const &  v)

Returns the component-wise logical complement of x.

/!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.

Definition at line 194 of file func_vector_relational.hpp.

GLM_FUNC_QUALIFIER vecType<T>::bool_type glm::notEqual ( vecType< T > const &  x,
vecType< T > const &  y 
)

Returns the component-wise comparison of result x != y.

Definition at line 142 of file func_vector_relational.hpp.

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.

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.)

genFIType glm::sign ( genFIType const &  x)

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

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.

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

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

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.

genType glm::uintBitsToFloat ( genUType const &  value)

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.

Generated by  doxygen 1.7.3