remve deprecated functions, add MAKESPRITE

Author: braindigitalis

docpages/basic-language-reference/functions/integer/02_INDEX.md

@@ -44,9 +44,8 @@ The following functions operate on or return **integer values** in Retro Rocket
 * \subpage INSTR
 * \subpage INT
 * \subpage ISPROGRAM
-* \subpage LCPUID
 * \subpage LEN
-* \subpage LGETLASTCPUID
+* \subpage MAKESPRITE
 * \subpage MAP
 * \subpage MAPGET
 * \subpage MAPHAS

docpages/basic-language-reference/functions/integer/LCPUID.md

@@ -0,0 +1,31 @@
+\page MAKESPRITE MAKESPRITE Function
+
+```basic
+handle = MAKESPRITE(buffer, length)
+```
+
+Allocate and initialise a new sprite from image data loaded into a memory buffer
+
+---
+
+### Examples
+
+```basic
+sm = MEMALLOC(4096)
+f = OPENIN("/images/owl.png")
+BINREAD f, sm, 4096
+spr = MAKESPRITE(sm, 4096)
+MEMRELEASE sm
+PLOT spr, 600, 400
+```
+
+---
+
+### Notes
+
+* An error will be raised if the memory does not contain valid image data, or is unable to be read
+
+---
+
+**See also:**
+\ref SPRITELOAD "SPRITELOAD" · \ref PLOT "PLOT" · \ref PLOTQUAD "PLOTQUAD" · \ref MEMALLOC "MEMALLOC"

docpages/basic-language-reference/functions/integer/LGETLASTCPUID.md

@@ -51,4 +51,4 @@ ENDIF
 ---
 
 **See also:**
-\ref MEMUSED "MEMUSED" · \ref MEMORY "MEMORY" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"
+\ref MEMUSED "MEMUSED" · \ref MEMORY "MEMTOTAL" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"

docpages/basic-language-reference/functions/integer/MAKESPRITE.md

@@ -1,7 +1,7 @@
-\page MEMORY MEMORY Function
+\page MEMORY MEMTOTAL Function
 
 ```basic
-MEMORY
+MEMTOTAL
 ```
 
 Returns the total **system memory** in bytes, including both **used** and **free** portions, for BASIC programs and the operating system.
@@ -12,7 +12,7 @@ Returns the total **system memory** in bytes, including both **used** and **free
 
 ```basic
 REM Print total system memory
-PRINT MEMORY
+PRINT MEMTOTAL
 ```
 
 On a 4 GB machine this will typically print:
@@ -23,7 +23,7 @@ On a 4 GB machine this will typically print:
 
 ```basic
 REM Derive free percentage
-PRINT "Free % = "; (MEMFREE * 100) / MEMORY
+PRINT "Free % = "; (MEMFREE * 100) / MEMTOTAL
 ```
 
 If `MEMFREE` reports `3758096384` on a 4 GB machine, this prints:
@@ -43,9 +43,5 @@ Free % = 87
 
 ---
 
-\image html memory.png
-
----
-
 **See also:**
 \ref MEMFREE "MEMFREE" · \ref MEMUSED "MEMUSED" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"

docpages/basic-language-reference/functions/integer/MEMFREE.md

@@ -51,4 +51,4 @@ PRINT "Peak usage     = "; MEMPEAK; " bytes"
 ---
 
 **See also:**
-\ref MEMUSED "MEMUSED" · \ref MEMFREE "MEMFREE" · \ref MEMORY "MEMORY" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"
+\ref MEMUSED "MEMUSED" · \ref MEMFREE "MEMFREE" · \ref MEMORY "MEMTOTAL" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"

docpages/basic-language-reference/functions/integer/MEMORY.md

@@ -51,4 +51,4 @@ Program heap = 392 KB
 ---
 
 **See also:**
-\ref MEMPEAK "MEMPEAK" · \ref MEMUSED "MEMUSED" · \ref MEMFREE "MEMFREE" · \ref MEMORY "MEMORY" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"
+\ref MEMPEAK "MEMPEAK" · \ref MEMUSED "MEMUSED" · \ref MEMFREE "MEMFREE" · \ref MEMORY "MEMTOTAL" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"

docpages/basic-language-reference/functions/integer/MEMPEAK.md

@@ -6,14 +6,12 @@ MEMUSED
 
 Returns the total **memory in use** (bytes) by **all BASIC programs and the OS**.
 
-\image html memory.png
-
 ### Examples
 
 ```basic
 PRINT MEMUSED
 PRINT "Used  = "; MEMUSED / (1024 * 1024); " MB"
-PRINT "Free  = "; (MEMORY - MEMUSED) / (1024 * 1024); " MB"
+PRINT "Free  = "; (MEMTOTAL - MEMUSED) / (1024 * 1024); " MB"
 PRINT "Used % = "; (MEMUSED * 100) / MEMORY
 ```
 
@@ -32,4 +30,4 @@ Used % = 4
 * Identity: `MEMFREE + MEMUSED = MEMORY`.
 
 **See also:**
-\ref MEMORY "MEMORY" · \ref MEMFREE "MEMFREE" · \ref MEMPEAK "MEMPEAK" · \ref MEMPROGRAM "MEMPROGRAM" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"
+\ref MEMORY "MEMTOTAL" · \ref MEMFREE "MEMFREE" · \ref MEMPEAK "MEMPEAK" · \ref MEMPROGRAM "MEMPROGRAM" · \ref MEMORY "MEMRELEASE" · \ref MEMORY "MEMALLOC"

docpages/basic-language-reference/functions/integer/MEMPROGRAM.md

@@ -126,7 +126,7 @@
 <div class="textblock"><div class="fragment"><div class="line">ACS(real-expression)</div>
 </div><!-- fragment --><p>Returns the <b>arc cosine</b> (inverse cosine) of the given expression, in <b>radians</b>. The input must be between <span class="tt">-1</span> and <span class="tt">1</span>.</p>
 <hr  />
-<h3 class="doxsection"><a class="anchor" id="examples-91"></a>
+<h3 class="doxsection"><a class="anchor" id="examples-90"></a>
 Examples</h3>
 <div class="fragment"><div class="line">PRINT ACS(1)</div>
 </div><!-- fragment --><p>Produces <span class="tt">0</span>.</p>
@@ -139,7 +139,7 @@ <h3 class="doxsection"><a class="anchor" id="examples-91"></a>
 <div class="line">PRINT ACS(COS(angle#))</div>
 </div><!-- fragment --><p>Produces the original angle (within floating point accuracy).</p>
 <hr  />
-<h3 class="doxsection"><a class="anchor" id="notes-87"></a>
+<h3 class="doxsection"><a class="anchor" id="notes-86"></a>
 Notes</h3>
 <ul>
 <li>Argument range: <span class="tt">-1 ≤ x ≤ 1</span>. Values outside this range cause an error.</li>