0.9.8 API documenation
compatibility.hpp
Go to the documentation of this file.
1 
13 #pragma once
14 
15 // Dependency:
16 #include "../glm.hpp"
17 #include "../gtc/quaternion.hpp"
18 
19 #ifndef GLM_ENABLE_EXPERIMENTAL
20 # error "GLM: GLM_GTX_compatibility is an experimetal extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."
21 #endif
22 
23 #if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)
24 # pragma message("GLM: GLM_GTX_compatibility extension included")
25 #endif
26 
27 #if GLM_COMPILER & GLM_COMPILER_VC
28 # include <cfloat>
29 #elif GLM_COMPILER & GLM_COMPILER_GCC
30 # include <cmath>
31 # if(GLM_PLATFORM & GLM_PLATFORM_ANDROID)
32 # undef isfinite
33 # endif
34 #endif//GLM_COMPILER
35 
36 namespace glm
37 {
40 
41  template <typename T> GLM_FUNC_QUALIFIER T lerp(T x, T y, T a){return mix(x, y, a);}
42  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec2<T, P> lerp(const tvec2<T, P>& x, const tvec2<T, P>& y, T a){return mix(x, y, a);}
43 
44  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec3<T, P> lerp(const tvec3<T, P>& x, const tvec3<T, P>& y, T a){return mix(x, y, a);}
45  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec4<T, P> lerp(const tvec4<T, P>& x, const tvec4<T, P>& y, T a){return mix(x, y, a);}
46  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec2<T, P> lerp(const tvec2<T, P>& x, const tvec2<T, P>& y, const tvec2<T, P>& a){return mix(x, y, a);}
47  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec3<T, P> lerp(const tvec3<T, P>& x, const tvec3<T, P>& y, const tvec3<T, P>& a){return mix(x, y, a);}
48  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec4<T, P> lerp(const tvec4<T, P>& x, const tvec4<T, P>& y, const tvec4<T, P>& a){return mix(x, y, a);}
49 
50  template <typename T, precision P> GLM_FUNC_QUALIFIER T saturate(T x){return clamp(x, T(0), T(1));}
51  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec2<T, P> saturate(const tvec2<T, P>& x){return clamp(x, T(0), T(1));}
52  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec3<T, P> saturate(const tvec3<T, P>& x){return clamp(x, T(0), T(1));}
53  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec4<T, P> saturate(const tvec4<T, P>& x){return clamp(x, T(0), T(1));}
54 
55  template <typename T, precision P> GLM_FUNC_QUALIFIER T atan2(T x, T y){return atan(x, y);}
56  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec2<T, P> atan2(const tvec2<T, P>& x, const tvec2<T, P>& y){return atan(x, y);}
57  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec3<T, P> atan2(const tvec3<T, P>& x, const tvec3<T, P>& y){return atan(x, y);}
58  template <typename T, precision P> GLM_FUNC_QUALIFIER tvec4<T, P> atan2(const tvec4<T, P>& x, const tvec4<T, P>& y){return atan(x, y);}
59 
60  template <typename genType> GLM_FUNC_DECL bool isfinite(genType const & x);
61  template <typename T, precision P> GLM_FUNC_DECL tvec1<bool, P> isfinite(const tvec1<T, P>& x);
62  template <typename T, precision P> GLM_FUNC_DECL tvec2<bool, P> isfinite(const tvec2<T, P>& x);
63  template <typename T, precision P> GLM_FUNC_DECL tvec3<bool, P> isfinite(const tvec3<T, P>& x);
64  template <typename T, precision P> GLM_FUNC_DECL tvec4<bool, P> isfinite(const tvec4<T, P>& x);
65 
66  typedef bool bool1;
67  typedef tvec2<bool, highp> bool2;
68  typedef tvec3<bool, highp> bool3;
69  typedef tvec4<bool, highp> bool4;
70 
71  typedef bool bool1x1;
72  typedef tmat2x2<bool, highp> bool2x2;
73  typedef tmat2x3<bool, highp> bool2x3;
74  typedef tmat2x4<bool, highp> bool2x4;
75  typedef tmat3x2<bool, highp> bool3x2;
76  typedef tmat3x3<bool, highp> bool3x3;
77  typedef tmat3x4<bool, highp> bool3x4;
78  typedef tmat4x2<bool, highp> bool4x2;
79  typedef tmat4x3<bool, highp> bool4x3;
80  typedef tmat4x4<bool, highp> bool4x4;
81 
82  typedef int int1;
83  typedef tvec2<int, highp> int2;
84  typedef tvec3<int, highp> int3;
85  typedef tvec4<int, highp> int4;
86 
87  typedef int int1x1;
88  typedef tmat2x2<int, highp> int2x2;
89  typedef tmat2x3<int, highp> int2x3;
90  typedef tmat2x4<int, highp> int2x4;
91  typedef tmat3x2<int, highp> int3x2;
92  typedef tmat3x3<int, highp> int3x3;
93  typedef tmat3x4<int, highp> int3x4;
94  typedef tmat4x2<int, highp> int4x2;
95  typedef tmat4x3<int, highp> int4x3;
96  typedef tmat4x4<int, highp> int4x4;
97 
98  typedef float float1;
99  typedef tvec2<float, highp> float2;
100  typedef tvec3<float, highp> float3;
101  typedef tvec4<float, highp> float4;
102 
103  typedef float float1x1;
104  typedef tmat2x2<float, highp> float2x2;
105  typedef tmat2x3<float, highp> float2x3;
106  typedef tmat2x4<float, highp> float2x4;
107  typedef tmat3x2<float, highp> float3x2;
108  typedef tmat3x3<float, highp> float3x3;
109  typedef tmat3x4<float, highp> float3x4;
110  typedef tmat4x2<float, highp> float4x2;
111  typedef tmat4x3<float, highp> float4x3;
112  typedef tmat4x4<float, highp> float4x4;
113 
114  typedef double double1;
115  typedef tvec2<double, highp> double2;
116  typedef tvec3<double, highp> double3;
117  typedef tvec4<double, highp> double4;
118 
119  typedef double double1x1;
120  typedef tmat2x2<double, highp> double2x2;
121  typedef tmat2x3<double, highp> double2x3;
122  typedef tmat2x4<double, highp> double2x4;
123  typedef tmat3x2<double, highp> double3x2;
124  typedef tmat3x3<double, highp> double3x3;
125  typedef tmat3x4<double, highp> double3x4;
126  typedef tmat4x2<double, highp> double4x2;
127  typedef tmat4x3<double, highp> double4x3;
128  typedef tmat4x4<double, highp> double4x4;
129 
131 }//namespace glm
132 
133 #include "compatibility.inl"
int int1x1
integer matrix with 1 component. (From GLM_GTX_compatibility extension)
tmat3x3< bool, highp > bool3x3
boolean matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
tmat3x3< float, highp > float3x3
single-precision floating-point matrix with 3 x 3 components. (From GLM_GTX_compatibility extension) ...
tmat2x4< int, highp > int2x4
integer matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)
tmat2x4< float, highp > float2x4
single-precision floating-point matrix with 2 x 4 components. (From GLM_GTX_compatibility extension) ...
tmat4x3< float, highp > float4x3
single-precision floating-point matrix with 4 x 3 components. (From GLM_GTX_compatibility extension) ...
double double1
double-precision floating-point vector with 1 component. (From GLM_GTX_compatibility extension) ...
tmat2x2< double, highp > double2x2
double-precision floating-point matrix with 2 x 2 components. (From GLM_GTX_compatibility extension) ...
tmat3x4< double, highp > double3x4
double-precision floating-point matrix with 3 x 4 components. (From GLM_GTX_compatibility extension) ...
tmat2x2< int, highp > int2x2
integer matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
tvec2< int, highp > int2
integer vector with 2 components. (From GLM_GTX_compatibility extension)
tvec3< double, highp > double3
double-precision floating-point vector with 3 components. (From GLM_GTX_compatibility extension) ...
GLM_FUNC_QUALIFIER tvec4< T, P > lerp(const tvec4< T, P > &x, const tvec4< T, P > &y, const tvec4< T, P > &a)
Returns the component-wise result of x * (1.0 - a) + y * a, i.e., the linear blend of x and y using v...
tmat3x3< int, highp > int3x3
integer matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
tmat3x3< double, highp > double3x3
double-precision floating-point matrix with 3 x 3 components. (From GLM_GTX_compatibility extension) ...
tmat2x3< bool, highp > bool2x3
boolean matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
tmat4x4< bool, highp > bool4x4
boolean matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
tmat4x3< bool, highp > bool4x3
boolean matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
tmat2x2< float, highp > float2x2
single-precision floating-point matrix with 2 x 2 components. (From GLM_GTX_compatibility extension) ...
GLM_FUNC_QUALIFIER tvec4< T, P > saturate(const tvec4< T, P > &x)
Returns clamp(x, 0, 1) for each component in x. (From GLM_GTX_compatibility)
tvec2< bool, highp > bool2
boolean type with 2 components. (From GLM_GTX_compatibility extension)
GLM_FUNC_DECL tvec4< bool, P > isfinite(const tvec4< T, P > &x)
Test whether or not a scalar or each vector component is a finite value. (From GLM_GTX_compatibility)...
tvec4< float, highp > float4
single-precision floating-point vector with 4 components. (From GLM_GTX_compatibility extension) ...
tmat4x4< float, highp > float4x4
single-precision floating-point matrix with 4 x 4 components. (From GLM_GTX_compatibility extension) ...
tmat4x2< float, highp > float4x2
single-precision floating-point matrix with 4 x 2 components. (From GLM_GTX_compatibility extension) ...
float float1
single-precision floating-point vector with 1 component. (From GLM_GTX_compatibility extension) ...
tmat3x2< float, highp > float3x2
single-precision floating-point matrix with 3 x 2 components. (From GLM_GTX_compatibility extension) ...
tmat4x2< double, highp > double4x2
double-precision floating-point matrix with 4 x 2 components. (From GLM_GTX_compatibility extension) ...
tmat4x3< double, highp > double4x3
double-precision floating-point matrix with 4 x 3 components. (From GLM_GTX_compatibility extension) ...
double double1x1
double-precision floating-point matrix with 1 component. (From GLM_GTX_compatibility extension) ...
tmat4x2< int, highp > int4x2
integer matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
tvec4< int, highp > int4
integer vector with 4 components. (From GLM_GTX_compatibility extension)
tvec3< bool, highp > bool3
boolean type with 3 components. (From GLM_GTX_compatibility extension)
GLM_FUNC_DECL genType clamp(genType x, genType minVal, genType maxVal)
Returns min(max(x, minVal), maxVal) for each component in x using the floating-point values minVal an...
tmat3x2< int, highp > int3x2
integer matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
tmat3x2< double, highp > double3x2
double-precision floating-point matrix with 3 x 2 components. (From GLM_GTX_compatibility extension) ...
GLM_FUNC_QUALIFIER tvec4< T, P > atan2(const tvec4< T, P > &x, const tvec4< T, P > &y)
Arc tangent. Returns an angle whose tangent is y/x. The signs of x and y are used to determine what q...
tvec4< double, highp > double4
double-precision floating-point vector with 4 components. (From GLM_GTX_compatibility extension) ...
tmat4x2< bool, highp > bool4x2
boolean matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
tmat2x4< double, highp > double2x4
double-precision floating-point matrix with 2 x 4 components. (From GLM_GTX_compatibility extension) ...
tmat4x3< int, highp > int4x3
integer matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
tmat2x3< double, highp > double2x3
double-precision floating-point matrix with 2 x 3 components. (From GLM_GTX_compatibility extension) ...
tmat2x3< float, highp > float2x3
single-precision floating-point matrix with 2 x 3 components. (From GLM_GTX_compatibility extension) ...
tmat3x4< int, highp > int3x4
integer matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
tmat2x4< bool, highp > bool2x4
boolean matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)
tmat4x4< int, highp > int4x4
integer matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
int int1
integer vector with 1 component. (From GLM_GTX_compatibility extension)
tvec2< float, highp > float2
single-precision floating-point vector with 2 components. (From GLM_GTX_compatibility extension) ...
tmat2x2< bool, highp > bool2x2
boolean matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
Definition: _noise.hpp:11
tvec4< bool, highp > bool4
boolean type with 4 components. (From GLM_GTX_compatibility extension)
tmat4x4< double, highp > double4x4
double-precision floating-point matrix with 4 x 4 components. (From GLM_GTX_compatibility extension) ...
bool bool1
boolean type with 1 component. (From GLM_GTX_compatibility extension)
tmat3x4< bool, highp > bool3x4
boolean matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
GLM_FUNC_DECL vecType< T, P > 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 ...
GLM_FUNC_DECL vecType< T, P > atan(vecType< T, P > const &y, vecType< T, P > const &x)
Arc tangent.
tmat3x2< bool, highp > bool3x2
boolean matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
tmat3x4< float, highp > float3x4
single-precision floating-point matrix with 3 x 4 components. (From GLM_GTX_compatibility extension) ...
tmat2x3< int, highp > int2x3
integer matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
tvec3< float, highp > float3
single-precision floating-point vector with 3 components. (From GLM_GTX_compatibility extension) ...
tvec3< int, highp > int3
integer vector with 3 components. (From GLM_GTX_compatibility extension)
float float1x1
single-precision floating-point matrix with 1 component. (From GLM_GTX_compatibility extension) ...
tvec2< double, highp > double2
double-precision floating-point vector with 2 components. (From GLM_GTX_compatibility extension) ...
bool bool1x1
boolean matrix with 1 x 1 component. (From GLM_GTX_compatibility extension)