simplewidget_8h.tex

来自「在DM6446上实现了编码和解码功能」· TEX 代码 · 共 493 行 · 第 1/3 页

\index{simplewidget_jpeg@{simplewidget\_\-jpeg}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-jpeg]{\setlength{\rightskip}{0pt plus 5cm}typedef void$\ast$ \hyperlink{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{simplewidget\_\-jpeg}}\hfill}
\label{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}


Opaque handle to a jpeg image. 



Definition at line 29 of file simplewidget.h.\hypertarget{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_png@{simplewidget\_\-png}}
\index{simplewidget_png@{simplewidget\_\-png}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-png]{\setlength{\rightskip}{0pt plus 5cm}typedef void$\ast$ \hyperlink{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{simplewidget\_\-png}}\hfill}
\label{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}


Opaque handle to a png image. 



Definition at line 30 of file simplewidget.h.

\subsubsection{Function Documentation}
\hypertarget{simplewidget_8h_2c0b824e3e874d611c4224e3e2378d78}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_screen_init@{simplewidget\_\-screen\_\-init}}
\index{simplewidget_screen_init@{simplewidget\_\-screen\_\-init}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-screen\_\-init]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-screen\_\-init (void $\ast$ {\em fbp}, int {\em fbw}, int {\em fbh}, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} $\ast$ {\em swsp})}\hfill}
\label{simplewidget_8h_2c0b824e3e874d611c4224e3e2378d78}


Initializes a simplewidget screen. Must be called before any other simplewidget API call on this screen. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fbp}]The pointer to the framebuffer. \item[{\em fbw}]The width of the framebuffer. \item[{\em fbh}]The height of the framebuffer. \item[{\em swsp}]Screen pointer returned. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_524ab9a9b8628c8be8185ba343167817}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_screen_clear@{simplewidget\_\-screen\_\-clear}}
\index{simplewidget_screen_clear@{simplewidget\_\-screen\_\-clear}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-screen\_\-clear]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-screen\_\-clear (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws}, int {\em x}, int {\em y}, int {\em w}, int {\em h})}\hfill}
\label{simplewidget_8h_524ab9a9b8628c8be8185ba343167817}


Clear an area of the screen. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sws}]Simplewidget screen to clear on. \item[{\em x}]X coordinate of area to clear. \item[{\em y}]Y coordinate of area to clear. \item[{\em w}]Width of area to clear. \item[{\em h}]Height of area to clear. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_2a0d68c33d56c99328fed33f46044c41}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_screen_draw_rectangle@{simplewidget\_\-screen\_\-draw\_\-rectangle}}
\index{simplewidget_screen_draw_rectangle@{simplewidget\_\-screen\_\-draw\_\-rectangle}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-screen\_\-draw\_\-rectangle]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-screen\_\-draw\_\-rectangle (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws}, int {\em x}, int {\em y}, int {\em w}, int {\em h}, int {\em r}, int {\em g}, int {\em b})}\hfill}
\label{simplewidget_8h_2a0d68c33d56c99328fed33f46044c41}


Draw a rectangle on the screen. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sws}]Simplewidget screen to draw rectangle on. \item[{\em x}]X coordinate of the rectangle. \item[{\em y}]Y coordinate of the rectangle. \item[{\em w}]Width of the rectangle. \item[{\em h}]Height of the rectangle. \item[{\em r}]Red component of rectangle color. \item[{\em g}]Green component of rectangle color. \item[{\em b}]Blue component of rectangle color. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_8e0f7e4528439c322dabbe18c83289de}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_screen_exit@{simplewidget\_\-screen\_\-exit}}
\index{simplewidget_screen_exit@{simplewidget\_\-screen\_\-exit}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-screen\_\-exit]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-screen\_\-exit (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws})}\hfill}
\label{simplewidget_8h_8e0f7e4528439c322dabbe18c83289de}


Deinitalize the simplewidget screen and free up associated resources. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sws}]Simplewidget screen to deinitalize. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_6c2692d11989d5afdda34f7207598072}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button_create@{simplewidget\_\-button\_\-create}}
\index{simplewidget_button_create@{simplewidget\_\-button\_\-create}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button\_\-create]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-button\_\-create (int {\em x}, int {\em y}, int {\em w}, int {\em h}, int {\em r}, int {\em g}, int {\em b}, int {\em font\_\-height}, int {\em border}, char $\ast$ {\em txt}, \hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} $\ast$ {\em swbp})}\hfill}
\label{simplewidget_8h_6c2692d11989d5afdda34f7207598072}


Creates a button, but does not show it on screen. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em x}]X position of the button on screen. \item[{\em y}]Y position of the button on screen. \item[{\em w}]Width of button. \item[{\em h}]Height of button. \item[{\em r}]Red component of button color. \item[{\em g}]Green component of button color. \item[{\em b}]Blue component of button color. \item[{\em font\_\-height}]Height of the button font. \item[{\em border}]Size of button border. \item[{\em txt}]Text to render inside button. \item[{\em swbp}]Simplewidget handle returned. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_0e7b697a549847ffba7f465f33d81eb4}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button_show@{simplewidget\_\-button\_\-show}}
\index{simplewidget_button_show@{simplewidget\_\-button\_\-show}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button\_\-show]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-button\_\-show (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} {\em swb}, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws})}\hfill}
\label{simplewidget_8h_0e7b697a549847ffba7f465f33d81eb4}


Show the button on the screen. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em swb}]Simplewidget handle of the button to show. \item[{\em sws}]Simplewidget screen to show button on. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_5d27ef6084197b30604d2662ea2d0d03}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button_hide@{simplewidget\_\-button\_\-hide}}
\index{simplewidget_button_hide@{simplewidget\_\-button\_\-hide}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button\_\-hide]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-button\_\-hide (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} {\em swb}, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws})}\hfill}
\label{simplewidget_8h_5d27ef6084197b30604d2662ea2d0d03}


Hide a button (un-show it). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em swb}]Simplewidget handle of the button to hide. \item[{\em sws}]Simplewidget screen to hide button on. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_973c4af3e7b42156eca1431c193f9c9d}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button_press@{simplewidget\_\-button\_\-press}}
\index{simplewidget_button_press@{simplewidget\_\-button\_\-press}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button\_\-press]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-button\_\-press (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} {\em swb}, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws})}\hfill}
\label{simplewidget_8h_973c4af3e7b42156eca1431c193f9c9d}


Press the button. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em swb}]Simplewidget handle of the button to press. \item[{\em sws}]Simplewidget screen to fade in button on. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SIMPLEWIDGET\_\-SUCCESS on success and SIMPLEWIDGET\_\-FAILURE on failure. \end{Desc}
\hypertarget{simplewidget_8h_d2a83689410608630d71525552953a0d}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button_release@{simplewidget\_\-button\_\-release}}
\index{simplewidget_button_release@{simplewidget\_\-button\_\-release}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button\_\-release]{\setlength{\rightskip}{0pt plus 5cm}int simplewidget\_\-button\_\-release (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} {\em swb}, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} {\em sws})}\hfill}
\label{simplewidget_8h_d2a83689410608630d71525552953a0d}


Release the button from being pressed. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em swb}]Simplewidget handle of the button to release from being pressed. \item[{\em sws}]Simplewidget screen to fade in button on. \end{description}
\end{Desc}