anulax
/
glm
1
0
Fork 0
Code Issues Pull Requests Packages project_board Releases Wiki Activity

Fixed doxygen

Browse Source
master
Christophe Riccio ago%!(EXTRA string=7 years)
parent 37504928bb
commit 34f0c510b6
9 changed files with 11 additions and 191 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      glm/ext/matrix_float4x4.hpp
  2. 6
      glm/ext/scalar_float_sized.hpp
  3. 4
      glm/ext/vector_bool1.hpp
  4. 2
      glm/ext/vector_uint1.hpp
  5. 24
      glm/glm.hpp
  6. 11
      glm/gtc/quaternion.hpp
  7. 106
      glm/gtc/type_precision.hpp
  8. 3
      glm/gtc/type_ptr.hpp
  9. 44
      glm/gtx/extended_min_max.hpp

2
glm/ext/matrix_float4x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm
{
/// @addtogroup core
/// @ingroup core
/// @{
/// 4 columns of 4 components matrix of single-precision floating-point numbers.

6
glm/ext/scalar_float_sized.hpp
Unescape View File

@ -20,13 +20,13 @@
namespace glm
{
/// @addtogroup ext_scalar_float
/// @addtogroup ext_scalar_float_sized
/// @{
/// Low qualifier floating-point numbers.
/// There is no guarantee on the actual qualifier.
///
/// @see ext_vector_relational
/// @see ext_scalar_float_sized
typedef float float32;
@ -35,7 +35,7 @@ namespace glm
/// Low qualifier floating-point numbers.
/// There is no guarantee on the actual qualifier.
///
/// @see ext_vector_relational
/// @see ext_scalar_float_sized
typedef double float64;
# endif//GLM_FORCE_SINGLE_ONLY

4
glm/ext/vector_bool1.hpp
Unescape View File

@ -15,12 +15,12 @@
#include "../detail/type_vec1.hpp"
#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_EXT_vector_bvec1 extension included")
# pragma message("GLM: GLM_EXT_vector_bool1 extension included")
#endif
namespace glm
{
/// @addtogroup ext_bvec1
/// @addtogroup ext_vector_bool1
/// @{
/// 1 components vector of boolean.

2
glm/ext/vector_uint1.hpp
Unescape View File

@ -3,7 +3,7 @@
///
/// @see core (dependence)
///
/// @defgroup ext_vector_uvec1 GLM_EXT_vector_uint1
/// @defgroup ext_vector_uint1 GLM_EXT_vector_uint1
/// @ingroup ext
///
/// Include <glm/ext/vector_uvec1.hpp> to use the features of this extension.

24
glm/glm.hpp
Unescape View File

@ -5,10 +5,10 @@
///
/// @brief Features that implement in C++ the GLSL specification as closely as possible.
///
/// The GLM core consists of @ref core_types "C++ types that mirror GLSL types" and
/// The GLM core consists of C++ types that mirror GLSL types and
/// C++ functions that mirror the GLSL functions. It also includes
/// @ref core_precision "a set of qualifier-based types" that can be used in the appropriate
/// functions. The C++ types are all based on a basic set of @ref core_template "template types".
/// functions.
///
/// The best documentation for GLM Core is the current GLSL specification,
/// <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.clean.pdf">version 4.2
@ -16,15 +16,6 @@
///
/// GLM core functionalities require <glm/glm.hpp> to be included to be used.
///
/// @defgroup core_types Types
///
/// @brief The standard types defined by the specification.
///
/// These types are all typedefs of more generalized, template types. To see the definition
/// of these template types, go to @ref core_template.
///
/// @ingroup core
///
/// @defgroup core_precision Precision types
///
/// @brief Non-GLSL types that are used to define qualifier-based types.
@ -34,21 +25,12 @@
/// with OpenGL ES's qualifier qualifiers, where they @em do have an effect.
///
/// C++ has no language equivalent to qualifier qualifiers. So GLM provides the next-best thing:
/// a number of typedefs of the @ref core_template that use a particular qualifier.
/// a number of typedefs that use a particular qualifier.
///
/// None of these types make any guarantees about the actual qualifier used.
///
/// @ingroup core
///
/// @defgroup core_template Template types
///
/// @brief The generic template types used as the basis for the core types.
///
/// These types are all templates used to define the actual @ref core_types.
/// These templates are implementation details of GLM types and should not be used explicitly.
///
/// @ingroup core
///
/// @defgroup ext Stable extensions
///
/// @brief Additional features not specified by GLSL specification.

11
glm/gtc/quaternion.hpp
Unescape View File

@ -40,17 +40,6 @@ namespace glm
/// @addtogroup gtc_quaternion
/// @{
/// Rotates a quaternion from a vector of 3 components axis and an angle.
///
/// @param q Source orientation
/// @param angle Angle expressed in radians.
/// @param axis Axis of the rotation
/// @tparam T Floating-point scalar types.
///
/// @see gtc_quaternion
template<typename T, qualifier Q>
GLM_FUNC_DECL qua<T, Q> rotate(qua<T, Q> const& q, T const& angle, vec<3, T, Q> const& axis);
/// Returns euler angles, pitch as x, yaw as y, roll as z.
/// The result is expressed in radians.
///

106
glm/gtc/type_precision.hpp
Unescape View File

@ -192,22 +192,6 @@ namespace glm
typedef detail::int64 highp_i64;
/// 8 bit signed integer type.
/// @see gtc_type_precision
typedef detail::int8 int8;
/// 16 bit signed integer type.
/// @see gtc_type_precision
typedef detail::int16 int16;
/// 32 bit signed integer type.
/// @see gtc_type_precision
typedef detail::int32 int32;
/// 64 bit signed integer type.
/// @see gtc_type_precision
typedef detail::int64 int64;
#if GLM_HAS_EXTENDED_INTEGER_TYPE
using std::int8_t;
using std::int16_t;
@ -677,22 +661,6 @@ namespace glm
/// @see gtc_type_precision
typedef detail::uint64 highp_u64;
/// Default qualifier 8 bit unsigned integer type.
/// @see gtc_type_precision
typedef detail::uint8 uint8;
/// Default qualifier 16 bit unsigned integer type.
/// @see gtc_type_precision
typedef detail::uint16 uint16;
/// Default qualifier 32 bit unsigned integer type.
/// @see gtc_type_precision
typedef detail::uint32 uint32;
/// Default qualifier 64 bit unsigned integer type.
/// @see gtc_type_precision
typedef detail::uint64 uint64;
#if GLM_HAS_EXTENDED_INTEGER_TYPE
using std::uint8_t;
using std::uint16_t;
@ -864,14 +832,6 @@ namespace glm
#if(defined(GLM_PRECISION_LOWP_FLOAT))
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef lowp_float32 float32;
/// Default 64 bit double-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef lowp_float64 float64;
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef lowp_float32_t float32_t;
@ -889,15 +849,6 @@ namespace glm
typedef lowp_f64 f64;
#elif(defined(GLM_PRECISION_MEDIUMP_FLOAT))
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef mediump_float32 float32;
/// Default 64 bit double-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef mediump_float64 float64;
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef mediump_float32 float32_t;
@ -916,14 +867,6 @@ namespace glm
#else//(defined(GLM_PRECISION_HIGHP_FLOAT))
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef highp_float32 float32;
/// Default 64 bit double-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef highp_float64 float64;
/// Default 32 bit single-qualifier floating-point scalar.
/// @see gtc_type_precision
typedef highp_float32_t float32_t;
@ -942,23 +885,6 @@ namespace glm
#endif
/// Low single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, lowp> lowp_vec1;
/// Low single-qualifier floating-point vector of 2 components.
/// @see core_precision
typedef vec<2, float, lowp> lowp_vec2;
/// Low single-qualifier floating-point vector of 3 components.
/// @see core_precision
typedef vec<3, float, lowp> lowp_vec3;
/// Low single-qualifier floating-point vector of 4 components.
/// @see core_precision
typedef vec<4, float, lowp> lowp_vec4;
/// Low single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, lowp> lowp_fvec1;
@ -976,22 +902,6 @@ namespace glm
typedef vec<4, float, lowp> lowp_fvec4;
/// Medium single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, mediump> mediump_vec1;
/// Medium Single-qualifier floating-point vector of 2 components.
/// @see core_precision
typedef vec<2, float, mediump> mediump_vec2;
/// Medium Single-qualifier floating-point vector of 3 components.
/// @see core_precision
typedef vec<3, float, mediump> mediump_vec3;
/// Medium Single-qualifier floating-point vector of 4 components.
/// @see core_precision
typedef vec<4, float, mediump> mediump_vec4;
/// Medium single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, mediump> mediump_fvec1;
@ -1009,22 +919,6 @@ namespace glm
typedef vec<4, float, mediump> mediump_fvec4;
/// High single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, highp> highp_vec1;
/// High Single-qualifier floating-point vector of 2 components.
/// @see core_precision
typedef vec<2, float, highp> highp_vec2;
/// High Single-qualifier floating-point vector of 3 components.
/// @see core_precision
typedef vec<3, float, highp> highp_vec3;
/// High Single-qualifier floating-point vector of 4 components.
/// @see core_precision
typedef vec<4, float, highp> highp_vec4;
/// High single-qualifier floating-point vector of 1 component.
/// @see gtc_type_precision
typedef vec<1, float, highp> highp_fvec1;

3
glm/gtc/type_ptr.hpp
Unescape View File

@ -11,8 +11,7 @@
///
/// 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
/// This extension defines an overloaded function, glm::value_ptr. It returns
/// a pointer to the memory layout of the object. Matrix types store their values
/// in column-major order.
///

44
glm/gtx/extended_min_max.hpp
Unescape View File

@ -138,28 +138,6 @@ namespace glm
template<typename genType>
GLM_FUNC_DECL genType fmin(genType x, genType y);
/// Returns y if y < x; otherwise, it returns x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
/// @tparam T Floating-point scalar types
/// @tparam Q Value from qualifier enum
///
/// @see gtx_extented_min_max
/// @see <a href="http://en.cppreference.com/w/cpp/numeric/math/fmin">std::fmin documentation</a>
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL vec<L, T, Q> fmin(vec<L, T, Q> const& x, T y);
/// Returns y if y < x; otherwise, it returns x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
/// @tparam T Floating-point scalar types
/// @tparam Q Value from qualifier enum
///
/// @see gtx_extented_min_max
/// @see <a href="http://en.cppreference.com/w/cpp/numeric/math/fmin">std::fmin documentation</a>
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL vec<L, T, Q> fmin(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
/// Returns y if x < y; otherwise, it returns x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam genType Floating-point; scalar or vector types.
@ -169,28 +147,6 @@ namespace glm
template<typename genType>
GLM_FUNC_DECL genType fmax(genType x, genType y);
/// Returns y if x < y; otherwise, it returns x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
/// @tparam T Floating-point scalar types
/// @tparam Q Value from qualifier enum
///
/// @see gtx_extented_min_max
/// @see <a href="http://en.cppreference.com/w/cpp/numeric/math/fmax">std::fmax documentation</a>
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL vec<L, T, Q> fmax(vec<L, T, Q> const& x, T y);
/// Returns y if x < y; otherwise, it returns x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
/// @tparam T Floating-point scalar types
/// @tparam Q Value from qualifier enum
///
/// @see gtx_extented_min_max
/// @see <a href="http://en.cppreference.com/w/cpp/numeric/math/fmax">std::fmax documentation</a>
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL vec<L, T, Q> fmax(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
/// Returns min(max(x, minVal), maxVal) for each component in x. If one of the two arguments is NaN, the value of the other argument is returned.
///
/// @tparam genType Floating-point scalar or vector types.

Write Preview
Loading…
Cancel
Save