mewin/glm
1
0
Fork 0
Code Releases Activity

Added links to the GLSL man pages

Browse Source
This commit is contained in:
Christophe Riccio 2011-04-12 14:05:13 +01:00
parent 8663d9f67d
commit b9f388f122
2 changed files with 45 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
glm/core/func_exponential.hpp
View File

@ -25,40 +25,54 @@ namespace glm
///@{ ///@{
//! Returns x raised to the y power. //! Returns x raised to the y power.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType pow(genType const & x, genType const & y); genType pow(genType const & x, genType const & y);
//! Returns the natural exponentiation of x, i.e., e^x. //! Returns the natural exponentiation of x, i.e., e^x.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType exp(genType const & x); genType exp(genType const & x);
//! Returns the natural logarithm of x, i.e., //! Returns the natural logarithm of x, i.e.,
//! returns the value y which satisfies the equation x = e^y. //! returns the value y which satisfies the equation x = e^y.
//! Results are undefined if x <= 0. //! Results are undefined if x <= 0.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType log(genType const & x); genType log(genType const & x);
//! Returns 2 raised to the x power. //! Returns 2 raised to the x power.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType exp2(genType const & x); genType exp2(genType const & x);
//! Returns the base 2 log of x, i.e., returns the value y, //! Returns the base 2 log of x, i.e., returns the value y,
//! which satisfies the equation x = 2 ^ y. //! which satisfies the equation x = 2 ^ y.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType log2(genType const & x); genType log2(genType const & x);
//! Returns the positive square root of x. //! Returns the positive square root of x.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType sqrt(genType const & x); genType sqrt(genType const & x);
//! Returns the reciprocal of the positive square root of x. //! Returns the reciprocal of the positive square root of x.
//! (From GLSL 1.30.08 specification, section 8.2) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a>
//! \li GLSL 1.30.08 specification, section 8.2
template <typename genType> template <typename genType>
genType inversesqrt(genType const & x); genType inversesqrt(genType const & x);

32
glm/core/func_geometric.hpp
View File

@ -25,40 +25,52 @@ namespace glm
///@{ ///@{
//! Returns the length of x, i.e., sqrt(x * x). //! Returns the length of x, i.e., sqrt(x * x).
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/length.xml">GLSL length man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
typename genType::value_type length( typename genType::value_type length(
genType const & x); genType const & x);
//! Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). //! Returns the distance betwwen p0 and p1, i.e., length(p0 - p1).
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/distance.xml">GLSL distance man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
typename genType::value_type distance( typename genType::value_type distance(
genType const & p0, genType const & p0,
genType const & p1); genType const & p1);
//! Returns the dot product of x and y, i.e., result = x * y. //! Returns the dot product of x and y, i.e., result = x * y.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/dot.xml">GLSL dot man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
typename genType::value_type dot( typename genType::value_type dot(
genType const & x, genType const & x,
genType const & y); genType const & y);
//! Returns the cross product of x and y. //! Returns the cross product of x and y.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cross.xml">GLSL cross man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename T> template <typename T>
detail::tvec3<T> cross( detail::tvec3<T> cross(
detail::tvec3<T> const & x, detail::tvec3<T> const & x,
detail::tvec3<T> const & y); detail::tvec3<T> const & y);
//! Returns a vector in the same direction as x but with length of 1. //! Returns a vector in the same direction as x but with length of 1.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/normalize.xml">GLSL normalize man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
genType normalize( genType normalize(
genType const & x); genType const & x);
//! If dot(Nref, I) < 0.0, return N, otherwise, return -N. //! If dot(Nref, I) < 0.0, return N, otherwise, return -N.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/faceforward.xml">GLSL faceforward man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
genType faceforward( genType faceforward(
genType const & N, genType const & N,
@ -67,7 +79,9 @@ namespace glm
//! For the incident vector I and surface orientation N, //! For the incident vector I and surface orientation N,
//! returns the reflection direction : result = I - 2.0 * dot(N, I) * N. //! returns the reflection direction : result = I - 2.0 * dot(N, I) * N.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/reflect.xml">GLSL reflect man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
genType reflect( genType reflect(
genType const & I, genType const & I,
@ -76,7 +90,9 @@ namespace glm
//! For the incident vector I and surface normal N, //! For the incident vector I and surface normal N,
//! and the ratio of indices of refraction eta, //! and the ratio of indices of refraction eta,
//! return the refraction vector. //! return the refraction vector.
//! (From GLSL 1.30.08 specification, section 8.4) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/refract.xml">GLSL refract man page</a>
//! \li GLSL 1.30.08 specification, section 8.4
template <typename genType> template <typename genType>
genType refract( genType refract(
genType const & I, genType const & I,