From a9d56f2daeb9781fe279880997456872cc6697e2 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Fri, 4 May 2018 00:50:56 +0300 Subject: [PATCH] docs: fix typos --- docs/source/getting_started.rst | 6 +++--- docs/source/troubleshooting.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 89c231c..a152371 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -21,17 +21,17 @@ Types: As you can see types don't store extra informations in favor of space. You can send these values e.g. matrix to OpenGL directly without casting or calling a function like *value_ptr* -Aligment is Required: +Alignment is Required: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**vec4** and **mat4** requires 16 byte aligment because vec4 and mat4 operations are +**vec4** and **mat4** requires 16 byte alignment because vec4 and mat4 operations are vectorized by SIMD instructions (SSE/AVX). 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** requires aligment. +When allocating memory don't forget that **vec4** and **mat4** requires 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. diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index d0cc9d5..d599c7d 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -15,10 +15,10 @@ makes calculations then copy the result to dest. You are responsible for allocation of **src** and **dest** parameters. -Aligment: +Alignment: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**vec4** and **mat4** types requires 16 byte aligment aligment. +**vec4** and **mat4** types requires 16 byte alignment. These types are marked with align attribute to let compiler know about this requirement. @@ -26,7 +26,7 @@ But since MSVC (Windows) throws the error: **"formal parameter with requested alignment of 16 won't be aligned"** -The aligment attribute has been commented for MSVC +The alignment attribute has been commented for MSVC .. code-block:: c @@ -36,7 +36,7 @@ The aligment attribute has been commented for MSVC # define CGLM_ALIGN(X) __attribute((aligned(X))) #endif. -So MSVC may not know about aligment requirements when creating variables. +So MSVC may not know about alignment requirements when creating variables. The interesting thing is that, if I remember correctly Visual Studio 2017 doesn't throw the above error. So we may uncomment that line for Visual Studio 2017, you may do it yourself. @@ -61,7 +61,7 @@ Again, you may used wrong function. For instance if you use **glm_normalize()** or **glm_vec_normalize()** for **vec4**, it will assume that passed param is **vec3** and will normalize it for **vec3**. -Since you need to **vec4** to be normalized in your case, you will get wrong results. +Since you need to **vec4** to be normalized in your case, you will get wrong results. Accessing vec4 type with vec3 functions is valid, you will not get any error, exception or crash. You only get wrong results if you don't know what you are doing!