mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-23 17:14:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added man page links

Browse Source
This commit is contained in:
Christophe Riccio 2011-04-11 11:02:11 +01:00
parent 0089077931
commit 6f5a9244ee
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
glm/core/func_common.hpp
View File

@ -27,23 +27,31 @@ namespace glm
///@{ ///@{
//! Returns x if x >= 0; otherwise, it returns -x. //! Returns x if x >= 0; otherwise, it returns -x.
//! (From GLSL 1.30.08 specification, section 8.3) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/abs.xml">GLSL abs man page</a>
//! \li GLSL 1.30.08 specification, section 8.3
template <typename genFIType> template <typename genFIType>
genFIType abs(genFIType const & x); genFIType abs(genFIType const & x);
//! Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0. //! Returns 1.0 if x > 0, 0.0 if x == 0, or -1.0 if x < 0.
//! (From GLSL 1.30.08 specification, section 8.3) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sign.xml">GLSL sign man page</a>
//! \li GLSL 1.30.08 specification, section 8.3
template <typename genFIType> template <typename genFIType>
genFIType sign(genFIType const & x); genFIType sign(genFIType const & x);
//! Returns a value equal to the nearest integer that is less then or equal to x. //! Returns a value equal to the nearest integer that is less then or equal to x.
//! (From GLSL 1.30.08 specification, section 8.3) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/floor.xml">GLSL floor man page</a>
//! \li GLSL 1.30.08 specification, section 8.3
template <typename genType> template <typename genType>
genType floor(genType const & x); genType floor(genType const & x);
//! Returns a value equal to the nearest integer to x //! Returns a value equal to the nearest integer to x
//! whose absolute value is not larger than the absolute value of x. //! whose absolute value is not larger than the absolute value of x.
//! (From GLSL 1.30.08 specification, section 8.3) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/trunc.xml">GLSL trunc man page</a>
//! \li GLSL 1.30.08 specification, section 8.3
template <typename genType> template <typename genType>
genType trunc(genType const & x); genType trunc(genType const & x);
@ -52,7 +60,9 @@ namespace glm
//! implementation, presumably the direction that is fastest. //! implementation, presumably the direction that is fastest.
//! This includes the possibility that round(x) returns the //! This includes the possibility that round(x) returns the
//! same value as roundEven(x) for all values of x. //! same value as roundEven(x) for all values of x.
//! (From GLSL 1.30.08 specification, section 8.3) //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/round.xml">GLSL round man page</a>
//! \li GLSL 1.30.08 specification, section 8.3
template <typename genType> template <typename genType>
genType round(genType const & x); genType round(genType const & x);