mewin/glm
1
0
Fork 0
Code Releases Activity

- Improved API documentation #668

Browse Source
This commit is contained in:
Christophe Riccio
2017-08-17 16:24:32 +02:00
parent b9936ac0ca
commit d93a3be4ac
97 changed files with 265 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
glm/gtc/bitfield.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_bitfield GLM_GTC_bitfield
/// @ingroup gtc
///
/// @brief Allow to perform bit operations on integer values
/// Include <glm/gtc/bitfield.hpp> to use the features of this extension.
///
/// <glm/gtc/bitfield.hpp> need to be included to use these functionalities.
/// Allow to perform bit operations on integer values
#include "../detail/setup.hpp"

4
glm/gtc/color_space.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_color_space GLM_GTC_color_space
/// @ingroup gtc
///
/// @brief Allow to perform bit operations on integer values
/// Include <glm/gtc/color_space.hpp> to use the features of this extension.
///
/// <glm/gtc/color_space.hpp> need to be included to use these functionalities.
/// Allow to perform bit operations on integer values
#pragma once

6
glm/gtc/constants.hpp
View File

@@ -5,10 +5,10 @@
///
/// @defgroup gtc_constants GLM_GTC_constants
/// @ingroup gtc
///
/// Include <glm/gtc/constants.hpp> to use the features of this extension.
///
/// @brief Provide a list of constants and precomputed useful values.
///
/// <glm/gtc/constants.hpp> need to be included to use these features.
/// Provide a list of constants and precomputed useful values.
#pragma once

6
glm/gtc/epsilon.hpp
View File

@@ -6,10 +6,10 @@
///
/// @defgroup gtc_epsilon GLM_GTC_epsilon
/// @ingroup gtc
///
/// Include <glm/gtc/epsilon.hpp> to use the features of this extension.
///
/// @brief Comparison functions for a user defined epsilon values.
///
/// <glm/gtc/epsilon.hpp> need to be included to use these functionalities.
/// Comparison functions for a user defined epsilon values.
#pragma once

52
glm/gtc/functions.hpp
View File

@@ -1,52 +0,0 @@
/// @ref gtc_functions
/// @file glm/gtc/functions.hpp
///
/// @see core (dependence)
/// @see gtc_quaternion (dependence)
///
/// @defgroup gtc_functions GLM_GTC_functions
/// @ingroup gtc
///
/// @brief List of useful common functions.
///
/// <glm/gtc/functions.hpp> need to be included to use these functionalities.
#pragma once
// Dependencies
#include "../detail/setup.hpp"
#include "../detail/qualifier.hpp"
#include "../detail/type_vec2.hpp"
#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_GTC_functions extension included")
#endif
namespace glm
{
/// @addtogroup gtc_functions
/// @{
/// 1D gauss function
///
/// @see gtc_epsilon
template<typename T>
GLM_FUNC_DECL T gauss(
T x,
T ExpectedValue,
T StandardDeviation);
/// 2D gauss function
///
/// @see gtc_epsilon
template<typename T, qualifier Q>
GLM_FUNC_DECL T gauss(
vec<2, T, Q> const& Coord,
vec<2, T, Q> const& ExpectedValue,
vec<2, T, Q> const& StandardDeviation);
/// @}
}//namespace glm
#include "functions.inl"

31
glm/gtc/functions.inl
View File

@@ -1,31 +0,0 @@
/// @ref gtc_functions
/// @file glm/gtc/functions.inl
#include "../detail/func_exponential.hpp"
namespace glm
{
template<typename T>
GLM_FUNC_QUALIFIER T gauss
(
T x,
T ExpectedValue,
T StandardDeviation
)
{
return exp(-((x - ExpectedValue) * (x - ExpectedValue)) / (static_cast<T>(2) * StandardDeviation * StandardDeviation)) / (StandardDeviation * sqrt(static_cast<T>(6.28318530717958647692528676655900576)));
}
template<typename T, qualifier Q>
GLM_FUNC_QUALIFIER T gauss
(
vec<2, T, Q> const& Coord,
vec<2, T, Q> const& ExpectedValue,
vec<2, T, Q> const& StandardDeviation
)
{
vec<2, T, Q> const Squared = ((Coord - ExpectedValue) * (Coord - ExpectedValue)) / (static_cast<T>(2) * StandardDeviation * StandardDeviation);
return exp(-(Squared.x + Squared.y));
}
}//namespace glm

