X-Git-Url: https://plomlompom.com/repos/test.html?a=blobdiff_plain;f=src%2Fyx_uint16.h;h=2a5b3ac4095c0d0ce7beadf8777a88cf5a79da2b;hb=022f78b4ca5a98999f5e482277b0a317af91f404;hp=a8707618cadb8ed1e8309f46ee960d5478962261;hpb=f222ace2f2441b21a3c29741483d8018294820a4;p=plomrogue
diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index a870761..2a5b3ac 100644
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,10 +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
-struct yx_uint16 {
- uint16_t y;
- uint16_t x; };
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
+
+#include /* for uint8_t, 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 uint8_t yx_uint16_cmp(struct yx_uint16 a, struct yx_uint16 b);
+
+/* 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