X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fyx_uint16.h;h=29298e5ded0f4b97f79f12d2d5e3d04b5b934a37;hb=c7cdbe6260e5cd6a8efe2c73a02c9635b67ec4b7;hp=c697879654be9ad11b3e8f69d6d8b5451123c935;hpb=47d7b87570ce3c79d3e0a6b8e765c74d065b6ba5;p=plomrogue

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index c697879..29298e5 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,18 +1,38 @@
+/* yx_uint16.h
+ *
+ * Structs and routines for coordinates and movement in 2-dimensional space
+ * (such as the ncurses screen and game maps).
+ */
+
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-#include <stdint.h>
 
-#define NORTH 1
-#define EAST 2
-#define SOUTH 3
-#define WEST 4
 
-struct yx_uint16 {
-  uint16_t y;
-  uint16_t x; };
+#include <stdint.h> /* for uint16_t */
+
+
+
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+    uint16_t y;
+    uint16_t x;
+};
+
+/* Directions available for movement. */
+enum dir
+{
+    NORTH = 1,
+    EAST,
+    SOUTH,
+    WEST
+};
+
+/* Return 1 if two yx_uint16 coordinates a and b are equal, else 0. */
+extern char yx_uint16_cmp(struct yx_uint16 a, struct yx_uint16 b);
 
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
-struct yx_uint16 mv_yx_in_dir (char, struct yx_uint16);
+/* Return yx_uint16 coordinate one step from coordinate yx in direction dir. */
+extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
 
 #endif