docs: add docs for vec3-ext

This commit is contained in:
Recep Aslantas
2018-02-26 17:10:33 +03:00
parent 77e62163ea
commit be3f117374
3 changed files with 115 additions and 16 deletions

View File

@@ -33,9 +33,9 @@
/*!
* @brief multiplies individual items, just for convenient like SIMD
*
* @param a vec1
* @param b vec2
* @param d vec3 = (v1[0] * v2[0], v1[1] * v2[1], v1[2] * v2[2])
* @param[in] a vec1
* @param[in] b vec2
* @param[out] d vec3 = (v1[0] * v2[0], v1[1] * v2[1], v1[2] * v2[2])
*/
CGLM_INLINE
void
@@ -48,8 +48,8 @@ glm_vec_mulv(vec3 a, vec3 b, vec3 d) {
/*!
* @brief fill a vector with specified value
*
* @param val value
* @param d dest
* @param[in] val value
* @param[out] d dest
*/
CGLM_INLINE
void
@@ -60,8 +60,8 @@ glm_vec_broadcast(float val, vec3 d) {
/*!
* @brief check if vector is equal to value (without epsilon)
*
* @param v vector
* @param val value
* @param[in] v vector
* @param[in] val value
*/
CGLM_INLINE
bool
@@ -72,8 +72,8 @@ glm_vec_eq(vec3 v, float val) {
/*!
* @brief check if vector is equal to value (with epsilon)
*
* @param v vector
* @param val value
* @param[in] v vector
* @param[in] val value
*/
CGLM_INLINE
bool
@@ -86,7 +86,7 @@ glm_vec_eq_eps(vec4 v, float val) {
/*!
* @brief check if vectors members are equal (without epsilon)
*
* @param v vector
* @param[in] v vector
*/
CGLM_INLINE
bool
@@ -97,8 +97,8 @@ glm_vec_eq_all(vec3 v) {
/*!
* @brief check if vector is equal to another (without epsilon)
*
* @param v1 vector
* @param v2 vector
* @param[in] v1 vector
* @param[in] v2 vector
*/
CGLM_INLINE
bool
@@ -111,8 +111,8 @@ glm_vec_eqv(vec3 v1, vec3 v2) {
/*!
* @brief check if vector is equal to another (with epsilon)
*
* @param v1 vector
* @param v2 vector
* @param[in] v1 vector
* @param[in] v2 vector
*/
CGLM_INLINE
bool
@@ -125,7 +125,7 @@ glm_vec_eqv_eps(vec3 v1, vec3 v2) {
/*!
* @brief max value of vector
*
* @param v vector
* @param[in] v vector
*/
CGLM_INLINE
float
@@ -144,7 +144,7 @@ glm_vec_max(vec3 v) {
/*!
* @brief min value of vector
*
* @param v vector
* @param[in] v vector
*/
CGLM_INLINE
float