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

docs: Use .. note:: to display better.

Browse Source 
Also, make sure the note content has a blank line after it to
remove a warning from Sphinx.
This commit is contained in:
Bruce Mitchener
2024-02-11 23:39:03 +07:00
parent 270d2b9d05
commit af5048595f
17 changed files with 35 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/getting_started.rst
View File

@@ -42,9 +42,9 @@ Allocations:
*cglm* doesn't alloc any memory on heap. So it doesn't provide any allocator.
You must allocate memory yourself. You should alloc memory for out parameters too if you pass pointer of memory location. When allocating memory, don't forget that **vec4** and **mat4** require alignment.
**NOTE:** Unaligned **vec4** and unaligned **mat4** operations will be supported in the future. Check todo list.
Because you may want to multiply a CGLM matrix with external matrix.
There is no guarantee that non-CGLM matrix is aligned. Unaligned types will have *u* prefix e.g. **umat4**
.. note:: Unaligned **vec4** and unaligned **mat4** operations will be supported in the future. Check todo list.
Because you may want to multiply a CGLM matrix with external matrix.
There is no guarantee that non-CGLM matrix is aligned. Unaligned types will have *u* prefix e.g. **umat4**
Array vs Struct:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~