From 7a6043839ea8a32c5bd4b8cfb3e6cee600feb23e Mon Sep 17 00:00:00 2001
From: Corwin <corwin@kuiper.dev>
Date: Sat, 9 Dec 2023 20:48:46 +0000
Subject: [PATCH] add docs for priority

---
 agb/src/display/mod.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/agb/src/display/mod.rs b/agb/src/display/mod.rs
index 516f39f3..623493d2 100644
--- a/agb/src/display/mod.rs
+++ b/agb/src/display/mod.rs
@@ -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 {