From aee381d869a3c7343c01736c010fecb841d680e4 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Thu, 29 Nov 2018 09:23:14 +0300 Subject: [PATCH] vec: deprecate `glm_vec_inv` and `glm_vec4_inv` * because in the current implementation, `glm_vec3_negate` does same thing. It is duplicate. --- docs/source/vec3.rst | 38 +++++++++++++++++++++----------------- docs/source/vec4.rst | 40 ++++++++++++++++++++++------------------ include/cglm/call/vec3.h | 18 ++---------------- include/cglm/call/vec4.h | 10 ++-------- include/cglm/vec3.h | 27 ++++----------------------- include/cglm/vec4.h | 36 +++++++++--------------------------- src/vec3.c | 12 ------------ src/vec4.c | 12 ------------ 8 files changed, 60 insertions(+), 133 deletions(-) diff --git a/docs/source/vec3.rst b/docs/source/vec3.rst index e452550..d8f7ced 100644 --- a/docs/source/vec3.rst +++ b/docs/source/vec3.rst @@ -57,10 +57,10 @@ Functions: #. :c:func:`glm_vec3_muladds` #. :c:func:`glm_vec3_flipsign` #. :c:func:`glm_vec3_flipsign_to` -#. :c:func:`glm_vec3_negate` -#. :c:func:`glm_vec3_negate_to` #. :c:func:`glm_vec3_inv` #. :c:func:`glm_vec3_inv_to` +#. :c:func:`glm_vec3_negate` +#. :c:func:`glm_vec3_negate_to` #. :c:func:`glm_vec3_normalize` #. :c:func:`glm_vec3_normalize_to` #. :c:func:`glm_vec3_distance2` @@ -292,6 +292,25 @@ Functions documentation | *[in]* **v** vector | *[out]* **dest** negated vector +.. c:function:: void glm_vec3_inv(vec3 v) + + **DEPRACATED!** + + use :c:func:`glm_vec3_negate` + + Parameters: + | *[in, out]* **v** vector + +.. c:function:: void glm_vec3_inv_to(vec3 v, vec3 dest) + + **DEPRACATED!** + + use :c:func:`glm_vec3_negate_to` + + Parameters: + | *[in]* **v** source + | *[out]* **dest** destination + .. c:function:: void glm_vec3_negate(vec3 v) negate vector components @@ -307,21 +326,6 @@ Functions documentation | *[in]* **v** vector | *[out]* **dest** negated vector -.. c:function:: void glm_vec3_inv(vec3 v) - - make vector as inverse/opposite of itself - - Parameters: - | *[in, out]* **v** vector - -.. c:function:: void glm_vec3_inv_to(vec3 v, vec3 dest) - - inverse/opposite vector - - Parameters: - | *[in]* **v** source - | *[out]* **dest** destination - .. c:function:: void glm_vec3_normalize(vec3 v) normalize vec3 and store result in same vec diff --git a/docs/source/vec4.rst b/docs/source/vec4.rst index cf025e6..99f65cc 100644 --- a/docs/source/vec4.rst +++ b/docs/source/vec4.rst @@ -45,10 +45,10 @@ Functions: #. :c:func:`glm_vec4_muladds` #. :c:func:`glm_vec4_flipsign` #. :c:func:`glm_vec4_flipsign_to` -#. :c:func:`glm_vec4_negate` -#. :c:func:`glm_vec4_negate_to` #. :c:func:`glm_vec4_inv` #. :c:func:`glm_vec4_inv_to` +#. :c:func:`glm_vec4_negate` +#. :c:func:`glm_vec4_negate_to` #. :c:func:`glm_vec4_normalize` #. :c:func:`glm_vec4_normalize_to` #. :c:func:`glm_vec4_distance` @@ -275,12 +275,31 @@ Functions documentation **DEPRACATED!** - use :c:func:`glm_vec4_negate_TO` + use :c:func:`glm_vec4_negate_to` Parameters: | *[in]* **v** vector | *[out]* **dest** negated vector +.. c:function:: void glm_vec4_inv(vec4 v) + + **DEPRACATED!** + + use :c:func:`glm_vec4_negate` + + Parameters: + | *[in, out]* **v** vector + +.. c:function:: void glm_vec4_inv_to(vec4 v, vec4 dest) + + **DEPRACATED!** + + use :c:func:`glm_vec4_negate_to` + + Parameters: + | *[in]* **v** source + | *[out]* **dest** destination + .. c:function:: void glm_vec4_negate(vec4 v) negate vector components @@ -296,21 +315,6 @@ Functions documentation | *[in]* **v** vector | *[out]* **dest** negated vector -.. c:function:: void glm_vec4_inv(vec4 v) - - make vector as inverse/opposite of itself - - Parameters: - | *[in, out]* **v** vector - -.. c:function:: void glm_vec4_inv_to(vec4 v, vec4 dest) - - inverse/opposite vector - - Parameters: - | *[in]* **v** source - | *[out]* **dest** destination - .. c:function:: void glm_vec4_normalize(vec4 v) normalize vec4 and store result in same vec diff --git a/include/cglm/call/vec3.h b/include/cglm/call/vec3.h index 89e2fe2..63d7e38 100644 --- a/include/cglm/call/vec3.h +++ b/include/cglm/call/vec3.h @@ -17,6 +17,8 @@ extern "C" { #define glmc_vec_dup(v, dest) glmc_vec3_copy(v, dest) #define glmc_vec3_flipsign(v) glmc_vec3_negate(v) #define glmc_vec3_flipsign_to(v, dest) glmc_vec3_negate_to(v, dest) +#define glmc_vec3_inv(v) glmc_vec3_negate(v) +#define glmc_vec3_inv_to(v, dest) glmc_vec3_negate_to(v, dest) CGLM_EXPORT void @@ -110,14 +112,6 @@ CGLM_EXPORT void glmc_vec3_muladds(vec3 a, float s, vec3 dest); -CGLM_EXPORT -void -glmc_vec3_flipsign(vec3 v); - -CGLM_EXPORT -void -glmc_vec3_flipsign_to(vec3 v, vec3 dest); - CGLM_EXPORT void glmc_vec3_negate(vec3 v); @@ -126,14 +120,6 @@ CGLM_EXPORT void glmc_vec3_negate_to(vec3 v, vec3 dest); -CGLM_EXPORT -void -glmc_vec3_inv(vec3 v); - -CGLM_EXPORT -void -glmc_vec3_inv_to(vec3 v, vec3 dest); - CGLM_EXPORT float glmc_vec3_angle(vec3 v1, vec3 v2); diff --git a/include/cglm/call/vec4.h b/include/cglm/call/vec4.h index 78c39ae..c71f440 100644 --- a/include/cglm/call/vec4.h +++ b/include/cglm/call/vec4.h @@ -18,6 +18,8 @@ extern "C" { #define glmc_vec4_dup(v, dest) glmc_vec4_copy(v, dest) #define glmc_vec4_flipsign(v) glmc_vec4_negate(v) #define glmc_vec4_flipsign_to(v, dest) glmc_vec4_negate_to(v, dest) +#define glmc_vec4_inv(v) glmc_vec4_negate(v) +#define glmc_vec4_inv_to(v, dest) glmc_vec4_negate_to(v, dest) CGLM_EXPORT void @@ -123,14 +125,6 @@ CGLM_EXPORT void glmc_vec4_negate_to(vec4 v, vec4 dest); -CGLM_EXPORT -void -glmc_vec4_inv(vec4 v); - -CGLM_EXPORT -void -glmc_vec4_inv_to(vec4 v, vec4 dest); - CGLM_EXPORT float glmc_vec4_distance(vec4 v1, vec4 v2); diff --git a/include/cglm/vec3.h b/include/cglm/vec3.h index 9b9efc4..de83ada 100644 --- a/include/cglm/vec3.h +++ b/include/cglm/vec3.h @@ -70,6 +70,8 @@ glm_vec3_dup glm_vec3_flipsign glm_vec3_flipsign_to + glm_vec3_inv + glm_vec3_inv_to */ #ifndef cglm_vec3_h @@ -84,6 +86,8 @@ #define glm_vec3_dup(v, dest) glm_vec3_copy(v, dest) #define glm_vec3_flipsign(v) glm_vec3_negate(v) #define glm_vec3_flipsign_to(v, dest) glm_vec3_negate_to(v, dest) +#define glm_vec3_inv(v) glm_vec3_negate(v) +#define glm_vec3_inv_to(v, dest) glm_vec3_negate_to(v, dest) #define GLM_VEC3_ONE_INIT {1.0f, 1.0f, 1.0f} #define GLM_VEC3_ZERO_INIT {0.0f, 0.0f, 0.0f} @@ -439,29 +443,6 @@ glm_vec3_negate(vec3 v) { glm_vec3_negate_to(v, v); } -/*! - * @brief make vector as inverse/opposite of itself - * - * @param[in, out] v vector - */ -CGLM_INLINE -void -glm_vec3_inv(vec3 v) { - glm_vec3_negate(v); -} - -/*! - * @brief inverse/opposite vector - * - * @param[in] v source - * @param[out] dest destination - */ -CGLM_INLINE -void -glm_vec3_inv_to(vec3 v, vec3 dest) { - glm_vec3_negate_to(v, dest); -} - /*! * @brief normalize vec3 and store result in same vec * diff --git a/include/cglm/vec4.h b/include/cglm/vec4.h index dad9a9e..b170530 100644 --- a/include/cglm/vec4.h +++ b/include/cglm/vec4.h @@ -52,6 +52,8 @@ glm_vec4_dup glm_vec4_flipsign glm_vec4_flipsign_to + glm_vec4_inv + glm_vec4_inv_to */ #ifndef cglm_vec4_h @@ -61,9 +63,13 @@ #include "vec4-ext.h" #include "util.h" -/* DEPRECATED! use _copy, _ucopy versions */ -#define glm_vec4_dup3(v, dest) glm_vec4_copy3(v, dest) -#define glm_vec4_dup(v, dest) glm_vec4_copy(v, dest) +/* DEPRECATED! functions */ +#define glm_vec4_dup3(v, dest) glm_vec4_copy3(v, dest) +#define glm_vec4_dup(v, dest) glm_vec4_copy(v, dest) +#define glm_vec4_flipsign(v) glm_vec4_negate(v) +#define glm_vec4_flipsign_to(v, dest) glm_vec4_negate_to(v, dest) +#define glm_vec4_inv(v) glm_vec4_negate(v) +#define glm_vec4_inv_to(v, dest) glm_vec4_negate_to(v, dest) #define GLM_VEC4_ONE_INIT {1.0f, 1.0f, 1.0f, 1.0f} #define GLM_VEC4_BLACK_INIT {0.0f, 0.0f, 0.0f, 1.0f} @@ -545,30 +551,6 @@ glm_vec4_negate(vec4 v) { glm_vec4_negate_to(v, v); } -/*! - * @brief make vector as inverse/opposite of itself - * - * @param[in, out] v vector - */ -CGLM_INLINE -void -glm_vec4_inv(vec4 v) { - glm_vec4_negate(v); -} - -/*! - * @brief inverse/opposite vector - * - * @param[in] v source - * @param[out] dest destination - */ -CGLM_INLINE -void -glm_vec4_inv_to(vec4 v, vec4 dest) { - glm_vec4_copy(v, dest); - glm_vec4_negate(dest); -} - /*! * @brief normalize vec4 to dest * diff --git a/src/vec3.c b/src/vec3.c index c150b0b..9e26cc4 100644 --- a/src/vec3.c +++ b/src/vec3.c @@ -158,18 +158,6 @@ glmc_vec3_negate_to(vec3 v, vec3 dest) { glm_vec3_negate_to(v, dest); } -CGLM_EXPORT -void -glmc_vec3_inv(vec3 v) { - glm_vec3_inv(v); -} - -CGLM_EXPORT -void -glmc_vec3_inv_to(vec3 v, vec3 dest) { - glm_vec3_inv_to(v, dest); -} - CGLM_EXPORT float glmc_vec3_angle(vec3 v1, vec3 v2) { diff --git a/src/vec4.c b/src/vec4.c index 379d527..a559b12 100644 --- a/src/vec4.c +++ b/src/vec4.c @@ -164,18 +164,6 @@ glmc_vec4_negate_to(vec4 v, vec4 dest) { glm_vec4_negate_to(v, dest); } -CGLM_EXPORT -void -glmc_vec4_inv(vec4 v) { - glm_vec4_inv(v); -} - -CGLM_EXPORT -void -glmc_vec4_inv_to(vec4 v, vec4 dest) { - glm_vec4_inv_to(v, dest); -} - CGLM_EXPORT float glmc_vec4_distance(vec4 v1, vec4 v2) {