Added FrameSet

Author: mahirlabibdihan

README.md

@@ -1047,7 +1047,7 @@ Custom font rendering is supported using TrueType fonts. `freetype` library is u
 Free sprite resources: [https://craftpix.net/freebies/](https://craftpix.net/freebies/)\\
 Online sprite cutter: [https://ezgif.com/sprite-cutter](https://ezgif.com/sprite-cutter)
 
-#### `void iInitSprite(Sprite *s)`
+<!-- #### `void iInitSprite(Sprite *s)`
 
 - **Description:** Initializes a sprite structure.
 - **Parameters:**
@@ -1059,62 +1059,78 @@ Online sprite cutter: [https://ezgif.com/sprite-cutter](https://ezgif.com/sprite
   Sprite s;
   iInitSprite(&s); // Initialize sprite and ignore white color
   ```
-- **Sprite Structure**
+- 
+  ``` -->
+
+#### Structure Definitions
+
+**FrameSet Structure**
+  ```cpp
+  typedef struct
+  {
+      Image *frames;
+      int count;
+  } FrameSet;
+  ```
+
+**Sprite Structure**
   ```cpp
   typedef struct
   {
       int x, y;
+      FrameSet frameSet;
       int currentFrame;
       ....
   } Sprite;
   ```
 
-#### `void iLoadFramesFromFolder(Image *frames, const char *folderPath)`
+#### `int iLoadFramesFromFolder(FrameSet *frames, const char *folderPath)`
 
 - **Description:** Loads frames from a folder containing multiple images.
 - **Parameters:**
 
-  - `frames`: Pointer to an array of `Image` structures.
+  - `frames`: Pointer to a `FrameSet` structure.
   - `folderPath`: Path to the folder containing images.
 
+- **Returns:** Number of frames loaded. -1 if failed to load any images.
 - **Example:**
   ```cpp
-  Image frames[10];
-  iLoadFramesFromFolder(frames, "sprites/"); // Load images from a folder and ignore no color
+  FrameSet frames;
+  iLoadFramesFromFolder(&frames, "sprites/"); // Load images from "sprites/" folder
   ```
 
-#### `void iLoadFramesFromSheet(Image *frames, const char *filename, int rows, int cols)`
+#### `int iLoadFramesFromSheet(FrameSet *frames, const char *filename, int rows, int cols)`
 
-- **Description:** Loads frames from a sprite sheet.
+- **Description:** Loads frames from a sprite sheet. 
 - **Parameters:**
 
-  - `frames`: Pointer to an array of `Image` structures.
+  - `frames`: Pointer to a `FrameSet` structure.
   - `filename`: Path to the sprite sheet image.
   - `rows`: Number of rows in the sprite sheet.
   - `cols`: Number of columns in the sprite sheet.
+   
+- **Returns:** Number of frames loaded. -1 if failed to load the sprite sheet.
 
 - **Example:**
   ```cpp
-  Image frames[16];
-  iLoadFramesFromSheet(frames, "spritesheet.png", 4, 4); // Load images frames a sprite sheet with 4 rows and 4 columns
+  FrameSet frames;
+  iLoadFramesFromSheet(&frames, "spritesheet.png", 4, 4); // Load images frames a sprite sheet with 4 rows and 4 columns
   ```
 
-#### `void iChangeSpriteFrames(Sprite *s, const Image *frames, int totalFrames)`
+#### `void iChangeSpriteFrames(Sprite *s, const FrameSet* frames)`
 
 - **Description:** Changes the frames of a sprite.
 - **Parameters:**
 
   - `s`: Pointer to a `Sprite` structure.
-  - `frames`: Array of `Image` structures representing the new frames.
-  - `totalFrames`: Number of frames in the array.
+  - `frames`: Pointer to a `FrameSet` structure representing the new frames.
 
 - **Example:**
   ```cpp
-  Image frames[10];
-  iLoadFramesFromFolder(frames,"sprites/"); // Load images from a folder
+  FrameSet frames;
+  iLoadFramesFromFolder(&frames, "sprites/"); // Load images from a folder
   Sprite s;
-  iInitSprite(&s); // Initialize sprite
-  iChangeSpriteFrames(&s, frames, 4); // Change the frames of the sprite
+  iChangeSpriteFrames(&s, &frames);
   ```
 
 #### `void iSetSpritePosition(Sprite* s, int x, int y)`

examples/BattleDemo.cpp

@@ -9,7 +9,7 @@ typedef enum
 
 typedef struct
 {
-    Image idle[4], walk[6], jump[8];
+    FrameSet idle, walk, jump;
     Sprite sprite;
     State state;
     int direction; // 1 for right, -1 for left
@@ -19,37 +19,37 @@ Monster pinkMonster;
 
 typedef struct
 {
-    Image idle[18], walk[25], jump[25];
+    FrameSet idle, walk, jump;
     Sprite sprite;
     State state;
     int direction; // 1 for right, -1 for left
 } Golem;
 
+Image bg;
+
 Golem golem;
 
 void loadPinkMonster()
 {
-    iLoadFramesFromSheet(pinkMonster.idle, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Idle_4.png", 1, 4);
-    iLoadFramesFromSheet(pinkMonster.walk, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Walk_6.png", 1, 6);
-    iLoadFramesFromSheet(pinkMonster.jump, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Jump_8.png", 1, 8);
+    iLoadFramesFromSheet(&pinkMonster.idle, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Idle_4.png", 1, 4);
+    iLoadFramesFromSheet(&pinkMonster.walk, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Walk_6.png", 1, 6);
+    iLoadFramesFromSheet(&pinkMonster.jump, "assets/images/sprites/1 Pink_Monster/Pink_Monster_Jump_8.png", 1, 8);
 
-    iInitSprite(&pinkMonster.sprite);
-    iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.idle, 4);
-    iSetSpritePosition(&pinkMonster.sprite, 250, 0);
+    iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.idle);
+    iSetSpritePosition(&pinkMonster.sprite, 250, 110);
     iScaleSprite(&pinkMonster.sprite, 3.0);
     pinkMonster.state = IDLE;
     pinkMonster.direction = 1; // 1 for right, -1 for left
 }
 
 void loadGolem()
 {
-    iLoadFramesFromFolder(golem.idle, "assets/images/sprites/Golem_2/Idle Blinking");
-    iLoadFramesFromFolder(golem.walk, "assets/images/sprites/Golem_2/Walking");
-    iLoadFramesFromFolder(golem.jump, "assets/images/sprites/Golem_2/Jump Start");
+    iLoadFramesFromFolder(&golem.idle, "assets/images/sprites/Golem_2/Idle Blinking");
+    iLoadFramesFromFolder(&golem.walk, "assets/images/sprites/Golem_2/Walking");
+    iLoadFramesFromFolder(&golem.jump, "assets/images/sprites/Golem_2/Jump Start");
 
-    iInitSprite(&golem.sprite);
-    iChangeSpriteFrames(&golem.sprite, golem.idle, 18);
-    iSetSpritePosition(&golem.sprite, 250, -75);
+    iChangeSpriteFrames(&golem.sprite, &golem.idle);
+    iSetSpritePosition(&golem.sprite, 250, 35);
     iScaleSprite(&golem.sprite, 0.5);
     iMirrorSprite(&golem.sprite, HORIZONTAL);
     golem.state = IDLE;
@@ -67,14 +67,14 @@ void iAnim()
             !isSpecialKeyPressed(GLUT_KEY_RIGHT))
         {
             pinkMonster.state = IDLE;
-            iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.idle, 4);
+            iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.idle);
         }
         break;
     case JUMP:
         if (!isSpecialKeyPressed(GLUT_KEY_UP))
         {
             pinkMonster.state = IDLE;
-            iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.idle, 4);
+            iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.idle);
         }
         break;
     }
@@ -90,6 +90,7 @@ void iDraw()
     iClear();
     iSetColor(255, 255, 255);
     iFilledRectangle(0, 0, 800, 400);
+    iShowLoadedImage(0, 0, &bg);
     iShowSprite(&golem.sprite);
     iShowSprite(&pinkMonster.sprite);
 
@@ -144,11 +145,12 @@ void iSpecialKeyPress(unsigned char key)
         }
         else
         {
-            pinkMonster.sprite.x--;
+            golem.sprite.x += 2;
+            iWrapImage(&bg, 2);
             if (pinkMonster.state != WALK)
             {
                 pinkMonster.state = WALK;
-                iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.walk, 6);
+                iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.walk);
             }
         }
     }
@@ -161,11 +163,12 @@ void iSpecialKeyPress(unsigned char key)
         }
         else
         {
-            pinkMonster.sprite.x++;
+            golem.sprite.x -= 2;
+            iWrapImage(&bg, -2);
             if (pinkMonster.state != WALK)
             {
                 pinkMonster.state = WALK;
-                iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.walk, 6);
+                iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.walk);
             }
         }
     }
@@ -175,7 +178,7 @@ void iSpecialKeyPress(unsigned char key)
         if (pinkMonster.state != JUMP)
         {
             pinkMonster.state = JUMP;
-            iChangeSpriteFrames(&pinkMonster.sprite, pinkMonster.jump, 8);
+            iChangeSpriteFrames(&pinkMonster.sprite, &pinkMonster.jump);
         }
     }
     if (key == GLUT_KEY_DOWN)
@@ -190,6 +193,8 @@ int main(int argc, char *argv[])
     iSetTimer(100, iAnim);
     loadPinkMonster();
     loadGolem();
+    iLoadImage(&bg, "assets/images/background.jpg");
+    iResizeImage(&bg, 800, 400);
     iOpenWindow(800, 400, "BattleDemo");
     return 0;
 }