Update docs

Baekalfen · Jul 13, 2024 · 7bc25ca · 7bc25ca
1 parent 2b1fe99
commit 7bc25ca
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 30 deletions.
diff --git a/docs/api/screen.html b/docs/api/screen.html
@@ -230,12 +230,9 @@ <h1 class="title">Module <code>pyboy.api.screen</code></h1>
         list:
             Nested list of SCX, SCY, WX and WY for each scanline (144x4). Returns (0, 0, 0, 0) when LCD is off.
         &#34;&#34;&#34;
-        # self.tilemap_position_list = np.asarray(self.mb.lcd.renderer._scanlineparameters, dtype=np.uint8).reshape(144, 5)[:, :4]
-        # self.tilemap_position_list = self.mb.lcd.renderer._scanlineparameters
 
-        # # return self.mb.lcd.renderer._scanlineparameters
         if self.mb.lcd._LCDC.lcd_enable:
-            return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd.renderer._scanlineparameters]
+            return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd._scanlineparameters]
         else:
             return [[0, 0, 0, 0] for line in range(144)]
 
@@ -467,12 +464,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         list:
             Nested list of SCX, SCY, WX and WY for each scanline (144x4). Returns (0, 0, 0, 0) when LCD is off.
         &#34;&#34;&#34;
-        # self.tilemap_position_list = np.asarray(self.mb.lcd.renderer._scanlineparameters, dtype=np.uint8).reshape(144, 5)[:, :4]
-        # self.tilemap_position_list = self.mb.lcd.renderer._scanlineparameters
 
-        # # return self.mb.lcd.renderer._scanlineparameters
         if self.mb.lcd._LCDC.lcd_enable:
-            return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd.renderer._scanlineparameters]
+            return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd._scanlineparameters]
         else:
             return [[0, 0, 0, 0] for line in range(144)]
 
@@ -569,12 +563,9 @@ <h2 id="returns">Returns</h2>
     list:
         Nested list of SCX, SCY, WX and WY for each scanline (144x4). Returns (0, 0, 0, 0) when LCD is off.
     &#34;&#34;&#34;
-    # self.tilemap_position_list = np.asarray(self.mb.lcd.renderer._scanlineparameters, dtype=np.uint8).reshape(144, 5)[:, :4]
-    # self.tilemap_position_list = self.mb.lcd.renderer._scanlineparameters
 
-    # # return self.mb.lcd.renderer._scanlineparameters
     if self.mb.lcd._LCDC.lcd_enable:
-        return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd.renderer._scanlineparameters]
+        return [[line[0], line[1], line[2], line[3]] for line in self.mb.lcd._scanlineparameters]
     else:
         return [[0, 0, 0, 0] for line in range(144)]</code></pre>
 </details>

diff --git a/docs/api/tile.html b/docs/api/tile.html
@@ -220,9 +220,9 @@ <h1 class="title">Module <code>pyboy.api.tile</code></h1>
                 byte1 = self.mb.lcd.VRAM1[self.data_address + k - VRAM_OFFSET]
                 byte2 = self.mb.lcd.VRAM1[self.data_address + k + 1 - VRAM_OFFSET]
 
+            colorcode = self.mb.lcd.renderer.colorcode(byte1, byte2)
             for x in range(8):
