X-Git-Url: https://plomlompom.com/repos/feed.xml?a=blobdiff_plain;ds=sidebyside;f=src%2Fyx_uint16.h;h=f6f90a372dca46c8af4b63a17dcd1e4e3f37bcb6;hb=67bcb0339e09a67fe1685cf81e35ccac18eba0c5;hp=c697879654be9ad11b3e8f69d6d8b5451123c935;hpb=47d7b87570ce3c79d3e0a6b8e765c74d065b6ba5;p=plomrogue

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index c697879..f6f90a3 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,18 +1,34 @@
+/* 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>
+#include <stdint.h> /* for uint8_t, uint16_t */
+
+
+
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+    uint16_t y;
+    uint16_t x;
+};
+
+
+
+/* Return 1 if two yx_uint16 coordinates at "a" and "b" are equal, else 0. */
+extern uint8_t yx_uint16_cmp(struct yx_uint16 * a, struct yx_uint16 * b);
 
-#define NORTH 1
-#define EAST 2
-#define SOUTH 3
-#define WEST 4
+/* Return yx_uint16 coordinate one step from "yx" in direction "dir" (east: 'E',
+ * west: 'W', north: 'N', south: 'S'). If "dir" is invalid or would wrap the
+ * move around the edge of a 2^16x2^16 cells field, "yx" remains unchanged.
+ */
+extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);
 
-struct yx_uint16 {
-  uint16_t y;
-  uint16_t x; };
 
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
-struct yx_uint16 mv_yx_in_dir (char, struct yx_uint16);
 
 #endif