SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/latex/d2/ddb/class_my_sprite.tex
2022-01-11 15:45:50 +01:00

83 lines
4.1 KiB
TeX

\hypertarget{class_my_sprite}{}\doxysection{My\+Sprite Class Reference}
\label{class_my_sprite}\index{MySprite@{MySprite}}
{\ttfamily \#include $<$my\+Sprite.\+h$>$}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{utils_8h_a7a271d55f100974f7703690edbaca2e2}{Task}} \mbox{\hyperlink{class_my_sprite_adbc71a279bb938c9397f4c353fc0e831}{async\+Load}} (const string \&fname)
\begin{DoxyCompactList}\small\item\em load a sprite asynchronously \end{DoxyCompactList}\item
void \mbox{\hyperlink{class_my_sprite_ac80878b9bd025226a903705d3b8df9ae}{mirror}} (\mbox{\hyperlink{class_my_sprite}{My\+Sprite}} \&msp)
\begin{DoxyCompactList}\small\item\em Mirror a sprite pixel data into this one. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
optional$<$ ns\+Gui\+::\+Sprite $>$ \mbox{\hyperlink{class_my_sprite_ab5c268ae1f1082535dc15dc163910794}{sp}}
\begin{DoxyCompactList}\small\item\em optional actual Sprite We need to use an optional to init the object through a function, that can be used with std\+::async mutable because for some reason Min\+GL stores a Vec2D with the pixel data, so we modify it each time we need to draw it Else, we could copy the Sprite each time, but copying a bunch of images each frame doesn\textquotesingle{}t seems like a good idea \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Definition at line \mbox{\hyperlink{my_sprite_8h_source_l00011}{11}} of file \mbox{\hyperlink{my_sprite_8h_source}{my\+Sprite.\+h}}.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_my_sprite_adbc71a279bb938c9397f4c353fc0e831}\label{class_my_sprite_adbc71a279bb938c9397f4c353fc0e831}}
\index{MySprite@{MySprite}!asyncLoad@{asyncLoad}}
\index{asyncLoad@{asyncLoad}!MySprite@{MySprite}}
\doxysubsubsection{\texorpdfstring{asyncLoad()}{asyncLoad()}}
{\footnotesize\ttfamily \mbox{\hyperlink{utils_8h_a7a271d55f100974f7703690edbaca2e2}{Task}} My\+Sprite\+::async\+Load (\begin{DoxyParamCaption}\item[{const string \&}]{fname }\end{DoxyParamCaption})}
load a sprite asynchronously
\begin{DoxyReturn}{Returns}
An async task of the loading action
\end{DoxyReturn}
Definition at line \mbox{\hyperlink{my_sprite_8cpp_source_l00004}{4}} of file \mbox{\hyperlink{my_sprite_8cpp_source}{my\+Sprite.\+cpp}}.
\mbox{\Hypertarget{class_my_sprite_ac80878b9bd025226a903705d3b8df9ae}\label{class_my_sprite_ac80878b9bd025226a903705d3b8df9ae}}
\index{MySprite@{MySprite}!mirror@{mirror}}
\index{mirror@{mirror}!MySprite@{MySprite}}
\doxysubsubsection{\texorpdfstring{mirror()}{mirror()}}
{\footnotesize\ttfamily void My\+Sprite\+::mirror (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_my_sprite}{My\+Sprite}} \&}]{msp }\end{DoxyParamCaption})}
Mirror a sprite pixel data into this one.
Definition at line \mbox{\hyperlink{my_sprite_8cpp_source_l00011}{11}} of file \mbox{\hyperlink{my_sprite_8cpp_source}{my\+Sprite.\+cpp}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_my_sprite_ab5c268ae1f1082535dc15dc163910794}\label{class_my_sprite_ab5c268ae1f1082535dc15dc163910794}}
\index{MySprite@{MySprite}!sp@{sp}}
\index{sp@{sp}!MySprite@{MySprite}}
\doxysubsubsection{\texorpdfstring{sp}{sp}}
{\footnotesize\ttfamily optional$<$ns\+Gui\+::\+Sprite$>$ My\+Sprite\+::sp\hspace{0.3cm}{\ttfamily [mutable]}}
optional actual Sprite We need to use an optional to init the object through a function, that can be used with std\+::async mutable because for some reason Min\+GL stores a Vec2D with the pixel data, so we modify it each time we need to draw it Else, we could copy the Sprite each time, but copying a bunch of images each frame doesn\textquotesingle{}t seems like a good idea
Definition at line \mbox{\hyperlink{my_sprite_8h_source_l00020}{20}} of file \mbox{\hyperlink{my_sprite_8h_source}{my\+Sprite.\+h}}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
headers/\mbox{\hyperlink{my_sprite_8h}{my\+Sprite.\+h}}\item
src/\mbox{\hyperlink{my_sprite_8cpp}{my\+Sprite.\+cpp}}\end{DoxyCompactItemize}