Browse Source

Fix bold syntax;

bjorn 6 years ago
parent
commit
25d78118e0
5 changed files with 196 additions and 1362 deletions
  1. 185 1351
      api/init.lua
  2. 3 3
      api/lovr/math/Pool/init.lua
  3. 2 2
      api/lovr/math/mat4/init.lua
  4. 3 3
      api/lovr/math/quat/init.lua
  5. 3 3
      api/lovr/math/vec3/init.lua

File diff suppressed because it is too large
+ 185 - 1351
api/init.lua


+ 3 - 3
api/lovr/math/Pool/init.lua

@@ -20,9 +20,9 @@ return {
     `vec3:save` on it, which creates a copy of the vector that exists outside of any Pool and is
     instead managed by Lua's garbage collector.
 
-    *Important note:* `lovr.math` has its own internal Pool that it uses whenever you call functions
-    like `lovr.math.vec3` or `lovr.math.mat4`.  These vectors are temporary vectors that will be
-    drained at the end of the frame!  The default Pool is resizable.
+    **Important note:** `lovr.math` has its own internal Pool that it uses whenever you call
+    functions like `lovr.math.vec3` or `lovr.math.mat4`.  These vectors are temporary vectors that
+    will be drained at the end of the frame!  The default Pool is resizable.
   ]],
   constructor = 'lovr.math.newPool'
 }

+ 2 - 2
api/lovr/math/mat4/init.lua

@@ -7,8 +7,8 @@ return {
     is more concise and improves performance slightly.
 
     `mat4`s are created by allocating them from Pools, by either using `lovr.math.mat4` to allocate
-    from the default pool or creating a new `Pool` and calling `Pool:mat4` on it.  *Note* that
-    matrices created with `lovr.math.mat4` are *temporary*, and will be cleared at the end of a
+    from the default pool or creating a new `Pool` and calling `Pool:mat4` on it.  **Note** that
+    matrices created with `lovr.math.mat4` are **temporary**, and will be cleared at the end of a
     frame!  You can use `mat4:save` to save a permanent copy of the matrix that is managed by the
     Lua garbage collector.
 

+ 3 - 3
api/lovr/math/quat/init.lua

@@ -5,8 +5,8 @@ return {
     that take rotations also accept quaternions.
 
     `quat`s are created by allocating them from Pools, by either using `lovr.math.quat` to allocate
-    from the default pool or creating a new `Pool` and calling `Pool:quat` on it.  *Note* that
-    quaternions created with `lovr.math.quat` are *temporary*, and will be cleared at the end of a
+    from the default pool or creating a new `Pool` and calling `Pool:quat` on it.  **Note** that
+    quaternions created with `lovr.math.quat` are **temporary**, and will be cleared at the end of a
     frame!  You can use `quat:save` to save a permanent copy of the quaternion that is managed by
     the Lua garbage collector.
 
@@ -21,7 +21,7 @@ return {
     Two quaternions can be multiplied together to combine their rotations into a single new
     quaternion.  The `quat:mul` function can be used to multiply two quaternions "in place",
     modifying the first quaternion.  Alternatively, the `*` operator can be used to multiply them,
-    which will create a new *temporary* quaternion to store the result in.
+    which will create a new **temporary** quaternion to store the result in.
 
     A quaternion can also be multiplied by a vector.  This rotates the vector.  Both `quat:mul` and
     the `*` operator can be used for this.

+ 3 - 3
api/lovr/math/vec3/init.lua

@@ -6,13 +6,13 @@ return {
     or velocities generally also accept `vec3`s.
 
     `vec3`s are created by allocating them from Pools, by either using `lovr.math.vec3` to allocate
-    from the default pool or creating a new `Pool` and calling `Pool:vec3` on it.  *Note* that
-    vectors created with `lovr.math.vec3` are *temporary*, and will be cleared at the end of a
+    from the default pool or creating a new `Pool` and calling `Pool:vec3` on it.  **Note** that
+    vectors created with `lovr.math.vec3` are **temporary**, and will be cleared at the end of a
     frame!  You can use `vec3:save` to save a permanent copy of the vector that is managed by the
     Lua garbage collector.
 
     `vec3`s have metamethods, allowing you to add, subtract, multiply, and divide them using the
-    usual binary operators that you would use on numbers.  Note that these create new *temporary*
+    usual binary operators that you would use on numbers.  Note that these create new **temporary**
     vectors to store their results in.  If you want to modify a vector instead of creating new ones,
     you can use the named operator functions like `vec3:add`.
 

Some files were not shown because too many files changed in this diff