summaryrefslogtreecommitdiff
path: root/libs/cglm/docs/source/call.rst
diff options
context:
space:
mode:
Diffstat (limited to 'libs/cglm/docs/source/call.rst')
-rw-r--r--libs/cglm/docs/source/call.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/libs/cglm/docs/source/call.rst b/libs/cglm/docs/source/call.rst
new file mode 100644
index 0000000..f7765a7
--- /dev/null
+++ b/libs/cglm/docs/source/call.rst
@@ -0,0 +1,19 @@
+.. default-domain:: C
+
+precompiled functions (call)
+================================================================================
+
+All funcitons in **glm_** namespace are forced to **inline**.
+Most functions also have pre-compiled version.
+
+Precompiled versions are in **glmc_** namespace. *c* in the namespace stands for
+"call".
+
+Since precompiled functions are just wrapper for inline verisons,
+these functions are not documented individually.
+It would be duplicate documentation also it
+would be hard to sync documentation between inline and call verison for me.
+
+By including **clgm/cglm.h** you include all inline verisons. To get precompiled
+versions you need to include **cglm/call.h** header it also includes all
+call versions plus *clgm/cglm.h* (inline verisons)