chore: support for next_frame()

Allowing frame by frame "navigation".

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-*
+* Support for Python 3 API - [#36](https://gitlab.stage.hive.pt/joamag/boytacean/-/issues/36)
+* `next_frame()` method for frame by frame navigation
 
 ### Changed
 

examples/python/pocket.py

@@ -3,5 +3,6 @@ import boytacean
 gb = boytacean.GameBoy()
 gb.load()
 gb.load_rom("../../res/roms/demo/pocket.gb")
-gb.clocks(10000000)
+for _ in range(6000):
+    gb.next_frame()
 gb.save_image("pocket.png")

src/gb.rs

@@ -487,6 +487,18 @@ impl GameBoy {
         cycles
     }
 
+    pub fn next_frame(&mut self) -> u32 {
+        let mut cycles = 0u32;
+        let current_frame = self.ppu_frame();
+        loop {
+            cycles += self.clock() as u32;
+            if self.ppu_frame() != current_frame {
+                break;
+            }
+        }
+        cycles
+    }
+
     pub fn key_press(&mut self, key: PadKey) {
         self.pad().key_press(key);
     }

src/py.rs

@@ -43,6 +43,10 @@ impl GameBoy {
         self.system.clocks(count)
     }
 
+    pub fn next_frame(&mut self) -> u32 {
+        self.system.next_frame()
+    }
+
     pub fn frame_buffer(&mut self, py: Python) -> PyObject {
         let pybytes = PyBytes::new(py, self.system.frame_buffer());
         pybytes.into()

src/python/boytacean/__init__.py

@@ -23,6 +23,9 @@ class GameBoy:
     def clocks(self, count: int) -> int:
         return self._system.clocks(count)
 
+    def next_frame(self) -> int:
+        return self._system.next_frame()
+
     def frame_buffer(self):
         return self._system.frame_buffer()