alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2025-01-11 17:41:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add some doc comments around the video struct

Browse source
This commit is contained in:
Gwilym Kuiper 2022-06-04 13:52:58 +01:00
parent 3c7d97e7f4
commit bc1bf3416c
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
agb/src/display/video.rs
View file

@ -4,6 +4,10 @@ use super::{
tiled::{Tiled0, VRamManager}, tiled::{Tiled0, VRamManager},
}; };
/// The video struct controls access to the video hardware.
/// It ensures that only one video mode is active at a time.
///
/// Most games will use tiled modes, as bitmap modes are too slow to run at the full 60 FPS.
#[non_exhaustive] #[non_exhaustive]
pub struct Video {} pub struct Video {}
@ -18,6 +22,7 @@ impl Video {
unsafe { Bitmap4::new() } unsafe { Bitmap4::new() }
} }
/// Tiled 0 mode provides 4 regular, tiled backgrounds
pub fn tiled0(&mut self) -> (Tiled0, VRamManager) { pub fn tiled0(&mut self) -> (Tiled0, VRamManager) {
(unsafe { Tiled0::new() }, VRamManager::new()) (unsafe { Tiled0::new() }, VRamManager::new())
} }