Add docs for priority (#526)

- [x] no changelog update needed
This commit is contained in:
Gwilym Inzani 2023-12-28 22:33:06 +00:00 committed by GitHub
commit e8f5132c02
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -159,6 +159,10 @@ pub fn busy_wait_for_vblank() {
while VCOUNT.get() < 160 {} 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)] #[bitsize(2)]
#[derive(FromBits, PartialEq, Eq, Clone, Copy, Debug, Default)] #[derive(FromBits, PartialEq, Eq, Clone, Copy, Debug, Default)]
pub enum Priority { pub enum Priority {