0.9.8: Geometric functions
0.9.8
Geometric functions

Functions

template<typename T , precision P>
GLM_FUNC_DECL tvec3< T, P > cross (tvec3< T, P > const &x, tvec3< T, P > const &y)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL T distance (vecType< T, P > const &p0, vecType< T, P > const &p1)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL T dot (vecType< T, P > const &x, vecType< T, P > const &y)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > faceforward (vecType< T, P > const &N, vecType< T, P > const &I, vecType< T, P > const &Nref)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL T length (vecType< T, P > const &x)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > normalize (vecType< T, P > const &x)

template<typename genType >
GLM_FUNC_DECL genType reflect (genType const &I, genType const &N)

template<typename T , precision P, template< typename, precision > class vecType>
GLM_FUNC_DECL vecType< T, P > refract (vecType< T, P > const &I, vecType< T, P > const &N, T eta)

Detailed Description

These operate on vectors as vectors, not component-wise.

Function Documentation

GLM_FUNC_DECL tvec3<T, P> glm::cross ( tvec3< T, P > const &  x,
tvec3< T, P > const &  y
)

Returns the cross product of x and y.

Template Parameters
valTypeFloating-point scalar types.
GLSL cross man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL T glm::distance ( vecType< T, P > const &  p0,
vecType< T, P > const &  p1
)

Returns the distance betwwen p0 and p1, i.e., length(p0 - p1).

Template Parameters
genTypeFloating-point vector types.
GLSL distance man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL T glm::dot ( vecType< T, P > const &  x,
vecType< T, P > const &  y
)

Returns the dot product of x and y, i.e., result = x * y.

Template Parameters
genTypeFloating-point vector types.
GLSL dot man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL vecType<T, P> glm::faceforward ( vecType< T, P > const &  N,
vecType< T, P > const &  I,
vecType< T, P > const &  Nref
)

If dot(Nref, I) < 0.0, return N, otherwise, return -N.

Template Parameters
genTypeFloating-point vector types.
GLSL faceforward man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL T glm::length ( vecType< T, P > const &  x)

Returns the length of x, i.e., sqrt(x * x).

Template Parameters
genTypeFloating-point vector types.
GLSL length man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL vecType<T, P> glm::normalize ( vecType< T, P > const &  x)

Returns a vector in the same direction as x but with length of 1.

According to issue 10 GLSL 1.10 specification, if length(x) == 0 then result is undefined and generate an error.

GLSL normalize man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL genType glm::reflect ( genType const &  I,
genType const &  N
)

For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N.

Template Parameters
genTypeFloating-point vector types.
GLSL reflect man page
GLSL 4.20.8 specification, section 8.5 Geometric Functions
GLM_FUNC_DECL vecType<T, P> glm::refract ( vecType< T, P > const &  I,
vecType< T, P > const &  N,
eta
)

For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector.

Template Parameters
genTypeFloating-point vector types.