X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;ds=sidebyside;f=src%2Fwindows.h;h=0e3f79bfd63dba060fb15fc3a7b27a9b8aa3c872;hb=c0a785104a8081e7911647345285da9e9ed22907;hp=2828e0739421a038aad28885fc3215067a1cf88e;hpb=6e5be9a78c42a8ddfbdfba29c4df306a73bffe3c;p=plomrogue

diff --git a/src/windows.h b/src/windows.h
index 2828e07..0e3f79b 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)
@@ -21,8 +22,8 @@
  *
  * 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
+ * 1 - memory allocation error
+ * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
  *
  * TODO: Expose less internals to the API.
  *
@@ -98,21 +99,23 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
 
 
 
-/* Create a window as child of "wmeta" titled "title" of "height" and "width"
- * and appointing "func"() to interpret and draw the content stored at "data"
- * if the window is visible.
+/* Initialize a window child of "wmeta" to "title", "height" and "width" and
+ * appointing "func"() to interpret and draw the content stored at "data" when
+ * the window is visible.
  *
- * A value for "width" <1 will trigger a fallback to width=1. A "height" < 1 or
- * larger than the maximum window height possible within the virtual screen will
- * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0
- * to initialize the window to its largest possible height).
+ * Pass 0 for "width" to make the window as wide as the terminal screen. Pass
+ * negative values for "width" to make the size so many cells smaller than the
+ * terminal screen. Pass 0 for "height" to give the window the maximum allowed
+ * height: one cell smaller than the terminal screen. Pass negative values to
+ * make the window so many smalls smaller than the terminal screen. The maximum
+ * allowed height is also applied for positive values that exceed it or negative
+ * values that would reduce the window height < 1 cell.
  *
- * Other members of the Win struct are initialized to 0. The window will stay
- * invisible until appended to the chain of visible windows via append_win().
+ * Other members of the Win struct are initialized to 0.
  */
-extern struct Win init_win(struct WinMeta * wmeta, char * title,
-                           uint16_t height, uint16_t width,
-                           void * data, void * func);
+extern uint8_t init_win(struct WinMeta * wmeta, struct Win * w, char * title,
+                        int16_t height, int16_t width,
+                        void * data, void * func);