add documentation for submodules

This commit is contained in:
Corwin Kuiper 2021-06-03 19:22:16 +01:00
parent 6eb13473bb
commit b023807bc0

View file

@ -4,13 +4,21 @@ use bitflags::bitflags;
use vblank::VBlankGiver; use vblank::VBlankGiver;
use video::Video; use video::Video;
/// Graphics mode 3. Bitmap mode that provides a 16-bit colour framebuffer.
pub mod bitmap3; pub mod bitmap3;
/// Graphics mode 4. Bitmap 4 provides two 8-bit paletted framebuffers with page switching.
pub mod bitmap4; pub mod bitmap4;
/// Test logo of agb.
pub mod example_logo; pub mod example_logo;
/// Implements sprites.
pub mod object; pub mod object;
/// Palette type.
pub mod palette16; pub mod palette16;
/// Graphics mode 0. Four regular backgrounds.
pub mod tiled0; pub mod tiled0;
/// Syscall for waiting for vblank.
pub mod vblank; pub mod vblank;
/// Giving out graphics mode.
pub mod video; pub mod video;
const DISPLAY_CONTROL: MemoryMapped<u16> = unsafe { MemoryMapped::new(0x0400_0000) }; const DISPLAY_CONTROL: MemoryMapped<u16> = unsafe { MemoryMapped::new(0x0400_0000) };