External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-12-24 12:32:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve ivec[2|3|4] documentation comments

Browse Source
This commit is contained in:
Christopher Lang
2022-05-20 15:24:36 +01:00
parent 4aef2510e9
commit 1b3e2fdaec
5 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/cglm/call/ivec3.h
View File

@@ -15,7 +15,7 @@ extern "C" {
CGLM_EXPORT
void
glmc_ivec3(ivec4 v, ivec3 dest);
glmc_ivec3(ivec4 v4, ivec3 dest);
CGLM_EXPORT
void

22
include/cglm/ivec2.h
View File

@@ -30,9 +30,9 @@ FUNCTIONS:
#include "common.h"
/*!
* @brief init ivec2 using another vector
* @brief init ivec2 using vec3 or vec4
*
* @param[in] v a vector
* @param[in] v vector
* @param[out] dest destination
*/
CGLM_INLINE
@@ -46,7 +46,7 @@ glm_ivec2(int * __restrict v, ivec2 dest) {
* @brief copy all members of [a] to [dest]
*
* @param[in] a source vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -82,7 +82,7 @@ glm_ivec2_one(ivec2 v) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -96,7 +96,7 @@ glm_ivec2_add(ivec2 a, ivec2 b, ivec2 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -110,7 +110,7 @@ glm_ivec2_adds(ivec2 v, int s, ivec2 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -124,7 +124,7 @@ glm_ivec2_sub(ivec2 a, ivec2 b, ivec2 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -138,7 +138,7 @@ glm_ivec2_subs(ivec2 v, int s, ivec2 dest) {
*
* @param[in] a frist vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -152,7 +152,7 @@ glm_ivec2_mul(ivec2 a, ivec2 b, ivec2 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -194,7 +194,7 @@ glm_ivec2_distance(ivec2 a, ivec2 b) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -208,7 +208,7 @@ glm_ivec2_maxv(ivec2 a, ivec2 b, ivec2 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void

32
include/cglm/ivec3.h
View File

@@ -7,7 +7,7 @@
/*
FUNCTIONS:
CGLM_INLINE void glm_ivec3(ivec4 v, ivec3 dest)
CGLM_INLINE void glm_ivec3(ivec4 v4, ivec3 dest)
CGLM_INLINE void glm_ivec3_copy(ivec3 a, ivec3 dest)
CGLM_INLINE void glm_ivec3_zero(ivec3 v)
CGLM_INLINE void glm_ivec3_one(ivec3 v)
@@ -30,24 +30,24 @@ FUNCTIONS:
#include "common.h"
/*!
* @brief init ivec3 using an ivec4
* @brief init ivec3 using ivec4
*
* @param[in] v a vector
* @param[in] v4 vector4
* @param[out] dest destination
*/
CGLM_INLINE
void
glm_ivec3(ivec4 v, ivec3 dest) {
dest[0] = v[0];
dest[1] = v[1];
dest[2] = v[2];
glm_ivec3(ivec4 v4, ivec3 dest) {
dest[0] = v4[0];
dest[1] = v4[1];
dest[2] = v4[2];
}
/*!
* @brief copy all members of [a] to [dest]
*
* @param[in] a source vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -84,7 +84,7 @@ glm_ivec3_one(ivec3 v) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -99,7 +99,7 @@ glm_ivec3_add(ivec3 a, ivec3 b, ivec3 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -114,7 +114,7 @@ glm_ivec3_adds(ivec3 v, int s, ivec3 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -129,7 +129,7 @@ glm_ivec3_sub(ivec3 a, ivec3 b, ivec3 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -144,7 +144,7 @@ glm_ivec3_subs(ivec3 v, int s, ivec3 dest) {
*
* @param[in] a frist vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -159,7 +159,7 @@ glm_ivec3_mul(ivec3 a, ivec3 b, ivec3 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -203,7 +203,7 @@ glm_ivec3_distance(ivec3 a, ivec3 b) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -218,7 +218,7 @@ glm_ivec3_maxv(ivec3 a, ivec3 b, ivec3 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void

24
include/cglm/ivec4.h
View File

@@ -49,7 +49,7 @@ glm_ivec4(ivec3 v3, int last, ivec4 dest) {
* @brief copy all members of [a] to [dest]
*
* @param[in] a source vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -87,7 +87,7 @@ glm_ivec4_one(ivec4 v) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -103,7 +103,7 @@ glm_ivec4_add(ivec4 a, ivec4 b, ivec4 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -119,7 +119,7 @@ glm_ivec4_adds(ivec4 v, int s, ivec4 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -135,7 +135,7 @@ glm_ivec4_sub(ivec4 a, ivec4 b, ivec4 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -151,7 +151,7 @@ glm_ivec4_subs(ivec4 v, int s, ivec4 dest) {
*
* @param[in] a frist vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -167,7 +167,7 @@ glm_ivec4_mul(ivec4 a, ivec4 b, ivec4 dest) {
*
* @param[in] v vector
* @param[in] s scalar
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -213,7 +213,7 @@ glm_ivec4_distance(ivec4 a, ivec4 b) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -229,7 +229,7 @@ glm_ivec4_maxv(ivec4 a, ivec4 b, ivec4 dest) {
*
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination vector
* @param[out] dest destination
*/
CGLM_INLINE
void
@@ -243,9 +243,9 @@ glm_ivec4_minv(ivec4 a, ivec4 b, ivec4 dest) {
/*!
* @brief clamp each member of [v] between minVal and maxVal (inclusive)
*
* @param[in, out] v vector
* @param[in] minVal minimum value
* @param[in] minVal minimum value
* @param[in, out] v vector
* @param[in] minVal minimum value
* @param[in] minVal minimum value
*/
CGLM_INLINE
void

4
src/ivec3.c
View File

@@ -10,8 +10,8 @@
CGLM_EXPORT
void
glmc_ivec3(ivec4 v, ivec3 dest) {
glm_ivec3(v, dest);
glmc_ivec3(ivec4 v4, ivec3 dest) {
glm_ivec3(v4, dest);
}
CGLM_EXPORT