Skip to content

Commit

Permalink
Add docs for priority (#526)
Browse files Browse the repository at this point in the history
- [x] no changelog update needed
  • Loading branch information
gwilymk authored Dec 28, 2023
2 parents 0faa5a5 + 7a60438 commit e8f5132
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions agb/src/display/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ pub fn busy_wait_for_vblank() {
while VCOUNT.get() < 160 {}
}

/// The priority of a background layer or object. A higher priority should be
/// thought of as rendering first, and so is behind that of a lower priority.
/// For an equal priority background layer and object, the background has a
/// higher priority and therefore is behind the object.
#[bitsize(2)]
#[derive(FromBits, PartialEq, Eq, Clone, Copy, Debug, Default)]
pub enum Priority {
Expand Down

0 comments on commit e8f5132

Please sign in to comment.