mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-26 18:24:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated doxygen doc

Browse Source
This commit is contained in:
Christophe Riccio 2011-06-17 21:11:35 +01:00
parent d4451365f6
commit ac6f0c9b58
2 changed files with 46 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
glm/core/func_exponential.hpp
View File

@ -24,6 +24,13 @@
/// @file glm/core/func_exponential.hpp /// @file glm/core/func_exponential.hpp
/// @date 2008-08-08 / 2011-06-14 /// @date 2008-08-08 / 2011-06-14
/// @author Christophe Riccio /// @author Christophe Riccio
///
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
///
/// @defgroup core_func_exponential Exponential functions
/// @ingroup core
///
/// These all operate component-wise. The description is per component.
/////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_core_func_exponential #ifndef glm_core_func_exponential
@ -31,58 +38,65 @@
namespace glm namespace glm
{ {
/// @addtogroup core_funcs /// @addtogroup core_func_exponential
/// @{ /// @{
//! Returns x raised to the y power. /// Returns x raised to the y power.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
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.
//! ///
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a> /// @see
//! \li GLSL 1.30.08 specification, section 8.2 /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a>
/// @see - <a href="http://www.opengl.org/GLSLangSpec.4.10.6.pdf">GLSL 4.10.6 specification, section 8.2</a>
template <typename genType> template <typename genType>
genType inversesqrt(genType const & x); genType inversesqrt(genType const & x);

1
glm/gtc/half_float.hpp
View File

@ -32,7 +32,6 @@
/// ///
/// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices. /// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices.
/// <glm/gtc/half_float.hpp> need to be included to use these functionalities. /// <glm/gtc/half_float.hpp> need to be included to use these functionalities.
///
/////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////
#ifndef GLM_GTC_half_float #ifndef GLM_GTC_half_float