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

Doxygen doc udpated, clean up, fixes and stuff

Browse Source
This commit is contained in:
Christophe Riccio 2011-02-08 16:03:45 +00:00
parent 79f0f7c49f
commit 7ab3d65253
7 changed files with 133 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/CMakeLists.txt
View File

@ -1,6 +1,6 @@
set(NAME glm-doc)
file(GLOB ROOT_TXT doxyfile ../*.txt)
file(GLOB ROOT_TXT doxyfile *.doxy ../*.txt)
file(GLOB ROOT_CPP src/*.cpp)
file(GLOB ROOT_XML src/*.xml)
file(GLOB ROOT_XSL src/*.xsl)

8
doc/coreModules.doxy
View File

@ -16,9 +16,9 @@
/*!
\defgroup core_types Core GLSL Types
\defgroup core_types Core Types
\brief The standard types defined by the GLSL specification.
\brief The standard types defined by the specification.
These types are all typedefs of more generalized, template types. To see the definiton
of these template types, go to \ref core_template.
@ -54,9 +54,9 @@
**/
/*!
\defgroup core_funcs Core GLSL Functions
\defgroup core_funcs Core Functions
\brief The functions defined by the GLSL specification.
\brief The functions defined by the specification.
\ingroup core
**/

24
doc/gtcModules.doxy → doc/gtc.doxy
View File

@ -1,5 +1,5 @@
/*!
\defgroup gtc GLM Core Extensions
\defgroup gtc GTC Extensions (Stable)
\brief Functions and types that GLSL does not provide, but are useful to have.
@ -7,8 +7,8 @@
are fairly stable. The API for experimental extensions is expected to change
significantly between versions.
You can bring all of the extensions, core or experimental, in by
including <glm/ext.hpp> Otherwise, you will have to include each extension
Even if it's highly unrecommended, you can bring all of the extensions, by
including <glm/ext.hpp>. Otherwise, you will have to include each extension
by including a specific file.
**/
@ -18,7 +18,7 @@
\brief Defines the half-float type, along with various typedefs for vectors and matrices.
You must include <glm/glc/half_float.hpp> to get this functionality.
You must include <glm/gtc/half_float.hpp> to get this functionality.
**/
/*!
@ -27,7 +27,7 @@
\brief Defines functions that allow you to access rows or columns of a matrix easily.
You must include <glm/glc/matrix_access.hpp> to get this functionality.
You must include <glm/gtc/matrix_access.hpp> to get this functionality.
**/
/*!
@ -36,7 +36,7 @@
\brief Defines a number of matrices with integer types.
You must include <glm/glc/matrix_integer.hpp> to get this functionality.
You must include <glm/gtc/matrix_integer.hpp> to get this functionality.
**/
/*!
@ -45,7 +45,7 @@
\brief Defines additional matrix inverting functions.
You must include <glm/glc/matrix_inverse.hpp> to get this functionality.
You must include <glm/gtc/matrix_inverse.hpp> to get this functionality.
**/
/*!
@ -60,7 +60,7 @@
perspective, ortho, etc) are designed to expect. The OpenGL compatibility
specifications defines the particular layout of this eye space.
You must include <glm/glc/matrix_transform.hpp> to get this functionality.
You must include <glm/gtc/matrix_transform.hpp> to get this functionality.
**/
/*!
@ -69,7 +69,7 @@
\brief Defines a templated quaternion type and several quaternion operations.
You must include <glm/glc/quaternion.hpp> to get this functionality.
You must include <glm/gtc/quaternion.hpp> to get this functionality.
**/
/*!
@ -81,7 +81,7 @@
\ref core_precision defines types based on GLSL's precision qualifiers. This
extension defines types based on explicitly-sized C++ data types.
You must include the file <glm/glc/type_precision.hpp> to get this functionality.
You must include the file <glm/gtc/type_precision.hpp> to get this functionality.
**/
/*!
@ -101,7 +101,7 @@
\code
#include <glm/glm.hpp>
#include <glm/glc/type_ptr.hpp>
#include <glm/gtc/type_ptr.hpp>
glm::vec3 aVector(3);
glm::mat4 someMatrix(1.0);
@ -109,6 +109,6 @@ glUniform3fv(uniformLoc, 1, glm::value_ptr(aVector));
glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix));
\endcode
You must include the file <glm/glc/type_ptr.hpp> to get this functionality.
You must include the file <glm/gtc/type_ptr.hpp> to get this functionality.
**/

0
doc/experimentalModules.doxy → doc/gtx.doxy
View File

0
doc/doxyfile → doc/man.doxy
View File

114
doc/virtrev.doxy Normal file
View File

@ -0,0 +1,114 @@
/*!
\defgroup gtc GTC Extensions (Stable)
\brief Functions and types that GLSL does not provide, but are useful to have.
Core extensions differ from \ref gtx "experimental extensions" in that core extensions
are fairly stable. The API for experimental extensions is expected to change
significantly between versions.
Even if it's highly unrecommended, you can bring all of the extensions, by
including <glm/ext.hpp>. Otherwise, you will have to include each extension
by including a specific file.
**/
/*!
\defgroup gtc_half_float Half Float Core Extension
\ingroup gtc
\brief Defines the half-float type, along with various typedefs for vectors and matrices.
You must include <glm/gtc/half_float.hpp> to get this functionality.
**/
/*!
\defgroup gtc_matrix_access Matrix Access Core Extension
\ingroup gtc
\brief Defines functions that allow you to access rows or columns of a matrix easily.
You must include <glm/gtc/matrix_access.hpp> to get this functionality.
**/
/*!
\defgroup gtc_matrix_integer Integer Matrix Core Extension
\ingroup gtc
\brief Defines a number of matrices with integer types.
You must include <glm/gtc/matrix_integer.hpp> to get this functionality.
**/
/*!
\defgroup gtc_matrix_inverse Matrix Inverse Core Extension
\ingroup gtc
\brief Defines additional matrix inverting functions.
You must include <glm/gtc/matrix_inverse.hpp> to get this functionality.
**/
/*!
\defgroup gtc_matrix_transform Matrix Transform Core Extension
\ingroup gtc
\brief Defines functions that generate common transformation matrices.
The matrices generated by this extension use standard OpenGL fixed-function
conventions. For example, the lookAt function generates a transform from world
space into the specific eye space that the projective matrix functions (
perspective, ortho, etc) are designed to expect. The OpenGL compatibility
specifications defines the particular layout of this eye space.
You must include <glm/gtc/matrix_transform.hpp> to get this functionality.
**/
/*!
\defgroup gtc_quaternion Quaternion Core Extension
\ingroup gtc
\brief Defines a templated quaternion type and several quaternion operations.
You must include <glm/gtc/quaternion.hpp> to get this functionality.
**/
/*!
\defgroup gtc_type_precision Type Precision Core Extension
\ingroup gtc
\brief Defines specific C++-based precision types.
\ref core_precision defines types based on GLSL's precision qualifiers. This
extension defines types based on explicitly-sized C++ data types.
You must include the file <glm/gtc/type_precision.hpp> to get this functionality.
**/
/*!
\defgroup gtc_type_ptr Pointer Access Core Extension
\ingroup gtc
\brief Used to get a pointer to the memory layout of a basic type.
This extension defines an overloaded function, glm::value_ptr, which
takes any of the \ref core_template "core template types". It returns
a pointer to the memory layout of the object. Matrix types store their values
in row-major order.
This is useful for uploading data to matrices or copying data to buffer objects.
Example:
\code
#include <glm/glm.hpp>
#include <glm/gtc/type_ptr.hpp>
glm::vec3 aVector(3);
glm::mat4 someMatrix(1.0);
glUniform3fv(uniformLoc, 1, glm::value_ptr(aVector));
glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix));
\endcode
You must include the file <glm/gtc/type_ptr.hpp> to get this functionality.
**/

4
glm/glm.hpp
View File

@ -22,8 +22,8 @@
//! TODO: to delete
#define GLMvalType typename genType::value_type
#define GLMcolType typename genType::col_type
#define GLMrowType typename genType::row_type
//#define GLMcolType typename genType::col_type
//#define GLMrowType typename genType::row_type
#include <cmath>
#include <climits>