4
glm/gtc/integer.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_integer GLM_GTC_integer
/// @ingroup gtc
///
/// @brief Allow to perform bit operations on integer values
/// Include <glm/gtc/integer.hpp> to use the features of this extension.
///
/// <glm/gtc/integer.hpp> need to be included to use these functionalities.
/// @brief Allow to perform bit operations on integer values
#pragma once

5
glm/gtc/matrix_access.hpp
View File

@@ -5,9 +5,10 @@
///
/// @defgroup gtc_matrix_access GLM_GTC_matrix_access
/// @ingroup gtc
///
///
/// Include <glm/gtc/matrix_access.hpp> to use the features of this extension.
///
/// Defines functions to access rows or columns of a matrix easily.
/// <glm/gtc/matrix_access.hpp> need to be included to use these functionalities.
#pragma once

3
glm/gtc/matrix_integer.hpp
View File

@@ -6,8 +6,9 @@
/// @defgroup gtc_matrix_integer GLM_GTC_matrix_integer
/// @ingroup gtc
///
/// Include <glm/gtc/matrix_integer.hpp> to use the features of this extension.
///
/// Defines a number of matrices with integer types.
/// <glm/gtc/matrix_integer.hpp> need to be included to use these functionalities.
#pragma once

3
glm/gtc/matrix_inverse.hpp
View File

@@ -6,8 +6,9 @@
/// @defgroup gtc_matrix_inverse GLM_GTC_matrix_inverse
/// @ingroup gtc
///
/// Include <glm/gtc/matrix_integer.hpp> to use the features of this extension.
///
/// Defines additional matrix inverting functions.
/// <glm/gtc/matrix_inverse.hpp> need to be included to use these functionalities.
#pragma once

6
glm/gtc/matrix_transform.hpp
View File

@@ -8,15 +8,15 @@
/// @defgroup gtc_matrix_transform GLM_GTC_matrix_transform
/// @ingroup gtc
///
/// @brief Defines functions that generate common transformation matrices.
/// Include <glm/gtc/matrix_transform.hpp> to use the features of this extension.
///
/// 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.
///
/// <glm/gtc/matrix_transform.hpp> need to be included to use these functionalities.
#pragma once

3
glm/gtc/noise.hpp
View File

@@ -6,12 +6,13 @@
/// @defgroup gtc_noise GLM_GTC_noise
/// @ingroup gtc
///
/// Include <glm/gtc/noise.hpp> to use the features of this extension.
///
/// Defines 2D, 3D and 4D procedural noise functions
/// Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise":
/// https://github.com/ashima/webgl-noise
/// Following Stefan Gustavson's paper "Simplex noise demystified":
/// http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf
/// <glm/gtc/noise.hpp> need to be included to use these functionalities.
#pragma once

6
glm/gtc/packing.hpp
View File

@@ -6,10 +6,10 @@
/// @defgroup gtc_packing GLM_GTC_packing
/// @ingroup gtc
///
/// @brief This extension provides a set of function to convert vertors to packed
/// formats.
/// Include <glm/gtc/packing.hpp> to use the features of this extension.
///
/// <glm/gtc/packing.hpp> need to be included to use these features.
/// This extension provides a set of function to convert vertors to packed
/// formats.
#pragma once

4
glm/gtc/quaternion.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_quaternion GLM_GTC_quaternion
/// @ingroup gtc
///
/// @brief Defines a templated quaternion type and several quaternion operations.
/// Include <glm/gtc/quaternion.hpp> to use the features of this extension.
///
/// <glm/gtc/quaternion.hpp> need to be included to use these functionalities.
/// Defines a templated quaternion type and several quaternion operations.
#pragma once

