OAM module

src/lib.rs

@@ -3,7 +3,7 @@
 #![feature(const_int_wrapping)]
 #![feature(const_int_rotate)]
 #![feature(min_const_unsafe_fn)]
-//#![warn(missing_docs)]
+#![warn(missing_docs)]
 #![allow(clippy::cast_lossless)]
 #![deny(clippy::float_arithmetic)]
 
@@ -65,6 +65,7 @@ pub(crate) use self::base::*;
 pub mod bios;
 pub mod io;
 pub mod mgba;
+pub mod oam;
 pub mod palram;
 pub mod vram;
 

src/oam.rs

@@ -1,18 +1,21 @@
 //! Types and declarations for the Object Attribute Memory (`OAM`).
 
+use super::*;
+
 newtype! {
-  // TODO
+  /// 0th part of an object's attributes.
+  ///
+  /// * Bits 0-7: row-coordinate
+  /// * Bits 8-9: Rendering style: Normal, Affine, Disabled, Double Area Affine
+  /// * Bits 10-11: Object mode: Normal, SemiTransparent, Object Window
+  /// * Bit 12: Mosaic
+  /// * Bit 13: is 8bpp
+  /// * Bits 14-15: Object Shape: Square, Horizontal, Vertical
   #[derive(Debug, Copy, Clone, Default, PartialEq, Eq)]
   OBJAttr0, u16
 }
 impl OBJAttr0 {
-  bool_bits!(
-    u16,
-    [
-      (12, mosaic),
-      (13, is_8bpp),
-    ]
-  );
+  bool_bits!(u16, [(12, mosaic), (13, is_8bpp),]);
 
   multi_bits!(
     u16,
@@ -25,44 +28,60 @@ impl OBJAttr0 {
   );
 }
 
+/// What style of rendering for this object
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u16)]
 pub enum ObjectRender {
+  /// Standard, non-affine rendering
   Normal = 0,
+  /// Affine rendering
   Affine = 1,
+  /// Object disabled (saves cycles for elsewhere!)
   Disabled = 2,
+  /// Affine with double render space (helps prevent clipping)
   DoubleAreaAffine = 3,
 }
 
+/// What mode to ues for the object.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u16)]
 pub enum ObjectMode {
+  /// Show the object normally
   Normal = 0,
+  /// The object becomes the "Alpha Blending 1st target" (see Alpha Blending)
   SemiTransparent = 1,
-  OBJWindow = 2
+  /// Use the object's non-transparent pixels as part of a mask for the object
+  /// window (see Windows).
+  OBJWindow = 2,
 }
 
+/// What shape the object's appearance should be.
+///
+/// The specifics also depend on the `ObjectSize` set.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u16)]
 pub enum ObjectShape {
+  /// Equal parts wide and tall
   Square = 0,
+  /// Wider than tall
   Horizontal = 1,
-  Vertical = 2
+  /// Taller than wide
+  Vertical = 2,
 }
 
 newtype! {
-  // TODO
+  /// 1st part of an object's attributes.
+  ///
+  /// * Bits 0-8: column coordinate
+  /// * Bits 9-13:
+  ///   * Normal render: Bit 12 holds hflip and 13 holds vflip.
+  ///   * Affine render: The affine parameter selection.
+  /// * Bits 14-15: Object Size
   #[derive(Debug, Copy, Clone, Default, PartialEq, Eq)]
   OBJAttr1, u16
 }
 impl OBJAttr1 {
-  bool_bits!(
-    u16,
-    [
-      (12, hflip),
-      (13, vflip),
-    ]
-  );
+  bool_bits!(u16, [(12, hflip), (13, vflip),]);
 
   multi_bits!(
     u16,
@@ -74,27 +93,39 @@ impl OBJAttr1 {
   );
 }
 
+/// The object's size.
+///
+/// Also depends on the `ObjectShape` set.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[repr(u16)]
 pub enum ObjectSize {
+  /// * Square: 8x8px
+  /// * Horizontal: 16x8px
+  /// * Vertical: 8x16px
   Zero = 0,
+  /// * Square: 16x16px
+  /// * Horizontal: 32x8px
+  /// * Vertical: 8x32px
   One = 1,
+  /// * Square: 32x32px
+  /// * Horizontal: 32x16px
+  /// * Vertical: 16x32px
   Two = 2,
+  /// * Square: 64x64px
+  /// * Horizontal: 64x32px
+  /// * Vertical: 32x64px
   Three = 3,
 }
 
 newtype! {
-  // TODO
+  /// 2nd part of an object's attributes.
+  ///
+  /// * Bits 0-9: Base Tile Index (tile offset from CBB4)
+  /// * Bits 10-11: Priority
+  /// * Bits 12-15: Palbank (if using 4bpp)
   #[derive(Debug, Copy, Clone, Default, PartialEq, Eq)]
   OBJAttr2, u16
 }
 impl OBJAttr2 {
-  multi_bits!(
-    u16,
-    [
-      (0, 10, tile_id),
-      (10, 2, priority),
-      (12, 4, palbank),
-    ]
-  );
+  multi_bits!(u16, [(0, 10, tile_id), (10, 2, priority), (12, 4, palbank),]);
 }