diff options
author | patacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679> | 2008-12-05 22:57:27 +0000 |
---|---|---|
committer | patacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679> | 2008-12-05 22:57:27 +0000 |
commit | b5d9ad6484e884bf91b923c999d07bac3c7f4d55 (patch) | |
tree | a8f170cf48c7440d583bd60c2fb718a8867ed30d /nuttx/include | |
parent | 975759aa24c5810b2553c3cdabae1609217c2077 (diff) |
Document NX Graphics Subsystem
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@1421 7fd9a85b-ad96-42d3-883c-3090e2eb8679
Diffstat (limited to 'nuttx/include')
-rw-r--r-- | nuttx/include/nuttx/arch.h | 2 | ||||
-rw-r--r-- | nuttx/include/nuttx/nx.h | 18 | ||||
-rw-r--r-- | nuttx/include/nuttx/nxfonts.h | 7 | ||||
-rw-r--r-- | nuttx/include/nuttx/nxglib.h | 8 | ||||
-rw-r--r-- | nuttx/include/nuttx/nxtk.h | 14 |
5 files changed, 25 insertions, 24 deletions
diff --git a/nuttx/include/nuttx/arch.h b/nuttx/include/nuttx/arch.h index b5e33d739d..b4e17f658f 100644 --- a/nuttx/include/nuttx/arch.h +++ b/nuttx/include/nuttx/arch.h @@ -386,7 +386,7 @@ EXTERN boolean up_interrupt_context(void); * * This function implements enabling of the device specified by 'irq' * at the interrupt controller level if supported by the architecture - * (irqsave() supports the global level, the device level is hardware + * (irqrestore() supports the global level, the device level is hardware * specific). * * Since this API is not supported on all architectures, it should be diff --git a/nuttx/include/nuttx/nx.h b/nuttx/include/nuttx/nx.h index 13866f2f55..cb5ac07e32 100644 --- a/nuttx/include/nuttx/nx.h +++ b/nuttx/include/nuttx/nx.h @@ -99,7 +99,7 @@ struct nx_callback_s * Input Parameters: * hwnd - Window handle * rect - The rectangle that needs to be re-drawn (in window relative - * coordinates + * coordinates) * more - TRUE: More re-draw requests will follow * arg - User provided argument (see nx_openwindow, nx_constructwindow) * @@ -122,7 +122,7 @@ struct nx_callback_s * hwnd - Window handle * size - The size of the window * pos - The position of the upper left hand corner of the window on - * the overalll display + * the overall display * bounds - The bounding rectangle that the describes the entire * display * arg - User provided argument (see nx_openwindow, nx_constructwindow) @@ -141,7 +141,7 @@ struct nx_callback_s * Name: mousein * * Descripton: - * New mouse data is available for the window + * New mouse data is available for the window. * * Input Parameters: * hwnd - Window handle @@ -346,7 +346,7 @@ EXTERN void nx_close(NXHANDLE handle); * * Return: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then - * one or more server message was processed. + * one or more server messages were processed. * ERROR: An error occurred and errno has been set appropriately. Of * particular interest, it will return errno == EHOSTDOWN when the * server is disconnected. After that event, the handle can no @@ -376,9 +376,7 @@ EXTERN int nx_eventhandler(NXHANDLE handle); * handle - the handle returned by nx_connect * * Return: - * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then - * one or more server message was processed. - * ERROR: An error occurred and errno has been set appropriately + * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -452,7 +450,7 @@ EXTERN int nx_closewindow(NXWINDOW hwnd); * * nx_setposition, nx_setsize, nx_raise, nx_lower. * - * - Neither nx_opengbwindow or nx_closebgwindow should be called more than + * - Neither nx_requestbkgd or nx_releasebkgd should be called more than * once. Multiple instances of the background window are not supported. * * Input Parameters: @@ -555,7 +553,7 @@ EXTERN int nx_setsize(NXWINDOW hwnd, FAR struct nxgl_size_s *size); EXTERN int nx_raise(NXWINDOW hwnd); /**************************************************************************** - * Name: nx_raise + * Name: nx_lower * * Description: * Lower the specified window to the bottom of the display. @@ -664,7 +662,7 @@ EXTERN int nx_move(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * origin - The origin of the upper, left-most corner of the full bitmap. * Both dest and origin are in window coordinates, however, origin * may lie outside of the display. - * stride - The width of the full source image in pixels. + * stride - The width of the full source image in bytes. * * Return: * OK on success; ERROR on failure with errno set appropriately diff --git a/nuttx/include/nuttx/nxfonts.h b/nuttx/include/nuttx/nxfonts.h index 25e7e0b122..4b9a0e3ed9 100644 --- a/nuttx/include/nuttx/nxfonts.h +++ b/nuttx/include/nuttx/nxfonts.h @@ -64,7 +64,7 @@ struct nx_fontmetic_s uint32 unused : 6; }; -/* This structure bings the glyph metrics to the glyph bitmap */ +/* This structure binds the glyph metrics to the glyph bitmap */ struct nx_fontbitmap_s { @@ -117,7 +117,7 @@ extern "C" { * Return information about the current font set * * Input Parameters: - * None + * An instance of struct nx_font_s describing the font set. * ****************************************************************************/ @@ -132,6 +132,9 @@ EXTERN FAR const struct nx_font_s *nxf_getfontset(void); * Input Parameters: * ch - character code * + * Returned Value: + * An instance of struct nx_fontbitmap_s describing the glyph. + * ****************************************************************************/ EXTERN FAR const struct nx_fontbitmap_s *nxf_getbitmap(uint16 ch); diff --git a/nuttx/include/nuttx/nxglib.h b/nuttx/include/nuttx/nxglib.h index 56739592e4..89585cf509 100644 --- a/nuttx/include/nuttx/nxglib.h +++ b/nuttx/include/nuttx/nxglib.h @@ -101,7 +101,7 @@ struct nxgl_point_s nxgl_coord_t y; /* Y position, range: 0 to screen height - 1 */ }; -/* Describes the size of a rectangulare region */ +/* Describes the size of a rectangular region */ struct nxgl_size_s { @@ -109,7 +109,7 @@ struct nxgl_size_s nxgl_coord_t h; /* Height in rows */ }; -/* Describes a rectangle on the display */ +/* Describes a positioned rectangle on the display */ struct nxgl_rect_s { @@ -329,7 +329,7 @@ EXTERN void nxgl_copyrectangle_32bpp(FAR struct fb_planeinfo_s *pinfo, * * Description: * This is essentially memcpy for rectangles. We don't do structure - * assignements because some compilers are not good at that. + * assignments because some compilers are not good at that. * ****************************************************************************/ @@ -402,7 +402,7 @@ EXTERN void nxgl_rectunion(FAR struct nxgl_rect_s *dest, * * Description: * Return the regions of rectangle rect 1 that do not intersect with - * rect2. This may be up to founr rectangles some of which may be + * rect2. This will be four rectangles ,some of which may be * degenerate (and can be picked off with nxgl_nullrect) * ****************************************************************************/ diff --git a/nuttx/include/nuttx/nxtk.h b/nuttx/include/nuttx/nxtk.h index d9466b9dce..8d2f08c6a5 100644 --- a/nuttx/include/nuttx/nxtk.h +++ b/nuttx/include/nuttx/nxtk.h @@ -225,7 +225,7 @@ EXTERN int nxtk_fillwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * Name: nxtk_filltrapwindow * * Description: - * Fill the specified rectangle in the client window with the specified color + * Fill the specified trapezoid in the client window with the specified color * * Input Parameters: * hfwnd - The window handle returned by nxtk_openwindow @@ -298,8 +298,8 @@ EXTERN int nxtk_bitmapwindow(NXTKWINDOW hfwnd, * Create a tool bar at the top of the specified framed window * * Input Parameters: - * hfwnd - The handle returned by nxtk_openwindow - * height - The request height of the toolbar in pixels + * hfwnd - The handle returned by nxtk_openwindow + * height - The requested height of the toolbar in pixels * cb - Callbacks used to process toolbar events * arg - User provided value that will be returned with toolbar callbacks. * @@ -316,7 +316,7 @@ EXTERN int nxtk_opentoolbar(NXTKWINDOW hfwnd, nxgl_coord_t height, * Name: nxtk_closetoolbar * * Description: - * Create a tool bar at the top of the specified framed window + * Remove the tool bar at the top of the specified framed window * * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow @@ -332,7 +332,7 @@ EXTERN int nxtk_closetoolbar(NXTKWINDOW hfwnd); * Name: nxtk_filltoolbar * * Description: - * Fill the specified rectangle in the client window with the specified color + * Fill the specified rectangle in the toolbar sub-window with the specified color * * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow @@ -351,7 +351,7 @@ EXTERN int nxtk_filltoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect * Name: nxtk_filltraptoolbar * * Description: - * Fill the specified rectangle in the toolbar with the specified color + * Fill the specified trapezoid in the toolbar sub-window with the specified color * * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow @@ -403,7 +403,7 @@ EXTERN int nxtk_movetoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect * origin - The origin of the upper, left-most corner of the full bitmap. * Both dest and origin are in sub-window coordinates, however, the * origin may lie outside of the sub-window display. - * stride - The width of the full source image in pixels. + * stride - The width of the full source image in bytes. * * Return: * OK on success; ERROR on failure with errno set appropriately |