diff --git a/include/cglm/util.h b/include/cglm/util.h index 6b97648..540d060 100644 --- a/include/cglm/util.h +++ b/include/cglm/util.h @@ -31,36 +31,68 @@ glm_sign(int val) { return ((val >> 31) - (-val >> 31)); } +/*! + * @brief convert degree to radians + * + * @param[in] deg angle in degrees + */ CGLM_INLINE float glm_rad(float deg) { return deg * CGLM_PI / 180.0f; } +/*! + * @brief convert radians to degree + * + * @param[in] deg angle in radians + */ CGLM_INLINE float glm_deg(float rad) { return rad * 180.0f / CGLM_PI; } +/*! + * @brief convert exsisting degree to radians. this will override degrees value + * + * @param[in, out] deg pointer to angle in degrees + */ CGLM_INLINE void glm_make_rad(float *deg) { *deg = *deg * CGLM_PI / 180.0f; } +/*! + * @brief convert exsisting radians to degree. this will override radians value + * + * @param[in, out] rad pointer to angle in radians + */ CGLM_INLINE void glm_make_deg(float *rad) { *rad = *rad * 180.0f / CGLM_PI; } +/*! + * @brief multiplies given parameter with itself = x * x or powf(x, 2) + * + * @param[in] x x + */ CGLM_INLINE float glm_pow2(float x) { + return x * x; } +/*! + * @brief find minimum of given two values + * + * @param[in] a number 1 + * @param[in] b number 2 + */ CGLM_INLINE float glm_min(float a, float b) { @@ -69,6 +101,12 @@ glm_min(float a, float b) { return b; } +/*! + * @brief find maximum of given two values + * + * @param[in] a number 1 + * @param[in] b number 2 + */ CGLM_INLINE float glm_max(float a, float b) {