simplewidget_8h.tex

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

\hypertarget{simplewidget_8h}{
\subsection{simplewidget.h File Reference}
\label{simplewidget_8h}\index{simplewidget.h@{simplewidget.h}}
}


\subsubsection{Detailed Description}
\begin{Desc}
\item[Version:]00.10 \end{Desc}


Put the file comments here.



\footnotesize\begin{verbatim}
 * ============================================================================
 * Copyright (c) Texas Instruments Inc 2007
 *
 * Use of this software is controlled by the terms and conditions found in the
 * license agreement under which this software has been supplied or provided.
 * ============================================================================
 * \end{verbatim}
\normalsize
 

Definition in file \hyperlink{simplewidget_8h-source}{simplewidget.h}.

\subsubsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{simplewidget_8h_e138b2e443649ca9546c99e80957faac}{BYTES\_\-PER\_\-PIXEL}~2
\begin{CompactList}\small\item\em Only 16 bit color supported. \item\end{CompactList}\item 
\#define \hyperlink{simplewidget_8h_f8aafa52e2ed8e01099c7ee8f1cf73da}{SIMPLEWIDGET\_\-SUCCESS}~0
\begin{CompactList}\small\item\em Success return code. \item\end{CompactList}\item 
\#define \hyperlink{simplewidget_8h_948489ec9bcb24150aeb354ac8155220}{SIMPLEWIDGET\_\-FAILURE}~-1
\begin{CompactList}\small\item\em Failure return code. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef void $\ast$ \hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button}
\begin{CompactList}\small\item\em Opaque handle to a button. \item\end{CompactList}\item 
typedef void $\ast$ \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen}
\begin{CompactList}\small\item\em Opaque handle to a screen. \item\end{CompactList}\item 
typedef void $\ast$ \hyperlink{simplewidget_8h_848b3750b3d76e289e76bdb01530cbeb}{simplewidget\_\-text}
\begin{CompactList}\small\item\em Opaque handle to a line of text. \item\end{CompactList}\item 
typedef void $\ast$ \hyperlink{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{simplewidget\_\-jpeg}
\begin{CompactList}\small\item\em Opaque handle to a jpeg image. \item\end{CompactList}\item 
typedef void $\ast$ \hyperlink{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{simplewidget\_\-png}
\begin{CompactList}\small\item\em Opaque handle to a png image. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{simplewidget_8h_2c0b824e3e874d611c4224e3e2378d78}{simplewidget\_\-screen\_\-init} (void $\ast$fbp, int fbw, int fbh, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} $\ast$swsp)
\begin{CompactList}\small\item\em Initializes a simplewidget screen. Must be called before any other simplewidget API call on this screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_524ab9a9b8628c8be8185ba343167817}{simplewidget\_\-screen\_\-clear} (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws, int x, int y, int w, int h)
\begin{CompactList}\small\item\em Clear an area of the screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_2a0d68c33d56c99328fed33f46044c41}{simplewidget\_\-screen\_\-draw\_\-rectangle} (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws, int x, int y, int w, int h, int r, int g, int b)
\begin{CompactList}\small\item\em Draw a rectangle on the screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_8e0f7e4528439c322dabbe18c83289de}{simplewidget\_\-screen\_\-exit} (\hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Deinitalize the simplewidget screen and free up associated resources. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_6c2692d11989d5afdda34f7207598072}{simplewidget\_\-button\_\-create} (int x, int y, int w, int h, int r, int g, int b, int font\_\-height, int border, char $\ast$txt, \hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} $\ast$swbp)
\begin{CompactList}\small\item\em Creates a button, but does not show it on screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_0e7b697a549847ffba7f465f33d81eb4}{simplewidget\_\-button\_\-show} (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} swb, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Show the button on the screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_5d27ef6084197b30604d2662ea2d0d03}{simplewidget\_\-button\_\-hide} (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} swb, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Hide a button (un-show it). \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_973c4af3e7b42156eca1431c193f9c9d}{simplewidget\_\-button\_\-press} (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} swb, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Press the button. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_d2a83689410608630d71525552953a0d}{simplewidget\_\-button\_\-release} (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} swb, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Release the button from being pressed. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_47a9d9273bcd4147a0d9ab8787068a34}{simplewidget\_\-button\_\-delete} (\hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button} swb)
\begin{CompactList}\small\item\em Delete the button and resources associated with it. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_836d4bf8d5b77ab01ece82cccf0f68f4}{simplewidget\_\-text\_\-create} (int x, int y, int height, char $\ast$txt, \hyperlink{simplewidget_8h_848b3750b3d76e289e76bdb01530cbeb}{simplewidget\_\-text} $\ast$swtp)
\begin{CompactList}\small\item\em Creates a line of text. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_0e3caa57a80e21c96a0e119f2b8a7c2b}{simplewidget\_\-text\_\-show} (\hyperlink{simplewidget_8h_848b3750b3d76e289e76bdb01530cbeb}{simplewidget\_\-text} swt, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws)
\begin{CompactList}\small\item\em Show the line of text on the screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_7b0bfa0733ade88fe229bb8034081d0e}{simplewidget\_\-text\_\-delete} (\hyperlink{simplewidget_8h_848b3750b3d76e289e76bdb01530cbeb}{simplewidget\_\-text} swt)
\begin{CompactList}\small\item\em Delete the line of text and resources associated with it. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_71a74a0e45f10f504c806d33e5443890}{simplewidget\_\-jpeg\_\-create} (char $\ast$filename, \hyperlink{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{simplewidget\_\-jpeg} $\ast$swjp)
\begin{CompactList}\small\item\em Creates a jpeg image in memory from a file. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_80d12b0874d62884db91b4b612e61bc9}{simplewidget\_\-jpeg\_\-show} (\hyperlink{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{simplewidget\_\-jpeg} swj, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws, int x, int y)
\begin{CompactList}\small\item\em Shows a previously created jpeg image on screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_cd5bf541f57ea04db673bda4b06b390d}{simplewidget\_\-jpeg\_\-delete} (\hyperlink{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{simplewidget\_\-jpeg} swj)
\begin{CompactList}\small\item\em Free up resources associated with a previously created jpeg image. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_c640aeb8431748e53bc58367275f0251}{simplewidget\_\-png\_\-create} (char $\ast$filename, \hyperlink{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{simplewidget\_\-png} $\ast$swpp)
\begin{CompactList}\small\item\em Creates a jpeg image in memory from a file. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_94a8e224229af652736f8cf67084c1bd}{simplewidget\_\-png\_\-show} (\hyperlink{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{simplewidget\_\-png} swp, \hyperlink{simplewidget_8h_3859e697b8ff68b557ae8ea98c1b1da6}{simplewidget\_\-screen} sws, int x, int y)
\begin{CompactList}\small\item\em Shows a previously created png image on screen. \item\end{CompactList}\item 
int \hyperlink{simplewidget_8h_3c757521f9f666aa32982d283727fe0b}{simplewidget\_\-png\_\-delete} (\hyperlink{simplewidget_8h_276ae311f9e5d6765b1984340b2b644e}{simplewidget\_\-png} swp)
\begin{CompactList}\small\item\em Free up resources associated with a previously created png image. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Define Documentation}
\hypertarget{simplewidget_8h_e138b2e443649ca9546c99e80957faac}{
\index{simplewidget.h@{simplewidget.h}!BYTES_PER_PIXEL@{BYTES\_\-PER\_\-PIXEL}}
\index{BYTES_PER_PIXEL@{BYTES\_\-PER\_\-PIXEL}!simplewidget.h@{simplewidget.h}}
\paragraph[BYTES\_\-PER\_\-PIXEL]{\setlength{\rightskip}{0pt plus 5cm}\#define BYTES\_\-PER\_\-PIXEL~2}\hfill}
\label{simplewidget_8h_e138b2e443649ca9546c99e80957faac}


Only 16 bit color supported. 



Definition at line 21 of file simplewidget.h.\hypertarget{simplewidget_8h_f8aafa52e2ed8e01099c7ee8f1cf73da}{
\index{simplewidget.h@{simplewidget.h}!SIMPLEWIDGET_SUCCESS@{SIMPLEWIDGET\_\-SUCCESS}}
\index{SIMPLEWIDGET_SUCCESS@{SIMPLEWIDGET\_\-SUCCESS}!simplewidget.h@{simplewidget.h}}
\paragraph[SIMPLEWIDGET\_\-SUCCESS]{\setlength{\rightskip}{0pt plus 5cm}\#define SIMPLEWIDGET\_\-SUCCESS~0}\hfill}
\label{simplewidget_8h_f8aafa52e2ed8e01099c7ee8f1cf73da}


Success return code. 



Definition at line 23 of file simplewidget.h.\hypertarget{simplewidget_8h_948489ec9bcb24150aeb354ac8155220}{
\index{simplewidget.h@{simplewidget.h}!SIMPLEWIDGET_FAILURE@{SIMPLEWIDGET\_\-FAILURE}}
\index{SIMPLEWIDGET_FAILURE@{SIMPLEWIDGET\_\-FAILURE}!simplewidget.h@{simplewidget.h}}
\paragraph[SIMPLEWIDGET\_\-FAILURE]{\setlength{\rightskip}{0pt plus 5cm}\#define SIMPLEWIDGET\_\-FAILURE~-1}\hfill}
\label{simplewidget_8h_948489ec9bcb24150aeb354ac8155220}


Failure return code. 



Definition at line 24 of file simplewidget.h.

\subsubsection{Typedef Documentation}
\hypertarget{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_button@{simplewidget\_\-button}}
\index{simplewidget_button@{simplewidget\_\-button}!simplewidget.h@{simplewidget.h}}
\paragraph[simplewidget\_\-button]{\setlength{\rightskip}{0pt plus 5cm}typedef void$\ast$ \hyperlink{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}{simplewidget\_\-button}}\hfill}
\label{simplewidget_8h_f012d639d1534b94dcda95dc9ead9814}


Opaque handle to a button. 



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


Opaque handle to a screen. 



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


Opaque handle to a line of text. 



Definition at line 28 of file simplewidget.h.\hypertarget{simplewidget_8h_5c4718660fcb97d390091235260dd2d8}{
\index{simplewidget.h@{simplewidget.h}!simplewidget_jpeg@{simplewidget\_\-jpeg}}