0.9.9 API documenation
common.hpp
Go to the documentation of this file.
1 
13 #pragma once
14 
15 #include "detail/setup.hpp"
16 #include "detail/qualifier.hpp"
17 #include "detail/type_int.hpp"
18 #include "detail/_fixes.hpp"
19 
20 namespace glm
21 {
24 
32  template<typename genType>
33  GLM_FUNC_DECL genType abs(genType x);
34 
43  template<length_t L, typename T, qualifier Q>
44  GLM_FUNC_DECL vec<L, T, Q> abs(vec<L, T, Q> const& x);
45 
54  template<length_t L, typename T, qualifier Q>
55  GLM_FUNC_DECL vec<L, T, Q> sign(vec<L, T, Q> const& x);
56 
65  template<length_t L, typename T, qualifier Q>
66  GLM_FUNC_DECL vec<L, T, Q> floor(vec<L, T, Q> const& x);
67 
77  template<length_t L, typename T, qualifier Q>
78  GLM_FUNC_DECL vec<L, T, Q> trunc(vec<L, T, Q> const& x);
79 
92  template<length_t L, typename T, qualifier Q>
93  GLM_FUNC_DECL vec<L, T, Q> round(vec<L, T, Q> const& x);
94 
106  template<length_t L, typename T, qualifier Q>
107  GLM_FUNC_DECL vec<L, T, Q> roundEven(vec<L, T, Q> const& x);
108 
118  template<length_t L, typename T, qualifier Q>
119  GLM_FUNC_DECL vec<L, T, Q> ceil(vec<L, T, Q> const& x);
120 
127  template<typename genType>
128  GLM_FUNC_DECL genType fract(genType x);
129 
138  template<length_t L, typename T, qualifier Q>
139  GLM_FUNC_DECL vec<L, T, Q> fract(vec<L, T, Q> const& x);
140 
148  template<typename genType>
149  GLM_FUNC_DECL genType mod(genType x, genType y);
150 
160  template<length_t L, typename T, qualifier Q>
161  GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, T y);
162 
172  template<length_t L, typename T, qualifier Q>
173  GLM_FUNC_DECL vec<L, T, Q> mod(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
174 
184  template<typename genType>
185  GLM_FUNC_DECL genType modf(genType x, genType& i);
186 
193  template<typename genType>
194  GLM_FUNC_DECL genType min(genType x, genType y);
195 
204  template<length_t L, typename T, qualifier Q>
205  GLM_FUNC_DECL vec<L, T, Q> min(vec<L, T, Q> const& x, T y);
206 
215  template<length_t L, typename T, qualifier Q>
216  GLM_FUNC_DECL vec<L, T, Q> min(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
217 
224  template<typename genType>
225  GLM_FUNC_DECL genType max(genType x, genType y);
226 
235  template<length_t L, typename T, qualifier Q>
236  GLM_FUNC_DECL vec<L, T, Q> max(vec<L, T, Q> const& x, T y);
237 
246  template<length_t L, typename T, qualifier Q>
247  GLM_FUNC_DECL vec<L, T, Q> max(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
248 
256  template<typename genType>
257  GLM_FUNC_DECL genType clamp(genType x, genType minVal, genType maxVal);
258 
268  template<length_t L, typename T, qualifier Q>
269  GLM_FUNC_DECL vec<L, T, Q> clamp(vec<L, T, Q> const& x, T minVal, T maxVal);
270 
280  template<length_t L, typename T, qualifier Q>
281  GLM_FUNC_DECL vec<L, T, Q> clamp(vec<L, T, Q> const& x, vec<L, T, Q> const& minVal, vec<L, T, Q> const& maxVal);
282 
325  template<typename genTypeT, typename genTypeU>
326  GLM_FUNC_DECL genTypeT mix(genTypeT x, genTypeT y, genTypeU a);
327 
328  template<length_t L, typename T, typename U, qualifier Q>
329  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);
330 
331  template<length_t L, typename T, typename U, qualifier Q>
332  GLM_FUNC_DECL vec<L, T, Q> mix(vec<L, T, Q> const& x, vec<L, T, Q> const& y, U a);
333 
338  template<typename genType>
339  GLM_FUNC_DECL genType step(genType edge, genType x);
340 
349  template<length_t L, typename T, qualifier Q>
350  GLM_FUNC_DECL vec<L, T, Q> step(T edge, vec<L, T, Q> const& x);
351 
360  template<length_t L, typename T, qualifier Q>
361  GLM_FUNC_DECL vec<L, T, Q> step(vec<L, T, Q> const& edge, vec<L, T, Q> const& x);
362 
377  template<typename genType>
378  GLM_FUNC_DECL genType smoothstep(genType edge0, genType edge1, genType x);
379 
380  template<length_t L, typename T, qualifier Q>
381  GLM_FUNC_DECL vec<L, T, Q> smoothstep(T edge0, T edge1, vec<L, T, Q> const& x);
382 
383  template<length_t L, typename T, qualifier Q>
384  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);
385 
400  template<length_t L, typename T, qualifier Q>
401  GLM_FUNC_DECL vec<L, bool, Q> isnan(vec<L, T, Q> const& x);
402 
415  template<length_t L, typename T, qualifier Q>
416  GLM_FUNC_DECL vec<L, bool, Q> isinf(vec<L, T, Q> const& x);
417 
424  GLM_FUNC_DECL int floatBitsToInt(float const& v);
425 
435  template<length_t L, qualifier Q>
436  GLM_FUNC_DECL vec<L, int, Q> floatBitsToInt(vec<L, float, Q> const& v);
437 
444  GLM_FUNC_DECL uint floatBitsToUint(float const& v);
445 
455  template<length_t L, qualifier Q>
456  GLM_FUNC_DECL vec<L, uint, Q> floatBitsToUint(vec<L, float, Q> const& v);
457 
466  GLM_FUNC_DECL float intBitsToFloat(int const& v);
467 
479  template<length_t L, qualifier Q>
480  GLM_FUNC_DECL vec<L, float, Q> intBitsToFloat(vec<L, int, Q> const& v);
481 
490  GLM_FUNC_DECL float uintBitsToFloat(uint const& v);
491 
503  template<length_t L, qualifier Q>
504  GLM_FUNC_DECL vec<L, float, Q> uintBitsToFloat(vec<L, uint, Q> const& v);
505 
512  template<typename genType>
513  GLM_FUNC_DECL genType fma(genType const& a, genType const& b, genType const& c);
514 
529  template<typename genType, typename genIType>
530  GLM_FUNC_DECL genType frexp(genType const& x, genIType& exp);
531 
543  template<typename genType, typename genIType>
544  GLM_FUNC_DECL genType ldexp(genType const& x, genIType const& exp);
545 
547 }//namespace glm
548 
549 #include "detail/func_common.inl"
550 
glm::sign
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.
glm::roundEven
GLM_FUNC_DECL vec< L, T, Q > roundEven(vec< L, T, Q > const &x)
Returns a value equal to the nearest integer to x.
glm::trunc
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 absolut...
glm::intBitsToFloat
GLM_FUNC_DECL vec< L, float, Q > intBitsToFloat(vec< L, int, Q > const &v)
Returns a floating-point value corresponding to a signed integer encoding of a floating-point value...
glm::step
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.
glm
Definition: common.hpp:20
glm::round
GLM_FUNC_DECL vec< L, T, Q > round(vec< L, T, Q > const &x)
Returns a value equal to the nearest integer to x.
qualifier.hpp
Core features
glm::floor
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.
type_int.hpp
Core features
glm::uintBitsToFloat
GLM_FUNC_DECL vec< L, float, Q > uintBitsToFloat(vec< L, uint, Q > const &v)
Returns a floating-point value corresponding to a unsigned integer encoding of a floating-point value...
glm::ceil
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.
glm::fma
GLM_FUNC_DECL genType fma(genType const &a, genType const &b, genType const &c)
Computes and returns a * b + c.
glm::floatBitsToInt
GLM_FUNC_DECL vec< L, int, Q > floatBitsToInt(vec< L, float, Q > const &v)
Returns a signed integer value representing the encoding of a floating-point value.
glm::exp
GLM_FUNC_DECL vec< L, T, Q > exp(vec< L, T, Q > const &v)
Returns the natural exponentiation of x, i.e., e^x.
glm::floatBitsToUint
GLM_FUNC_DECL vec< L, uint, Q > floatBitsToUint(vec< L, float, Q > const &v)
Returns a unsigned integer value representing the encoding of a floating-point value.
glm::isinf
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 imp...
glm::max
GLM_FUNC_DECL 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.
glm::mod
GLM_FUNC_DECL vec< L, T, Q > mod(vec< L, T, Q > const &x, vec< L, T, Q > const &y)
Modulus.
glm::ldexp
GLM_FUNC_DECL genType ldexp(genType const &x, genIType const &exp)
Builds a floating-point number from x and the corresponding integral exponent of two in exp...
glm::mix
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::min
GLM_FUNC_DECL 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.
glm::modf
GLM_FUNC_DECL genType modf(genType x, genType &i)
Returns the fractional part of x and sets i to the integer part (as a whole number floating point val...
glm::abs
GLM_FUNC_DECL vec< L, T, Q > abs(vec< L, T, Q > const &x)
Returns x if x >= 0; otherwise, it returns -x.
glm::smoothstep
GLM_FUNC_DECL genType smoothstep(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 a...
glm::isnan
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...
setup.hpp
Core features
_fixes.hpp
Core features
glm::uint
unsigned int uint
Unsigned integer type.
Definition: type_int.hpp:288
glm::frexp
GLM_FUNC_DECL genType 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...
glm::fract
GLM_FUNC_DECL vec< L, T, Q > fract(vec< L, T, Q > const &x)
Return x - floor(x).
glm::clamp
GLM_FUNC_DECL 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 floating-point values minVal an...
Generated by   doxygen 1.8.10