X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Fwindows.h;h=a8783fe2563ea1497afe7994378f723e8f18ac53;hb=385ac8287af0e5e5b5ab0539b47cda9b8dcbec58;hp=6dd7615759454fa3313de50d339c75b7aa5f2475;hpb=a539f3ee61714f59e3164ec0e87c237c965615c3;p=plomrogue
diff --git a/src/windows.h b/src/windows.h
index 6dd7615..a8783fe 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -9,7 +9,8 @@
*
* Windows can be almost any width (number has to fit into 16 bits); the virtual
* screen grows with them as needed -- but only horizontally and only up to 2^16
- * cells. Their height is limited by the height of the terminal screen.
+ * cells. Their height is limited by the height of the terminal screen, which
+ * must also fit into 2^16 cells.
*
* Positioning of windows can only indirectly be influenced: by resizing them,
* and by shifting their relative position inside the (currently invisible)
@@ -22,7 +23,9 @@
* Functions that return uint8_t return these error codes:
* 0 - success
* 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
- * 2 - activity forces virtual screen to grow beyond width of 2^16 cells
+ * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
+ *
+ * TODO: Expose less internals to the API.
*
* TODO: Think up a more intuitive window positioning algorithm or at least make
* the chain that windows are positioned by visible.
@@ -143,7 +146,7 @@ extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
-/* Cycle active window selection forwards (set "dir"="n") or backwards (any
+/* Cycle active window selection forwards ("dir" == "f") or backwards (any
* other "dir"). Wrap around in the windows chain if start / end of it is met.
* Does nothing if no window is active.
*/
@@ -151,9 +154,9 @@ extern void cycle_active_win(struct WinMeta * wmeta, char dir);
-/* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap
- * around in the window chain if start / end of it is met. Does nothing if no
- * window is active.
+/* Move active window forwards ("dir" == "f") or backwards (any other "dir").
+ * Wrap around in the window chain if start / end of it is met. Does nothing if
+ * no window is active.
*/
extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);