1.0.0 API documentation: geometric.hpp Source File

| 1.0.0 API documentation

geometric.hpp
Go to the documentation of this file.
1
13 #pragma once
14
15 #include "detail/type_vec3.hpp"
16
17 namespace glm
18 {
21
29 template<length_t L, typename T, qualifier Q>
30 GLM_FUNC_DECL T length(vec<L, T, Q> const& x);
31
39 template<length_t L, typename T, qualifier Q>
40 GLM_FUNC_DECL T distance(vec<L, T, Q> const& p0, vec<L, T, Q> const& p1);
41
49 template<length_t L, typename T, qualifier Q>
50 GLM_FUNC_DECL GLM_CONSTEXPR T dot(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
51
58 template<typename T, qualifier Q>
59 GLM_FUNC_DECL GLM_CONSTEXPR vec<3, T, Q> cross(vec<3, T, Q> const& x, vec<3, T, Q> const& y);
60
69 template<length_t L, typename T, qualifier Q>
70 GLM_FUNC_DECL vec<L, T, Q> normalize(vec<L, T, Q> const& x);
71
79 template<length_t L, typename T, qualifier Q>
80 GLM_FUNC_DECL vec<L, T, Q> faceforward(
81 vec<L, T, Q> const& N,
82 vec<L, T, Q> const& I,
83 vec<L, T, Q> const& Nref);
84
93 template<length_t L, typename T, qualifier Q>
94 GLM_FUNC_DECL vec<L, T, Q> reflect(
95 vec<L, T, Q> const& I,
96 vec<L, T, Q> const& N);
97
107 template<length_t L, typename T, qualifier Q>
108 GLM_FUNC_DECL vec<L, T, Q> refract(
109 vec<L, T, Q> const& I,
110 vec<L, T, Q> const& N,
111 T eta);
112
114 }//namespace glm
115
116 #include "detail/func_geometric.inl"
glm::dot
GLM_FUNC_DECL GLM_CONSTEXPR T dot(vec< L, T, Q > const &x, vec< L, T, Q > const &y)
Returns the dot product of x and y, i.e., result = x * y.
glm::faceforward
GLM_FUNC_DECL vec< L, T, Q > faceforward(vec< L, T, Q > const &N, vec< L, T, Q > const &I, vec< L, T, Q > const &Nref)
If dot(Nref, I) < 0.0, return N, otherwise, return -N.
glm::cross
GLM_FUNC_DECL GLM_CONSTEXPR vec< 3, T, Q > cross(vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)
Returns the cross product of x and y.
glm::refract
GLM_FUNC_DECL vec< L, T, Q > refract(vec< L, T, Q > const &I, vec< L, T, Q > const &N, T eta)
For the incident vector I and surface normal N, and the ratio of indices of refraction eta,...
type_vec3.hpp
Core features
glm::reflect
GLM_FUNC_DECL vec< L, T, Q > reflect(vec< L, T, Q > const &I, vec< L, T, Q > const &N)
For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...
glm::normalize
GLM_FUNC_DECL vec< L, T, Q > normalize(vec< L, T, Q > const &x)
Returns a vector in the same direction as x but with length of 1.
glm::distance
GLM_FUNC_DECL T distance(vec< L, T, Q > const &p0, vec< L, T, Q > const &p1)
Returns the distance between p0 and p1, i.e., length(p0 - p1).
glm::length
GLM_FUNC_DECL T length(vec< L, T, Q > const &x)
Returns the length of x, i.e., sqrt(x * x).