mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-10 12:41:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Christophe Riccio 2011-09-09 11:23:40 +01:00
parent 0abfe343a5
commit 24e438dac4
3 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
glm/core/func_vector_relational.hpp
View File

@ -50,8 +50,8 @@ namespace glm
//! Returns the component-wise comparison result of x < y. //! Returns the component-wise comparison result of x < y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThan.xml">GLSL lessThan man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThan.xml">GLSL lessThan man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThan GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThan
( (
@ -73,8 +73,8 @@ namespace glm
//! Returns the component-wise comparison of result x <= y. //! Returns the component-wise comparison of result x <= y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThanEqual.xml">GLSL lessThanEqual man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThanEqual.xml">GLSL lessThanEqual man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThanEqual GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThanEqual
( (
@ -95,8 +95,8 @@ namespace glm
//! Returns the component-wise comparison of result x > y. //! Returns the component-wise comparison of result x > y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThan.xml">GLSL greaterThan man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThan.xml">GLSL greaterThan man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThan GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThan
( (
@ -117,8 +117,8 @@ namespace glm
//! Returns the component-wise comparison of result x >= y. //! Returns the component-wise comparison of result x >= y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThanEqual.xml">GLSL greaterThanEqual man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThanEqual.xml">GLSL greaterThanEqual man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThanEqual GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThanEqual
( (
@ -139,8 +139,8 @@ namespace glm
//! Returns the component-wise comparison of result x == y. //! Returns the component-wise comparison of result x == y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/equal.xml">GLSL equal man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/equal.xml">GLSL equal man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type equal GLM_FUNC_QUALIFIER typename vecType<T>::bool_type equal
( (
@ -159,8 +159,8 @@ namespace glm
//! Returns the component-wise comparison of result x != y. //! Returns the component-wise comparison of result x != y.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/notEqual.xml">GLSL notEqual man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/notEqual.xml">GLSL notEqual man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <typename T, template <typename> class vecType> template <typename T, template <typename> class vecType>
GLM_FUNC_QUALIFIER typename vecType<T>::bool_type notEqual GLM_FUNC_QUALIFIER typename vecType<T>::bool_type notEqual
( (
@ -179,8 +179,8 @@ namespace glm
//! Returns true if any component of x is true. //! Returns true if any component of x is true.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/any.xml">GLSL any man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/any.xml">GLSL any man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <template <typename> class vecType> template <template <typename> class vecType>
GLM_FUNC_QUALIFIER bool any(vecType<bool> const & v) GLM_FUNC_QUALIFIER bool any(vecType<bool> const & v)
{ {
@ -195,8 +195,8 @@ namespace glm
//! Returns true if all components of x are true. //! Returns true if all components of x are true.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/all.xml">GLSL all man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/all.xml">GLSL all man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <template <typename> class vecType> template <template <typename> class vecType>
GLM_FUNC_QUALIFIER bool all(vecType<bool> const & v) GLM_FUNC_QUALIFIER bool all(vecType<bool> const & v)
{ {
@ -212,8 +212,8 @@ namespace glm
//! Returns the component-wise logical complement of x. //! Returns the component-wise logical complement of x.
//! /!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead. //! /!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.
//! //!
//! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/not.xml">GLSL not man page</a> /// @see - <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/not.xml">GLSL not man page</a>
//! \li GLSL 1.30.08 specification, section 8.6 /// @see - <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.7</a>
template <template <typename> class vecType> template <template <typename> class vecType>
GLM_FUNC_QUALIFIER vecType<bool> not_(vecType<bool> const & v) GLM_FUNC_QUALIFIER vecType<bool> not_(vecType<bool> const & v)
{ {

14
glm/gtc/matrix_inverse.hpp
View File

@ -49,13 +49,19 @@ namespace glm
/// @addtogroup gtc_matrix_inverse /// @addtogroup gtc_matrix_inverse
/// @{ /// @{
//! Fast matrix inverse for affine matrix. /// Fast matrix inverse for affine matrix.
//! From GLM_GTC_matrix_inverse extension. ///
/// @param m Input matrix to invert.
/// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-precision floating point value is highly innacurate.
/// @see gtc_matrix_inverse
template <typename genType> template <typename genType>
genType affineInverse(genType const & m); genType affineInverse(genType const & m);
//! Compute the inverse transpose of a matrix. /// Compute the inverse transpose of a matrix.
//! From GLM_GTC_matrix_inverse extension. ///
/// @param m Input matrix to invert transpose.
/// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-precision floating point value is highly innacurate.
/// @see gtc_matrix_inverse
template <typename genType> template <typename genType>
GLM_FUNC_QUALIFIER typename genType::value_type inverseTranspose( GLM_FUNC_QUALIFIER typename genType::value_type inverseTranspose(
genType const & m); genType const & m);

3
glm/gtc/matrix_transform.hpp
View File

@ -62,9 +62,7 @@ namespace glm
/// ///
/// @param m Matrix multiplied by this translation matrix. /// @param m Matrix multiplied by this translation matrix.
/// @param v Coordinates of a translation vector. /// @param v Coordinates of a translation vector.
///
/// @tparam T Value type used to build the translation matrix. Currently supported: half (not recommanded), float or double. /// @tparam T Value type used to build the translation matrix. Currently supported: half (not recommanded), float or double.
///
/// @code /// @code
/// #include <glm/glm.hpp> /// #include <glm/glm.hpp>
/// #include <glm/gtc/matrix_transform.hpp> /// #include <glm/gtc/matrix_transform.hpp>
@ -75,7 +73,6 @@ namespace glm
/// // m[2][0] == 0.0f, m[2][1] == 0.0f, m[2][2] == 1.0f, m[2][3] == 0.0f /// // m[2][0] == 0.0f, m[2][1] == 0.0f, m[2][2] == 1.0f, m[2][3] == 0.0f
/// // m[3][0] == 1.0f, m[3][1] == 1.0f, m[3][2] == 1.0f, m[3][3] == 1.0f /// // m[3][0] == 1.0f, m[3][1] == 1.0f, m[3][2] == 1.0f, m[3][3] == 1.0f
/// @endcode /// @endcode
///
/// @see gtc_matrix_transform /// @see gtc_matrix_transform
/// @see gtx_transform /// @see gtx_transform
/// @see - translate(T x, T y, T z) /// @see - translate(T x, T y, T z)