AuroraMiddleware/glm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated doxygen doc

Browse Source
This commit is contained in:
Christophe Riccio 2018-08-10 00:27:24 +02:00
parent 4ed0bf7033
commit 9abf4a5d68
20 changed files with 66 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
glm/ext/matrix_relational.hpp
View File

@ -13,7 +13,6 @@
#pragma once
// Dependencies
#include "../detail/setup.hpp"
#include "../detail/qualifier.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)

6
glm/ext/quaternion_float.hpp
View File

@ -1,10 +1,10 @@
/// @ref quaternion_float
/// @ref ext_quaternion_float
/// @file glm/ext/quaternion_float.hpp
///
/// @see core (dependence)
///
/// @defgroup gtc_quaternion GLM_EXT_quaternion_float
/// @ingroup gtc
/// @defgroup ext_quaternion_float GLM_EXT_quaternion_float
/// @ingroup ext
///
/// Include <glm/ext/quaternion_float.hpp> to use the features of this extension.
///

20
glm/ext/quaternion_float_precision.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_quaternion_float
/// @file glm/ext/quaternion_float.hpp
/// @ref ext_quaternion_float_precision
/// @file glm/ext/quaternion_float_precision.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_quaternion_float GLM_EXT_quaternion_float
/// @defgroup ext_quaternion_float_precision GLM_EXT_quaternion_float_precision
/// @ingroup ext
///
/// Include <glm/ext/quaternion_float.hpp> to use the features of this extension.
/// Include <glm/ext/quaternion_float_precision.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations.
@ -16,27 +16,27 @@
#include "../detail/type_quat.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_quaternion_float extension included")
# pragma message("GLM: GLM_EXT_quaternion_float_precision extension included")
#endif
namespace glm
{
/// @addtogroup ext_quaternion_float
/// @addtogroup ext_quaternion_float_precision
/// @{
/// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs.
///
/// @see ext_quaternion_float
/// @see ext_quaternion_float_precision
typedef qua<float, lowp> lowp_quat;
/// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs.
///
/// @see ext_quaternion_float
typedef qua<float, mediump> mediump_quat;
/// @see ext_quaternion_float_precision
typedef qua<float, mediump> mediump_quat;
/// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs.
///
/// @see ext_quaternion_float
/// @see ext_quaternion_float_precision
typedef qua<float, highp> highp_quat;
/// @}

13
glm/ext/quaternion_geometric.hpp
View File

@ -13,18 +13,7 @@
#pragma once
// Dependency:
#include "../gtc/constants.hpp"
#include "../gtc/matrix_transform.hpp"
#include "../ext/vector_relational.hpp"
#include "../ext/quaternion_float.hpp"
#include "../ext/quaternion_float_precision.hpp"
#include "../ext/quaternion_double.hpp"
#include "../ext/quaternion_double_precision.hpp"
#include "../ext/quaternion_relational.hpp"
#include "../detail/type_mat3x3.hpp"
#include "../detail/type_mat4x4.hpp"
#include "../detail/type_vec3.hpp"
#include "../detail/type_vec4.hpp"
#include "../detail/qualifier.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_GTC_quaternion extension included")

4
glm/ext/quaternion_geometric.inl
View File

@ -1,6 +1,6 @@
#include "../geometric.hpp"
#include "../exponential.hpp"
#include <limits>
#include "../ext/vector_relational.hpp"
namespace glm
{
@ -25,7 +25,7 @@ namespace glm
T len = length(q);
if(len <= static_cast<T>(0)) // Problem
return qua<T, Q>(static_cast<T>(1), static_cast<T>(0), static_cast<T>(0), static_cast<T>(0));
T oneOverLen = T(1) / len;
T oneOverLen = static_cast<T>(1) / len;
return qua<T, Q>(q.w * oneOverLen, q.x * oneOverLen, q.y * oneOverLen, q.z * oneOverLen);
}

1
glm/ext/scalar_relational.hpp
View File

@ -13,7 +13,6 @@
#pragma once
// Dependencies
#include "../detail/setup.hpp"
#include "../detail/qualifier.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)

18
glm/ext/vector_double1_precision.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_vector_dvec1_precision
/// @file glm/ext/vector_dvec1_precision.hpp
/// @ref ext_vector_double1_precision
/// @file glm/ext/vector_double1_precision.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_vector_dvec1_precision GLM_EXT_vector_dvec1_precision
/// @defgroup ext_vector_double1_precision GLM_EXT_vector_double1_precision
/// @ingroup ext
///
/// Include <glm/ext/vector_dvec1_precision.hpp> to use the features of this extension.
/// Include <glm/ext/vector_double1_precision.hpp> to use the features of this extension.
///
/// Exposes highp_dvec1, mediump_dvec1 and lowp_dvec1 types.
@ -15,27 +15,27 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_vector_dvec1_precision extension included")
# pragma message("GLM: GLM_EXT_vector_double1_precision extension included")
#endif
namespace glm
{
/// @addtogroup ext_vector_dvec1_precision
/// @addtogroup ext_vector_double1_precision
/// @{
/// 1 component vector of double-precision floating-point numbers using high precision arithmetic in term of ULPs.
///
/// @see ext_vector_dvec1_precision
/// @see ext_vector_double1_precision
typedef vec<1, double, highp> highp_dvec1;
/// 1 component vector of double-precision floating-point numbers using medium precision arithmetic in term of ULPs.
///
/// @see ext_vector_dvec1_precision
/// @see ext_vector_double1_precision
typedef vec<1, double, mediump> mediump_dvec1;
/// 1 component vector of double-precision floating-point numbers using low precision arithmetic in term of ULPs.
///
/// @see ext_vector_dvec1_precision
/// @see ext_vector_double1_precision
typedef vec<1, double, lowp> lowp_dvec1;
/// @}

2
glm/ext/vector_double2_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/dvec2_precision.hpp
/// @file glm/vector_double2_precision.hpp
#pragma once
#include "../detail/type_vec2.hpp"

2
glm/ext/vector_double3_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/dvec3_precision.hpp
/// @file glm/vector_double3_precision.hpp
#pragma once
#include "../detail/type_vec3.hpp"

2
glm/ext/vector_double4_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/dvec4_precision.hpp
/// @file glm/vector_double4_precision.hpp
#pragma once
#include "../detail/setup.hpp"

14
glm/ext/vector_float1.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_vector_vec1
/// @file glm/ext/vector_vec1.hpp
/// @ref ext_vector_float1
/// @file glm/ext/vector_float1.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_vector_vec1 GLM_EXT_vector_vec1
/// @defgroup ext_vector_float1 GLM_EXT_vector_float1
/// @ingroup ext
///
/// Include <glm/ext/vector_vec1.hpp> to use the features of this extension.
/// Include <glm/ext/vector_float1.hpp> to use the features of this extension.
///
/// Exposes vec1 vector type.
@ -15,12 +15,12 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_vector_vec1 extension included")
# pragma message("GLM: GLM_EXT_vector_float1 extension included")
#endif
namespace glm
{
/// @addtogroup ext_vector_vec1
/// @addtogroup ext_vector_float1
/// @{
# if GLM_CONFIG_PRECISION_FLOAT == GLM_LOWP
@ -30,7 +30,7 @@ namespace glm
# else
/// 1 components vector of single-precision floating-point numbers.
///
/// @see ext_vector_vec1 extension.
/// @see ext_vector_float1 extension.
typedef vec<1, float, highp> vec1;
# endif

18
glm/ext/vector_float1_precision.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_fvec1_precision
/// @file glm/ext/fvec1_precision.hpp
/// @ref ext_vector_float1_precision
/// @file glm/ext/vector_float1_precision.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_fvec1_precision GLM_EXT_fvec1_precision
/// @defgroup ext_vector_float1_precision GLM_EXT_vector_float1_precision
/// @ingroup ext
///
/// Include <glm/ext/fvec1_precision.hpp> to use the features of this extension.
/// Include <glm/ext/vector_float1_precision.hpp> to use the features of this extension.
///
/// Exposes highp_vec1, mediump_vec1 and lowp_vec1 types.
@ -15,27 +15,27 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_fvec1_precision extension included")
# pragma message("GLM: GLM_EXT_vector_float1_precision extension included")
#endif
namespace glm
{
/// @addtogroup ext_fvec1_precision
/// @addtogroup ext_vector_float1_precision
/// @{
/// 1 component vector of single-precision floating-point numbers using high precision arithmetic in term of ULPs.
///
/// @see ext_fvec1_precision
/// @see ext_vector_float1_precision
typedef vec<1, float, highp> highp_vec1;
/// 1 component vector of single-precision floating-point numbers using medium precision arithmetic in term of ULPs.
///
/// @see ext_fvec1_precision
/// @see ext_vector_float1_precision
typedef vec<1, float, mediump> mediump_vec1;
/// 1 component vector of single-precision floating-point numbers using low precision arithmetic in term of ULPs.
///
/// @see ext_fvec1_precision
/// @see ext_vector_float1_precision
typedef vec<1, float, lowp> lowp_vec1;
/// @}

2
glm/ext/vector_float2_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/fvec2_precision.hpp
/// @file glm/ext/vector_float2_precision.hpp
#pragma once
#include "../detail/type_vec2.hpp"

2
glm/ext/vector_float3_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/fvec3_precision.hpp
/// @file glm/vector_float3_precision.hpp
#pragma once
#include "../detail/setup.hpp"

2
glm/ext/vector_float4_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/fvec4_precision.hpp
/// @file glm/vector_float4_precision.hpp
#pragma once
#include "../detail/type_vec4.hpp"

14
glm/ext/vector_int1.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_vector_ivec1
/// @file glm/ext/vector_ivec1.hpp
/// @ref ext_vector_int1
/// @file glm/ext/vector_int1.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_vector_ivec1 GLM_EXT_vector_ivec1
/// @defgroup ext_vector_int1 GLM_EXT_vector_int1
/// @ingroup ext
///
/// Include <glm/ext/vector_ivec1.hpp> to use the features of this extension.
/// Include <glm/ext/vector_int1.hpp> to use the features of this extension.
///
/// Exposes ivec1 vector type.
@ -15,12 +15,12 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_vector_ivec1 extension included")
# pragma message("GLM: GLM_EXT_vector_int1 extension included")
#endif
namespace glm
{
/// @addtogroup ext_vector_ivec1
/// @addtogroup ext_vector_int1
/// @{
# if GLM_CONFIG_PRECISION_INT == GLM_LOWP
@ -30,7 +30,7 @@ namespace glm
# else
/// 1 component vector of signed integer numbers.
///
/// @see ext_vector_ivec1 extension.
/// @see ext_vector_int1 extension.
typedef vec<1, int, highp> ivec1;
# endif

18
glm/ext/vector_int1_precision.hpp
View File

@ -1,12 +1,12 @@
/// @ref ext_ivec1_precision
/// @file glm/ext/ivec1_precision.hpp
/// @ref ext_vector_int1_precision
/// @file glm/ext/vector_int1_precision.hpp
///
/// @see core (dependence)
///
/// @defgroup ext_ivec1_precision GLM_EXT_ivec1_precision
/// @defgroup ext_vector_int1_precision GLM_EXT_vector_int1_precision
/// @ingroup ext
///
/// Include <glm/ext/ivec1_precision.hpp> to use the features of this extension.
/// Include <glm/ext/vector_int1_precision.hpp> to use the features of this extension.
///
/// Add Exposes highp_ivec1, mediump_ivec1 and lowp_ivec1 types.
@ -15,27 +15,27 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_uvec1_precision extension included")
# pragma message("GLM: GLM_EXT_vector_int1_precision extension included")
#endif
namespace glm
{
/// @addtogroup ext_ivec1_precision
/// @addtogroup ext_vector_int1_precision
/// @{
/// 1 component vector of signed integer values.
///
/// @see ext_ivec1_precision
/// @see ext_vector_int1_precision
typedef vec<1, int, highp> highp_ivec1;
/// 1 component vector of signed integer values.
///
/// @see ext_ivec1_precision
/// @see ext_vector_int1_precision
typedef vec<1, int, mediump> mediump_ivec1;
/// 1 component vector of signed integer values.
///
/// @see ext_ivec1_precision
/// @see ext_vector_int1_precision
typedef vec<1, int, lowp> lowp_ivec1;
/// @}

2
glm/ext/vector_int2_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/ivec2_precision.hpp
/// @file glm/vector_int2_precision.hpp
#pragma once
#include "../detail/setup.hpp"

2
glm/ext/vector_int3_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/ivec3_precision.hpp
/// @file glm/vector_int3_precision.hpp
#pragma once
#include "../detail/setup.hpp"

2
glm/ext/vector_int4_precision.hpp
View File

@ -1,5 +1,5 @@
/// @ref core
/// @file glm/ivec4_precision.hpp
/// @file glm/vector_int4_precision.hpp
#pragma once
#include "../detail/type_vec4.hpp"