diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-05-22 11:38:13 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-05-23 15:37:37 +0300 |
commit | bc830763557aa126364411dcc81b8535fdfa8694 (patch) | |
tree | 5e558d80c5394c4146ca7317869ddcd711b8a46d /source/blender/blenlib/BLI_math.h | |
parent | 25f5d2b4d7e83f52807be13d255cfde2ea51d8ee (diff) |
Math Lib: update API usage info
Diffstat (limited to 'source/blender/blenlib/BLI_math.h')
-rw-r--r-- | source/blender/blenlib/BLI_math.h | 37 |
1 files changed, 24 insertions, 13 deletions
diff --git a/source/blender/blenlib/BLI_math.h b/source/blender/blenlib/BLI_math.h index db2fed433da..62ed8045109 100644 --- a/source/blender/blenlib/BLI_math.h +++ b/source/blender/blenlib/BLI_math.h @@ -30,18 +30,30 @@ * \ingroup bli * \section mathabbrev Abbreviations * - * - fl = float - * - db = double - * - v2 = vec2 = vector 2 - * - v3 = vec3 = vector 3 - * - v4 = vec4 = vector 4 - * - qt = quat = quaternion - * - dq = dquat = dual quaternion - * - m2 = mat2 = matrix 2x2 - * - m3 = mat3 = matrix 3x3 - * - m4 = mat4 = matrix 4x4 - * - eul = euler rotation - * - eulO = euler with order + * - ``fl`` = float + * - ``db`` = double + * - ``v2`` = vec2 = vector 2 + * - ``v3`` = vec3 = vector 3 + * - ``v4`` = vec4 = vector 4 + * - ``vn`` = vec4 = vector N dimensions, *passed as an arg, after the vector*. + * - ``qt`` = quat = quaternion + * - ``dq`` = dquat = dual quaternion + * - ``m2`` = mat2 = matrix 2x2 + * - ``m3`` = mat3 = matrix 3x3 + * - ``m4`` = mat4 = matrix 4x4 + * - ``eul`` = euler rotation + * - ``eulO`` = euler with order + * + * \subsection mathabbrev_all Function Type Abbreviations + * + * For non float versions of functions (which typically operate on floats), + * use single suffix abbreviations. + * + * - ``_d`` = double + * - ``_i`` = int + * - ``_u`` = unsigned int + * - ``_char`` = char + * - ``_uchar`` = unsigned char * * \section mathvarnames Variable Names * @@ -61,4 +73,3 @@ #include "BLI_math_interp.h" #endif /* __BLI_MATH_H__ */ - |