From 6a45579dbbf991c0e12ce59958e3b533d19fc9d4 Mon Sep 17 00:00:00 2001 From: jjesswan Date: Tue, 7 May 2024 06:02:29 -0400 Subject: rotating skyboxgit add -A --- glm-master/doc/api/a00299.html | 619 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 619 insertions(+) create mode 100644 glm-master/doc/api/a00299.html (limited to 'glm-master/doc/api/a00299.html') diff --git a/glm-master/doc/api/a00299.html b/glm-master/doc/api/a00299.html new file mode 100644 index 0000000..89d49c9 --- /dev/null +++ b/glm-master/doc/api/a00299.html @@ -0,0 +1,619 @@ + + + + + + +0.9.9 API documentation: GLM_GTC_quaternion + + + + + + + + + + +
+
+ + + + + + + +
+
0.9.9 API documentation +
+
+
+ + + + +
+ +
+
+ + +
+ +
+ +
+ +
+
GLM_GTC_quaternion
+
+
+ +

Include <glm/gtc/quaternion.hpp> to use the features of this extension. +More...

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

template<typename T , qualifier Q>
GLM_FUNC_DECL vec< 3, T, Q > eulerAngles (qua< T, Q > const &x)
 Returns euler angles, pitch as x, yaw as y, roll as z. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL vec< 4, bool, Q > greaterThan (qua< T, Q > const &x, qua< T, Q > const &y)
 Returns the component-wise comparison of result x > y. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL vec< 4, bool, Q > greaterThanEqual (qua< T, Q > const &x, qua< T, Q > const &y)
 Returns the component-wise comparison of result x >= y. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL vec< 4, bool, Q > lessThan (qua< T, Q > const &x, qua< T, Q > const &y)
 Returns the component-wise comparison result of x < y. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL vec< 4, bool, Q > lessThanEqual (qua< T, Q > const &x, qua< T, Q > const &y)
 Returns the component-wise comparison of result x <= y. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL mat< 3, 3, T, Q > mat3_cast (qua< T, Q > const &x)
 Converts a quaternion to a 3 * 3 matrix. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL mat< 4, 4, T, Q > mat4_cast (qua< T, Q > const &x)
 Converts a quaternion to a 4 * 4 matrix. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL T pitch (qua< T, Q > const &x)
 Returns pitch value of euler angles expressed in radians. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL qua< T, Q > quat_cast (mat< 3, 3, T, Q > const &x)
 Converts a pure rotation 3 * 3 matrix to a quaternion. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL qua< T, Q > quat_cast (mat< 4, 4, T, Q > const &x)
 Converts a pure rotation 4 * 4 matrix to a quaternion. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL qua< T, Q > quatLookAt (vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)
 Build a look at quaternion based on the default handedness. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL qua< T, Q > quatLookAtLH (vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)
 Build a left-handed look at quaternion. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL qua< T, Q > quatLookAtRH (vec< 3, T, Q > const &direction, vec< 3, T, Q > const &up)
 Build a right-handed look at quaternion. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL T roll (qua< T, Q > const &x)
 Returns roll value of euler angles expressed in radians. More...
 
template<typename T , qualifier Q>
GLM_FUNC_DECL T yaw (qua< T, Q > const &x)
 Returns yaw value of euler angles expressed in radians. More...
 
+

Detailed Description

+

Include <glm/gtc/quaternion.hpp> to use the features of this extension.

+

Defines a templated quaternion type and several quaternion operations.

+

Function Documentation

+ +
+
+ + + + + + + + +
GLM_FUNC_DECL vec<3, T, Q> glm::eulerAngles (qua< T, Q > const & x)
+
+ +

Returns euler angles, pitch as x, yaw as y, roll as z.

+

The result is expressed in radians.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL vec<4, bool, Q> glm::greaterThan (qua< T, Q > const & x,
qua< T, Q > const & y 
)
+
+ +