4
glm/gtc/random.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_random GLM_GTC_random
/// @ingroup gtc
///
/// @brief Generate random number from various distribution methods.
/// Include <glm/gtc/random.hpp> to use the features of this extension.
///
/// <glm/gtc/random.hpp> need to be included to use these functionalities.
/// Generate random number from various distribution methods.
#pragma once

4
glm/gtc/reciprocal.hpp
View File

@@ -6,9 +6,9 @@
/// @defgroup gtc_reciprocal GLM_GTC_reciprocal
/// @ingroup gtc
///
/// @brief Define secant, cosecant and cotangent functions.
/// Include <glm/gtc/reciprocal.hpp> to use the features of this extension.
///
/// <glm/gtc/reciprocal.hpp> need to be included to use these features.
/// Define secant, cosecant and cotangent functions.
#pragma once

4
glm/gtc/round.hpp
View File

@@ -7,9 +7,9 @@
/// @defgroup gtc_round GLM_GTC_round
/// @ingroup gtc
///
/// @brief rounding value to specific boundings
/// Include <glm/gtc/round.hpp> to use the features of this extension.
///
/// <glm/gtc/round.hpp> need to be included to use these functionalities.
/// Rounding value to specific boundings
#pragma once

5
glm/gtc/type_aligned.hpp
View File

@@ -6,8 +6,9 @@
/// @defgroup gtc_type_aligned GLM_GTC_type_aligned
/// @ingroup gtc
///
/// @brief Aligned types.
/// <glm/gtc/type_aligned.hpp> need to be included to use these features.
/// Include <glm/gtc/type_aligned.hpp> to use the features of this extension.
///
/// Aligned types allowing SIMD optimizations of vectors and matrices types
#pragma once

6
glm/gtc/type_precision.hpp
View File

@@ -7,12 +7,12 @@
/// @defgroup gtc_type_precision GLM_GTC_type_precision
/// @ingroup gtc
///
/// @brief Defines specific C++-based qualifier types.
/// Include <glm/gtc/type_precision.hpp> to use the features of this extension.
///
/// Defines specific C++-based qualifier types.
///
/// @ref core_precision defines types based on GLSL's qualifier qualifiers. This
/// extension defines types based on explicitly-sized C++ data types.
///
/// <glm/gtc/type_precision.hpp> need to be included to use these functionalities.
#pragma once

6
glm/gtc/type_ptr.hpp
View File

@@ -7,7 +7,9 @@
/// @defgroup gtc_type_ptr GLM_GTC_type_ptr
/// @ingroup gtc
///
/// @brief Handles the interaction between pointers and vector, matrix types.
/// Include <glm/gtc/type_ptr.hpp> to use the features of this extension.
///
/// Handles the interaction between pointers and vector, matrix types.
///
/// This extension defines an overloaded function, glm::value_ptr, which
/// takes any of the \ref core_template "core template types". It returns
@@ -28,7 +30,7 @@
/// glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix));
/// @endcode
///
/// <glm/gtc/type_ptr.hpp> need to be included to use these functionalities.
/// <glm/gtc/type_ptr.hpp> need to be included to use the features of this extension.
#pragma once

5
glm/gtc/ulp.hpp
View File

@@ -6,10 +6,11 @@
/// @defgroup gtc_ulp GLM_GTC_ulp
/// @ingroup gtc
///
/// @brief Allow the measurement of the accuracy of a function against a reference
/// Include <glm/gtc/ulp.hpp> to use the features of this extension.
///
/// Allow the measurement of the accuracy of a function against a reference
/// implementation. This extension works on floating-point data and provide results
/// in ULP.
/// <glm/gtc/ulp.hpp> need to be included to use these features.
#pragma once

5
glm/gtc/vec1.hpp
View File

@@ -5,9 +5,10 @@
///
/// @defgroup gtc_vec1 GLM_GTC_vec1
/// @ingroup gtc
///
/// Include <glm/gtc/vec1.hpp> to use the features of this extension.
///
/// @brief Add vec1, ivec1, uvec1 and bvec1 types.
/// <glm/gtc/vec1.hpp> need to be included to use these functionalities.
/// Add vec1, ivec1, uvec1 and bvec1 types.
#pragma once