| 1.0.2 API documentation

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