DjalimSimaila/SuperSpaceInvaderTurboApocalypseVsGOD
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc stuff again

Browse Source
This commit is contained in:
Djalim Simaila 2022-01-11 14:31:07 +01:00
parent 9cd2593f47
commit 8aea8ba0f9
2 changed files with 25 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
headers/pixelManager/goodPixelManager.h
View File

@ -1,3 +1,14 @@
/*!
*
* @file goodPixelManager.h
* @author RUBINI Thomas
* @date January 2022
* @version 1.0
* @brief Manages screen display with async sprite loading
*
*/
#ifndef GUARD_GOODPIXELMANAGER_H #ifndef GUARD_GOODPIXELMANAGER_H
#define GUARD_GOODPIXELMANAGER_H #define GUARD_GOODPIXELMANAGER_H
@ -13,7 +24,7 @@ class GoodPixelManager : public PixelManager{
/*! /*!
* @brief loads sprites in parallel using multiple threads * @brief loads sprites in parallel using multiple threads
* @param[in] vec : We take his ownership, so * @param[out] tasks : vectot of task
* @fn void loadSprites(); * @fn void loadSprites();
*/ */
void loadSprites(vector<Task>& tasks) override; void loadSprites(vector<Task>& tasks) override;
@ -24,17 +35,17 @@ class GoodPixelManager : public PixelManager{
MySprite player; MySprite player;
/*! /*!
* @brief sprite of the first invader * @brief sprite of the type A invader
*/ */
MySprite invaderA; MySprite invaderA;
/*! /*!
* @brief sprite of the second invader * @brief sprite of the type B invader
*/ */
MySprite invaderB; MySprite invaderB;
/*! /*!
* @brief sprite of the third invader * @brief sprite of the type B invader
*/ */
MySprite invaderC; MySprite invaderC;
@ -50,9 +61,11 @@ class GoodPixelManager : public PixelManager{
public: public:
/*! /*!
* @brief constructor * @brief constructor the pixel manager class
* @param[in] window : window of the pixel manager
* @fn GoodPixelManager(MinGL&);
*/ */
GoodPixelManager(MinGL& win); explicit GoodPixelManager(MinGL& window);
}; };

10
headers/pixelManager/pixelManager.h
View File

@ -6,7 +6,7 @@
* @author FABRE Lucas * @author FABRE Lucas
* @date January 2022 * @date January 2022
* @version 1.0 * @version 1.0
* @brief manager * @brief Manages screen display
* *
*/ */
@ -46,17 +46,19 @@ typedef nsGui::GlutFont::GlutFonts Font;
class PixelManager{ class PixelManager{
public: public:
MinGL& window;
/*!
* @brief display window
*/
MinGL& window;
/*! /*!
* @brief loads sprites in parallel using multiple threads * @brief loads sprites in parallel using multiple threads
* @param[in] vec : We take his ownership, so * @param[in] tasks : vectot of task
* @fn void loadSprites(); * @fn void loadSprites();
*/ */
virtual void loadSprites(vector<Task>& tasks); virtual void loadSprites(vector<Task>& tasks);
/*! /*!
* @brief sprite of the logo of the game * @brief sprite of the logo of the game
*/ */