-                colorcode = utils.color_code(byte1, byte2, 7 - x)
-                self.data[k // 2][x] = self.mb.lcd.BGP.getcolor(colorcode)
+                self.data[k // 2][x] = self.mb.lcd.BGP.getcolor((colorcode &gt;&gt; x * 8) &amp; 0xFF)
         return self.data
 
     def __eq__(self, other):
@@ -419,9 +419,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 byte1 = self.mb.lcd.VRAM1[self.data_address + k - VRAM_OFFSET]
                 byte2 = self.mb.lcd.VRAM1[self.data_address + k + 1 - VRAM_OFFSET]
 
+            colorcode = self.mb.lcd.renderer.colorcode(byte1, byte2)
             for x in range(8):
-                colorcode = utils.color_code(byte1, byte2, 7 - x)
-                self.data[k // 2][x] = self.mb.lcd.BGP.getcolor(colorcode)
+                self.data[k // 2][x] = self.mb.lcd.BGP.getcolor((colorcode &gt;&gt; x * 8) &amp; 0xFF)
         return self.data
 
     def __eq__(self, other):

diff --git a/docs/index.html b/docs/index.html
@@ -186,7 +186,7 @@ <h2 id="kwargs">Kwargs</h2>
 
         for k, v in defaults.items():
             if k not in kwargs:
-                kwargs[k] = kwargs.get(k, defaults[k])
+                kwargs[k] = v
 
         _log_level(log_level)
 
@@ -3201,14 +3201,12 @@ <h2 id="args">Args</h2>
                     start -= 0x4000
                     stop -= 0x4000
                 # Cartridge ROM Banks
-                assert stop &lt; 0x4000, &#34;Out of bounds for reading ROM bank&#34;
+                assert stop &lt;= 0x4000, &#34;Out of bounds for reading ROM bank&#34;
                 assert bank &lt;= self.mb.cartridge.external_rom_count, &#34;ROM Bank out of range&#34;
 
-                # TODO: If you change a RAM value outside of the ROM banks above, the memory value will stay the same no matter
-                # what the game writes to the address. This can be used so freeze the value for health, cash etc.
                 if bank == -1:
                     assert start &lt;= 0xFF, &#34;Start address out of range for bootrom&#34;
-                    assert stop &lt;= 0xFF, &#34;Start address out of range for bootrom&#34;
+                    assert stop &lt;= 0x100, &#34;Start address out of range for bootrom&#34;
                     if not is_single:
                         # Writing slice of memory space
                         if hasattr(v, &#34;__iter__&#34;):
@@ -3240,7 +3238,7 @@ <h2 id="args">Args</h2>
                 stop -= 0x8000
                 # CGB VRAM Banks
                 assert self.mb.cgb or (bank == 0), &#34;Selecting bank of VRAM is only supported for CGB mode&#34;
-                assert stop &lt; 0x2000, &#34;Out of bounds for reading VRAM bank&#34;
+                assert stop &lt;= 0x2000, &#34;Out of bounds for reading VRAM bank&#34;
                 assert bank &lt;= 1, &#34;VRAM Bank out of range&#34;
 
                 if bank == 0:
@@ -3273,7 +3271,7 @@ <h2 id="args">Args</h2>
                 start -= 0xA000
                 stop -= 0xA000
                 # Cartridge RAM banks
-                assert stop &lt; 0x2000, &#34;Out of bounds for reading cartridge RAM bank&#34;
+                assert stop &lt;= 0x2000, &#34;Out of bounds for reading cartridge RAM bank&#34;
                 assert bank &lt;= self.mb.cartridge.external_ram_count, &#34;ROM Bank out of range&#34;
                 if not is_single:
                     # Writing slice of memory space
@@ -3295,7 +3293,7 @@ <h2 id="args">Args</h2>
                     stop -= 0x1000
                 # CGB VRAM banks
                 assert self.mb.cgb or (bank == 0), &#34;Selecting bank of WRAM is only supported for CGB mode&#34;
-                assert stop &lt; 0x1000, &#34;Out of bounds for reading VRAM bank&#34;
+                assert stop &lt;= 0x1000, &#34;Out of bounds for reading VRAM bank&#34;
                 assert bank &lt;= 7, &#34;WRAM Bank out of range&#34;
                 if not is_single:
                     # Writing slice of memory space
@@ -3377,69 +3375,77 @@ <h2 id="args">Args</h2>
     True
     ```
     &#34;&#34;&#34;
-
     def __init__(self, cpu):
         self.cpu = cpu
 
     @property
     def A(self):
         return self.cpu.A
+
     @A.setter
     def A(self, value):
         self.cpu.A = value &amp; 0xFF
 
     @property
     def F(self):
         return self.cpu.F
+
     @F.setter
     def F(self, value):
         self.cpu.F = value &amp; 0xF0
 
     @property
     def B(self):
         return self.cpu.B
+
     @B.setter
     def B(self, value):
         self.cpu.B = value &amp; 0xFF
 
     @property
     def C(self):
         return self.cpu.C
+
     @C.setter
     def C(self, value):
         self.cpu.C = value &amp; 0xFF
 
     @property
     def D(self):
         return self.cpu.D
+
     @D.setter
     def D(self, value):
         self.cpu.D = value &amp; 0xFF
 
     @property
     def E(self):
         return self.cpu.E
+
     @E.setter
     def E(self, value):
         self.cpu.E = value &amp; 0xFF
 
     @property
     def HL(self):
         return self.cpu.HL
+
     @HL.setter
     def HL(self, value):
         self.cpu.HL = value &amp; 0xFFFF
 
     @property
     def SP(self):
         return self.cpu.SP
+
     @SP.setter
     def SP(self, value):
         self.cpu.SP = value &amp; 0xFFFF
 
     @property
     def PC(self):
         return self.cpu.PC
+
     @PC.setter
     def PC(self, value):
         self.cpu.PC = value &amp; 0xFFFF</code></pre>

diff --git a/docs/utils.html b/docs/utils.html
@@ -32,7 +32,7 @@ <h1 class="title">Module <code>pyboy.utils</code></h1>
 
 __all__ = [&#34;WindowEvent&#34;, &#34;dec_to_bcd&#34;, &#34;bcd_to_dec&#34;]
 
-STATE_VERSION = 10
+STATE_VERSION = 11
 
 ##############################################################
 # Buffer classes
@@ -143,10 +143,7 @@ <h1 class="title">Module <code>pyboy.utils</code></h1>
 # Misc
 
 
-# TODO: Would a lookup-table increase performance? For example a lookup table of each 4-bit nibble?
-# That&#39;s 16**2 = 256 values. Index calculated as: (byte1 &amp; 0xF0) | ((byte2 &amp; 0xF0) &gt;&gt; 4)
-# and then: (byte1 &amp; 0x0F) | ((byte2 &amp; 0x0F) &gt;&gt; 4)
-# Then could even be preloaded for each color palette
+# NOTE: Legacy function. Use look-up table in Renderer
 def color_code(byte1, byte2, offset):
     &#34;&#34;&#34;Convert 2 bytes into color code at a given offset.