home
·
contact
·
privacy
projects
/
plomrogue
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
More code re-styling and documentation.
[plomrogue]
/
src
/
yx_uint16.h
diff --git
a/src/yx_uint16.h
b/src/yx_uint16.h
index c697879654be9ad11b3e8f69d6d8b5451123c935..eb951a7fd895d959046d3e5078a1ddaed71e74ac 100644
(file)
--- a/
src/yx_uint16.h
+++ b/
src/yx_uint16.h
@@
-1,18
+1,35
@@
+/* 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>
#ifndef YX_UINT16_H
#define YX_UINT16_H
#include <stdint.h>
-#define NORTH 1
-#define EAST 2
-#define SOUTH 3
-#define WEST 4
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+ uint16_t y;
+ uint16_t x;
+};
+
+/* This encodes directions. */
+
+enum dir
+{
+ NORTH = 1,
+ EAST = 2,
+ SOUTH = 3,
+ WEST = 4
+};
-struct yx_uint16 {
- uint16_t y;
- uint16_t x; };
+/* 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
#endif