X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Fwindows.h;h=0e3f79bfd63dba060fb15fc3a7b27a9b8aa3c872;hb=f8325a4ea617b15315183d7a8027c0b913c91034;hp=a8783fe2563ea1497afe7994378f723e8f18ac53;hpb=5d9d7aa938af854c1c177e9ca77038d5f7dc2609;p=plomrogue
diff --git a/src/windows.h b/src/windows.h
index a8783fe..0e3f79b 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -22,7 +22,7 @@
*
* Functions that return uint8_t return these error codes:
* 0 - success
- * 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
+ * 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.
@@ -99,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);