0.9.9 API documentation
compatibility.hpp
Go to the documentation of this file.
1
12
13#pragma once
14
15// Dependency:
16#include "../glm.hpp"
17#include "../gtc/quaternion.hpp"
18
19#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
20# ifndef GLM_ENABLE_EXPERIMENTAL
21# pragma message("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.")
22# else
23# pragma message("GLM: GLM_GTX_compatibility extension included")
24# endif
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
36namespace 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, 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);}
43
44 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);}
45 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);}
46 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);}
47 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);}
48 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);}
49
50 template<typename T, qualifier Q> GLM_FUNC_QUALIFIER T saturate(T x){return clamp(x, T(0), T(1));}
51 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));}
52 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));}
53 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));}
54
55 template<typename T, qualifier Q> GLM_FUNC_QUALIFIER T atan2(T x, T y){return atan(x, y);}
56 template<typename T, qualifier Q> GLM_FUNC_QUALIFIER vec<2, T, Q> atan2(const vec<2, T, Q>& x, const vec<2, T, Q>& y){return atan(x, y);}
57 template<typename T, qualifier Q> GLM_FUNC_QUALIFIER vec<3, T, Q> atan2(const vec<3, T, Q>& x, const vec<3, T, Q>& y){return atan(x, y);}
58 template<typename T, qualifier Q> GLM_FUNC_QUALIFIER vec<4, T, Q> atan2(const vec<4, T, Q>& x, const vec<4, T, Q>& y){return atan(x, y);}
59
60 template<typename genType> GLM_FUNC_DECL bool isfinite(genType const& x);
61 template<typename T, qualifier Q> GLM_FUNC_DECL vec<1, bool, Q> isfinite(const vec<1, T, Q>& x);
62 template<typename T, qualifier Q> GLM_FUNC_DECL vec<2, bool, Q> isfinite(const vec<2, T, Q>& x);
63 template<typename T, qualifier Q> GLM_FUNC_DECL vec<3, bool, Q> isfinite(const vec<3, T, Q>& x);
64 template<typename T, qualifier Q> GLM_FUNC_DECL vec<4, bool, Q> isfinite(const vec<4, T, Q>& x);
65
66 typedef bool bool1;
67 typedef vec<2, bool, highp> bool2;
68 typedef vec<3, bool, highp> bool3;
69 typedef vec<4, bool, highp> bool4;
70
71 typedef bool bool1x1;
72 typedef mat<2, 2, bool, highp> bool2x2;
73 typedef mat<2, 3, bool, highp> bool2x3;
74 typedef mat<2, 4, bool, highp> bool2x4;
75 typedef mat<3, 2, bool, highp> bool3x2;
76 typedef mat<3, 3, bool, highp> bool3x3;
77 typedef mat<3, 4, bool, highp> bool3x4;
78 typedef mat<4, 2, bool, highp> bool4x2;
79 typedef mat<4, 3, bool, highp> bool4x3;
80 typedef mat<4, 4, bool, highp> bool4x4;
81
82 typedef int int1;
83 typedef vec<2, int, highp> int2;
84 typedef vec<3, int, highp> int3;
85 typedef vec<4, int, highp> int4;
86
87 typedef int int1x1;
88 typedef mat<2, 2, int, highp> int2x2;
89 typedef mat<2, 3, int, highp> int2x3;
90 typedef mat<2, 4, int, highp> int2x4;
91 typedef mat<3, 2, int, highp> int3x2;
92 typedef mat<3, 3, int, highp> int3x3;
93 typedef mat<3, 4, int, highp> int3x4;
94 typedef mat<4, 2, int, highp> int4x2;
95 typedef mat<4, 3, int, highp> int4x3;
96 typedef mat<4, 4, int, highp> int4x4;
97
98 typedef float float1;
99 typedef vec<2, float, highp> float2;
100 typedef vec<3, float, highp> float3;
101 typedef vec<4, float, highp> float4;
102
103 typedef float float1x1;
104 typedef mat<2, 2, float, highp> float2x2;
105 typedef mat<2, 3, float, highp> float2x3;
106 typedef mat<2, 4, float, highp> float2x4;
107 typedef mat<3, 2, float, highp> float3x2;
108 typedef mat<3, 3, float, highp> float3x3;
109 typedef mat<3, 4, float, highp> float3x4;
110 typedef mat<4, 2, float, highp> float4x2;
111 typedef mat<4, 3, float, highp> float4x3;
112 typedef mat<4, 4, float, highp> float4x4;
113
114 typedef double double1;
115 typedef vec<2, double, highp> double2;
116 typedef vec<3, double, highp> double3;
117 typedef vec<4, double, highp> double4;
118
119 typedef double double1x1;
120 typedef mat<2, 2, double, highp> double2x2;
121 typedef mat<2, 3, double, highp> double2x3;
122 typedef mat<2, 4, double, highp> double2x4;
123 typedef mat<3, 2, double, highp> double3x2;
124 typedef mat<3, 3, double, highp> double3x3;
125 typedef mat<3, 4, double, highp> double3x4;
126 typedef mat<4, 2, double, highp> double4x2;
127 typedef mat<4, 3, double, highp> double4x3;
128 typedef mat<4, 4, double, highp> double4x4;
129
131}//namespace glm
132
133#include "compatibility.inl"
GLM_FUNC_DECL 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_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_FUNC_DECL vec< L, T, Q > atan(vec< L, T, Q > const &y, vec< L, T, Q > const &x)
Arc tangent.
vec< 2, float, highp > float2
single-qualifier floating-point vector with 2 components. (From GLM_GTX_compatibility extension)
mat< 4, 4, int, highp > int4x4
integer matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
int int1x1
integer matrix with 1 component. (From GLM_GTX_compatibility extension)
int int1
integer vector with 1 component. (From GLM_GTX_compatibility extension)
vec< 4, bool, highp > bool4
boolean type with 4 components. (From GLM_GTX_compatibility extension)
mat< 3, 3, int, highp > int3x3
integer matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
mat< 2, 3, int, highp > int2x3
integer matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
double double1
double-qualifier floating-point vector with 1 component. (From GLM_GTX_compatibility extension)
mat< 2, 4, int, highp > int2x4
integer matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)
mat< 3, 4, double, highp > double3x4
double-qualifier floating-point matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
mat< 4, 2, float, highp > float4x2
single-qualifier floating-point matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
vec< 2, double, highp > double2
double-qualifier floating-point vector with 2 components. (From GLM_GTX_compatibility extension)
mat< 2, 2, float, highp > float2x2
single-qualifier floating-point matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
mat< 2, 3, double, highp > double2x3
double-qualifier floating-point matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
vec< 3, double, highp > double3
double-qualifier floating-point vector with 3 components. (From GLM_GTX_compatibility extension)
double double1x1
double-qualifier floating-point matrix with 1 component. (From GLM_GTX_compatibility extension)
mat< 3, 3, double, highp > double3x3
double-qualifier floating-point matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
mat< 3, 4, float, highp > float3x4
single-qualifier floating-point matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
mat< 2, 4, bool, highp > bool2x4
boolean matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)
mat< 2, 2, int, highp > int2x2
integer matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
mat< 3, 2, double, highp > double3x2
double-qualifier floating-point matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
mat< 3, 3, bool, highp > bool3x3
boolean matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
mat< 3, 3, float, highp > float3x3
single-qualifier floating-point matrix with 3 x 3 components. (From GLM_GTX_compatibility extension)
float float1x1
single-qualifier floating-point matrix with 1 component. (From GLM_GTX_compatibility extension)
mat< 4, 4, bool, highp > bool4x4
boolean matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
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...
bool bool1x1
boolean matrix with 1 x 1 component. (From GLM_GTX_compatibility extension)
vec< 3, float, highp > float3
single-qualifier floating-point vector with 3 components. (From GLM_GTX_compatibility extension)
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)
vec< 3, int, highp > int3
integer vector with 3 components. (From GLM_GTX_compatibility extension)
mat< 2, 3, float, highp > float2x3
single-qualifier floating-point matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
mat< 4, 2, int, highp > int4x2
integer matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
vec< 3, bool, highp > bool3
boolean type with 3 components. (From GLM_GTX_compatibility extension)
mat< 2, 3, bool, highp > bool2x3
boolean matrix with 2 x 3 components. (From GLM_GTX_compatibility extension)
mat< 4, 2, bool, highp > bool4x2
boolean matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
vec< 2, bool, highp > bool2
boolean type with 2 components. (From GLM_GTX_compatibility extension)
GLM_FUNC_QUALIFIER vec< 4, T, Q > atan2(const vec< 4, T, Q > &x, const vec< 4, T, Q > &y)
Arc tangent. Returns an angle whose tangent is y/x. The signs of x and y are used to determine what q...
mat< 3, 2, int, highp > int3x2
integer matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
mat< 3, 2, float, highp > float3x2
single-qualifier floating-point matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
mat< 4, 4, double, highp > double4x4
double-qualifier floating-point matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
mat< 3, 4, int, highp > int3x4
integer matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
GLM_FUNC_DECL vec< 4, bool, Q > isfinite(const vec< 4, T, Q > &x)
Test whether or not a scalar or each vector component is a finite value. (From GLM_GTX_compatibility)
mat< 4, 2, double, highp > double4x2
double-qualifier floating-point matrix with 4 x 2 components. (From GLM_GTX_compatibility extension)
mat< 4, 3, float, highp > float4x3
single-qualifier floating-point matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
mat< 3, 2, bool, highp > bool3x2
boolean matrix with 3 x 2 components. (From GLM_GTX_compatibility extension)
mat< 2, 4, double, highp > double2x4
double-qualifier floating-point matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)
mat< 4, 3, bool, highp > bool4x3
boolean matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
mat< 4, 4, float, highp > float4x4
single-qualifier floating-point matrix with 4 x 4 components. (From GLM_GTX_compatibility extension)
mat< 2, 2, bool, highp > bool2x2
boolean matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
bool bool1
boolean type with 1 component. (From GLM_GTX_compatibility extension)
vec< 4, float, highp > float4
single-qualifier floating-point vector with 4 components. (From GLM_GTX_compatibility extension)
mat< 4, 3, int, highp > int4x3
integer matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
mat< 2, 2, double, highp > double2x2
double-qualifier floating-point matrix with 2 x 2 components. (From GLM_GTX_compatibility extension)
mat< 3, 4, bool, highp > bool3x4
boolean matrix with 3 x 4 components. (From GLM_GTX_compatibility extension)
vec< 4, int, highp > int4
integer vector with 4 components. (From GLM_GTX_compatibility extension)
float float1
single-qualifier floating-point vector with 1 component. (From GLM_GTX_compatibility extension)
vec< 4, double, highp > double4
double-qualifier floating-point vector with 4 components. (From GLM_GTX_compatibility extension)
mat< 4, 3, double, highp > double4x3
double-qualifier floating-point matrix with 4 x 3 components. (From GLM_GTX_compatibility extension)
vec< 2, int, highp > int2
integer vector with 2 components. (From GLM_GTX_compatibility extension)
mat< 2, 4, float, highp > float2x4
single-qualifier floating-point matrix with 2 x 4 components. (From GLM_GTX_compatibility extension)