From 3467a3356ad179a82a52d11c0662bc67ee6f8923 Mon Sep 17 00:00:00 2001
From: retropikzel <retropikzel@iki.fi>
Date: Mon, 7 Apr 2025 07:18:13 +0300
Subject: [PATCH] Add documentation about array utilities

---
 README.md            | 27 +++++++++++++++++++++++++++
 retropikzel/pffi.sld |  2 +-
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6acec63..bee4816 100644
--- a/README.md
+++ b/README.md
@@ -149,6 +149,13 @@ and work, they should work too.
 - pffi-struct-offset-get
 - pffi-struct-get
 - pffi-struct-set!
+- pffi-array-allocate
+- pffi-array?
+- pffi-pointer-\>array
+- pffi-array-get
+- pffi-array-set!
+- pffi-list-\>array
+- pffi-array-\>list
 
 ###  Not started
 <a name="not-started"></a>
@@ -454,6 +461,26 @@ Returns the value of the givens struct member.
 Sets the value of the givens struct member. It is up to you to make sure that the type of value is
 correct.
 
+**pffi-array-allocate** type size
+
+Allocates pointer array of given type and size.
+
+**pffi-array?** object
+
+Returns #t of given object is array, #f otherwise.
+
+**pffi-pointer->array** pointer type size
+
+Converts given pointer to an array of giben type and size.
+
+**pffi-array-get** array index
+
+Returns the value of given index from given array.
+
+**pffi-array-set!** array index value
+
+Sets the given value of given index in given array.
+
 **pffi-list->array** type list
 
 Converts given list into C array of given type.
diff --git a/retropikzel/pffi.sld b/retropikzel/pffi.sld
index 794e89b..eae7be1 100644
--- a/retropikzel/pffi.sld
+++ b/retropikzel/pffi.sld
@@ -166,8 +166,8 @@
               pffi-struct-get
               pffi-struct-set!
               pffi-struct-dereference
-              pffi-array?
               pffi-array-allocate
+              pffi-array?
               pffi-pointer->array
               pffi-array-get
               pffi-array-set!