Returns the component-wise comparison of result x > y.

+
Template Parameters
+ + + +
TFloating-point scalar types
QValue from qualifier enum
+
+
+
See also
GLM_EXT_quaternion_relational
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL vec<4, bool, Q> glm::greaterThanEqual (qua< T, Q > const & x,
qua< T, Q > const & y 
)
+
+ +

Returns the component-wise comparison of result x >= y.

+
Template Parameters
+ + + +
TFloating-point scalar types
QValue from qualifier enum
+
+
+
See also
GLM_EXT_quaternion_relational
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL vec<4, bool, Q> glm::lessThan (qua< T, Q > const & x,
qua< T, Q > const & y 
)
+
+ +

Returns the component-wise comparison result of x < y.

+
Template Parameters
+ + + +
TFloating-point scalar types
QValue from qualifier enum
+
+
+
See also
GLM_EXT_quaternion_relational
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL vec<4, bool, Q> glm::lessThanEqual (qua< T, Q > const & x,
qua< T, Q > const & y 
)
+
+ +

Returns the component-wise comparison of result x <= y.

+
Template Parameters
+ + + +
TFloating-point scalar types
QValue from qualifier enum
+
+
+
See also
GLM_EXT_quaternion_relational
+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL mat<3, 3, T, Q> glm::mat3_cast (qua< T, Q > const & x)
+
+ +

Converts a quaternion to a 3 * 3 matrix.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +

Referenced by glm::toMat3().

+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL mat<4, 4, T, Q> glm::mat4_cast (qua< T, Q > const & x)
+
+ +

Converts a quaternion to a 4 * 4 matrix.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +

Referenced by glm::toMat4().

+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL T glm::pitch (qua< T, Q > const & x)
+
+ +

Returns pitch value of euler angles expressed in radians.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL qua<T, Q> glm::quat_cast (mat< 3, 3, T, Q > const & x)
+
+ +

Converts a pure rotation 3 * 3 matrix to a quaternion.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +

Referenced by glm::toQuat().

+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL qua<T, Q> glm::quat_cast (mat< 4, 4, T, Q > const & x)
+
+ +

Converts a pure rotation 4 * 4 matrix to a quaternion.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL qua<T, Q> glm::quatLookAt (vec< 3, T, Q > const & direction,
vec< 3, T, Q > const & up 
)
+
+ +

Build a look at quaternion based on the default handedness.

+
Parameters
+ + + +
directionDesired forward direction. Needs to be normalized.
upUp vector, how the camera is oriented. Typically (0, 1, 0).
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL qua<T, Q> glm::quatLookAtLH (vec< 3, T, Q > const & direction,
vec< 3, T, Q > const & up 
)
+
+ +

Build a left-handed look at quaternion.

+
Parameters
+ + + +
directionDesired forward direction onto which the +z-axis gets mapped. Needs to be normalized.
upUp vector, how the camera is oriented. Typically (0, 1, 0).
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
GLM_FUNC_DECL qua<T, Q> glm::quatLookAtRH (vec< 3, T, Q > const & direction,
vec< 3, T, Q > const & up 
)
+
+ +

Build a right-handed look at quaternion.

+
Parameters
+ + + +
directionDesired forward direction onto which the -z-axis gets mapped. Needs to be normalized.
upUp vector, how the camera is oriented. Typically (0, 1, 0).
+
+
+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL T glm::roll (qua< T, Q > const & x)
+
+ +

Returns roll value of euler angles expressed in radians.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +
+
+ +
+
+ + + + + + + + +
GLM_FUNC_DECL T glm::yaw (qua< T, Q > const & x)
+
+ +

Returns yaw value of euler angles expressed in radians.

+
Template Parameters
+ + +
TFloating-point scalar types.
+
+
+
See also
GLM_GTC_quaternion
+ +
+
+
+ + + + -- cgit v1.2.3-70-g09d2