aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/graph.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2013-06-08 02:27:59 +1000
committerinmarket <andrewh@inmarket.com.au>2013-06-08 02:27:59 +1000
commit777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f (patch)
tree2827629985d75e63f53b3de689d52a5080404780 /include/gwin/graph.h
parent663caba66214acdb6170903f6a203740ea1de8b9 (diff)
downloaduGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.tar.gz
uGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.tar.bz2
uGFX-777ec6af7c1b594f7b7a9cbaaf7ead90d8fb7e8f.zip
Add a simple GWIN window manager, Change the way GWIN visibility works
Diffstat (limited to 'include/gwin/graph.h')
-rw-r--r--include/gwin/graph.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/gwin/graph.h b/include/gwin/graph.h
index 3c4c42a9..f1ea9450 100644
--- a/include/gwin/graph.h
+++ b/include/gwin/graph.h
@@ -95,8 +95,15 @@ extern "C" {
* @param[in] width The width of the window
* @param[in] height The height of the window
*
- * @note The console is not automatically cleared on creation. You must do that by calling gwinClear() (possibly after changing your background color)
- * @note Don't forget to set the font using @p gwinSetFont() or @p gwinSetDefaultFont()
+ * @note The drawing color and the background color get set to the current defaults. If you haven't called
+ * @p gwinSetDefaultColor() or @p gwinSetDefaultBgColor() then these are White and Black respectively.
+ * @note The font gets set to the current default font. If you haven't called @p gwinSetDefaultFont() then there
+ * is no default font and text drawing operations will no nothing.
+ * @note The dimensions and position may be changed to fit on the real screen.
+ * @note On creation the window is marked as visible but is not automatically cleared. You may do that by calling @p gwinClear()
+ * (possibly after changing your background color)
+ * @note A graph does not save the drawing state. It is not automatically redrawn if the window is moved or
+ * its visibility state is changed.
* @note The coordinate system within the window for graphing operations (but not for any other drawing
* operation) is relative to the bottom left corner and then shifted right and up by the specified
* graphing x and y origin. Note that this system is inverted in the y direction relative to the display.