Target Library

Dependents:   GameProject_Prototype

Files at this revision

API Documentation at this revision

Comitter:
ll14c4p
Date:
Thu May 04 11:36:45 2017 +0000
Parent:
13:828ede9cf8a5
Commit message:
+Deoxygen

Changed in this revision

Target.h Show annotated file Show diff for this revision Revisions of this file
diff -r 828ede9cf8a5 -r 0f590475ba85 Target.h
--- a/Target.h	Thu May 04 08:34:51 2017 +0000
+++ b/Target.h	Thu May 04 11:36:45 2017 +0000
@@ -11,10 +11,35 @@
     public:
     Target();
     ~Target();
+    
+    /** Initialise Target
+    *
+    *   This function initialises the target library.
+    */
     void init();
+    
+    /** Draw
+    *
+    *   This function draws the target sprite onto the screen.
+    */
     void draw(N5110 &lcd);
+    
+    /** Update
+    *
+    *   This function updates the position of the target as it moves on the screen.
+    */
     void update();
+    
+    /** Get Position
+    *
+    *   This function obtains the coordinates of the top-left pixel in the targets sprite.
+    */
     Vector2D get_pos();
+    
+    /** Set Position
+    *
+    *   This function is used to change the position of the sprite to specific coordinates when called.
+    */
     void set_pos(Vector2D p);
 
     private: