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

docs: add new alignment option to docs

Browse Source
This commit is contained in:
Recep Aslantas
2018-05-09 16:35:15 +03:00
parent f774925e8a
commit 94b286f1f9
5 changed files with 50 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/getting_started.rst
View File

@@ -27,6 +27,13 @@ Alignment is Required:
**vec4** and **mat4** requires 16 byte alignment because vec4 and mat4 operations are
vectorized by SIMD instructions (SSE/AVX).
**UPDATE:**
By starting v0.4.5 cglm provides an option to disable alignment requirement, it is enabled as default
| Check :doc:`opt` page for more details
Also alignment is disabled for older msvc verisons as default. Now alignment only is required in Visual Studio 2017 version 15.6+ if CGLM_ALL_UNALIGNED macro is not defined.
Allocations:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*cglm* doesn't alloc any memory on heap. So it doesn't provide any allocator.