fxengine/doc/latex/bitmap_8h.tex

113 lines
6.1 KiB
TeX

\hypertarget{bitmap_8h}{}\section{include/render/bitmap.h File Reference}
\label{bitmap_8h}\index{include/render/bitmap.h@{include/render/bitmap.h}}
{\ttfamily \#include $<$stdint.\+h$>$}\newline
{\ttfamily \#include $<$stdbool.\+h$>$}\newline
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}}
\begin{DoxyCompactList}\small\item\em bitmap rich type transparency is in the layout \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
typedef struct \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} \mbox{\hyperlink{bitmap_8h_a4ce04fd15af6abbbc6427c95ad7807af}{bitmap\+\_\+rich}}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} $\ast$ \mbox{\hyperlink{bitmap_8h_a12b3899d0900dff435e02de4372413a0}{bitmap\+\_\+new\+\_\+rich}} (uint32\+\_\+t size\+\_\+px\+\_\+x, uint32\+\_\+t size\+\_\+px\+\_\+y, uint32\+\_\+t $\ast$color, bool copy\+\_\+color, uint32\+\_\+t $\ast$layout, bool copy\+\_\+layout)
\begin{DoxyCompactList}\small\item\em \{ function\+\_\+description \} \end{DoxyCompactList}\item
uint8\+\_\+t \mbox{\hyperlink{bitmap_8h_a9153decdd49572286686861518a60929}{bitmap\+\_\+get\+\_\+pixel\+\_\+r}} (const \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} $\ast$bmp, uint32\+\_\+t x, uint32\+\_\+t y)
\begin{DoxyCompactList}\small\item\em get the color of pixel from rich bitmap \end{DoxyCompactList}\item
void \mbox{\hyperlink{bitmap_8h_ae1b667a294c2d69346ae3ddae679f945}{bitmap\+\_\+display\+\_\+pixel\+\_\+r}} (const \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} $\ast$bmp, uint32\+\_\+t bmp\+\_\+x, uint32\+\_\+t bmp\+\_\+y, uint32\+\_\+t x, uint32\+\_\+t y)
\begin{DoxyCompactList}\small\item\em display a specific rich bitmap pixel on the screen \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Typedef Documentation}
\mbox{\Hypertarget{bitmap_8h_a4ce04fd15af6abbbc6427c95ad7807af}\label{bitmap_8h_a4ce04fd15af6abbbc6427c95ad7807af}}
\index{bitmap.h@{bitmap.h}!bitmap\_rich@{bitmap\_rich}}
\index{bitmap\_rich@{bitmap\_rich}!bitmap.h@{bitmap.h}}
\subsubsection{\texorpdfstring{bitmap\_rich}{bitmap\_rich}}
{\footnotesize\ttfamily typedef struct \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}}}
Definition at line 20 of file bitmap.\+h.
\subsection{Function Documentation}
\mbox{\Hypertarget{bitmap_8h_ae1b667a294c2d69346ae3ddae679f945}\label{bitmap_8h_ae1b667a294c2d69346ae3ddae679f945}}
\index{bitmap.h@{bitmap.h}!bitmap\_display\_pixel\_r@{bitmap\_display\_pixel\_r}}
\index{bitmap\_display\_pixel\_r@{bitmap\_display\_pixel\_r}!bitmap.h@{bitmap.h}}
\subsubsection{\texorpdfstring{bitmap\_display\_pixel\_r()}{bitmap\_display\_pixel\_r()}}
{\footnotesize\ttfamily void bitmap\+\_\+display\+\_\+pixel\+\_\+r (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} $\ast$}]{bmp, }\item[{uint32\+\_\+t}]{bmp\+\_\+x, }\item[{uint32\+\_\+t}]{bmp\+\_\+y, }\item[{uint32\+\_\+t}]{x, }\item[{uint32\+\_\+t}]{y }\end{DoxyParamCaption})}
display a specific rich bitmap pixel on the screen
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}} & {\em bmp} & The bitmap \\
\hline
\mbox{\texttt{ in}} & {\em bmp\+\_\+x} & The bitmap x coordinate (in pixels) \\
\hline
\mbox{\texttt{ in}} & {\em bmp\+\_\+y} & The bitmap y coordinate (in pixels) \\
\hline
\mbox{\texttt{ in}} & {\em x} & screen \+: x coordinate \\
\hline
\mbox{\texttt{ in}} & {\em y} & screen \+: y coordinate \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{bitmap_8h_a9153decdd49572286686861518a60929}\label{bitmap_8h_a9153decdd49572286686861518a60929}}
\index{bitmap.h@{bitmap.h}!bitmap\_get\_pixel\_r@{bitmap\_get\_pixel\_r}}
\index{bitmap\_get\_pixel\_r@{bitmap\_get\_pixel\_r}!bitmap.h@{bitmap.h}}
\subsubsection{\texorpdfstring{bitmap\_get\_pixel\_r()}{bitmap\_get\_pixel\_r()}}
{\footnotesize\ttfamily uint8\+\_\+t bitmap\+\_\+get\+\_\+pixel\+\_\+r (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}} $\ast$}]{bmp, }\item[{uint32\+\_\+t}]{x, }\item[{uint32\+\_\+t}]{y }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
get the color of pixel from rich bitmap
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}} & {\em bmp} & The bitmap \\
\hline
\mbox{\texttt{ in}} & {\em x} & The bitmap x coordinate (in pixels) \\
\hline
\mbox{\texttt{ in}} & {\em y} & The bitmap y coordinate (in pixels)\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the color coded in a unsigned char \+: if (color $>$$>$ 1) switch (color\%2) \{ case 0\+: // W\+H\+I\+TE break; case 1\+: // B\+L\+A\+CK \} else
\end{DoxyReturn}
\mbox{\Hypertarget{bitmap_8h_a12b3899d0900dff435e02de4372413a0}\label{bitmap_8h_a12b3899d0900dff435e02de4372413a0}}
\index{bitmap.h@{bitmap.h}!bitmap\_new\_rich@{bitmap\_new\_rich}}
\index{bitmap\_new\_rich@{bitmap\_new\_rich}!bitmap.h@{bitmap.h}}
\subsubsection{\texorpdfstring{bitmap\_new\_rich()}{bitmap\_new\_rich()}}
{\footnotesize\ttfamily \mbox{\hyperlink{structbitmap__rich}{bitmap\+\_\+rich}}$\ast$ bitmap\+\_\+new\+\_\+rich (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{size\+\_\+px\+\_\+x, }\item[{uint32\+\_\+t}]{size\+\_\+px\+\_\+y, }\item[{uint32\+\_\+t $\ast$}]{color, }\item[{bool}]{copy\+\_\+color, }\item[{uint32\+\_\+t $\ast$}]{layout, }\item[{bool}]{copy\+\_\+layout }\end{DoxyParamCaption})}
\{ function\+\_\+description \}
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}} & {\em size\+\_\+px\+\_\+x} & The width in px \\
\hline
\mbox{\texttt{ in}} & {\em size\+\_\+px\+\_\+y} & The height in px \\
\hline
& {\em color} & color origin \\
\hline
\mbox{\texttt{ in}} & {\em copy\+\_\+color} & if you want to make a copy, or only to make a link \\
\hline
& {\em layout} & layout origin -\/$>$ can be set as 0 if it isn\textquotesingle{}t needed \\
\hline
\mbox{\texttt{ in}} & {\em copy\+\_\+layout} & if you want to make a copy, or to make a link\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a rich bitmap, ready to use !
\end{DoxyReturn}