Skip to content

Make it more clear how a Ui Id was derived #7988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lucasmerlin wants to merge 2 commits into
base: lucas/experiments/helpful-id-debug
Choose a base branch
from
+18 −12
Open

Make it more clear how a Ui Id was derived #7988

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2feb5a7
Make it more clear how a Ui Id was derived
lucasmerlin Mar 18, 2026
93c68aa
Merge branch 'lucas/experiments/helpful-id-debug' into lucas/better-u…
lucasmerlin Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions crates/egui/src/ui.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ impl Ui {
let mut ui = Ui {
id,
unique_id: id,
next_auto_id_salt: id.with("auto").value(),
next_auto_id_salt: 0,
painter: Painter::new(ctx, layer_id, clip_rect),
style,
placer,
Expand Down Expand Up @@ -293,12 +293,10 @@ impl Ui {
(id_salt, id_salt)
} else {
let stable_id = self.id.with(id_salt);
let unique_id = stable_id.with(self.next_auto_id_salt);
let unique_id = self.unique_id.with(id_salt).with(self.next_auto_id_salt);

(stable_id, unique_id)
};
let next_auto_id_salt = unique_id.value().wrapping_add(1);

self.next_auto_id_salt = self.next_auto_id_salt.wrapping_add(1);

let placer = Placer::new(max_rect, layout);
Expand All @@ -313,7 +311,7 @@ impl Ui {
let mut child_ui = Ui {
id: stable_id,
unique_id,
next_auto_id_salt,
next_auto_id_salt: 0,
painter,
style,
placer,
Expand Down Expand Up @@ -1005,22 +1003,33 @@ impl Ui {
}

/// This is the `Id` that will be assigned to the next widget added to this `Ui`.
#[inline]
pub fn next_auto_id(&self) -> Id {
Id::new(self.next_auto_id_salt)
self.unique_id.with(self.next_auto_id_salt)
}

/// Same as `ui.next_auto_id().with(id_salt)`
#[inline]
pub fn auto_id_with<IdSource>(&self, id_salt: IdSource) -> Id
where
IdSource: AsId,
{
Id::new(self.next_auto_id_salt).with(id_salt)
self.next_auto_id().with(id_salt)
}

/// Pretend like `count` widgets have been allocated.
#[inline]
pub fn skip_ahead_auto_ids(&mut self, count: usize) {
self.next_auto_id_salt = self.next_auto_id_salt.wrapping_add(count as u64);
}

/// Get auto id and advance auto id counter by 1.
#[inline]
pub fn get_auto_id(&mut self) -> Id {
Copy link
Copy Markdown
Owner

@emilk emilk Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get sounds like it doesn't change anything, which it does

Suggested change
pub fn get_auto_id(&mut self) -> Id {
pub fn allocate_auto_id(&mut self) -> Id {

let id = self.next_auto_id();
self.skip_ahead_auto_ids(1);
id
}
}

/// # Interaction
Expand Down Expand Up @@ -1370,8 +1379,7 @@ impl Ui {
}
}

let id = Id::new(self.next_auto_id_salt);
self.next_auto_id_salt = self.next_auto_id_salt.wrapping_add(1);
let id = self.get_auto_id();

(id, rect)
}
Expand Down Expand Up @@ -1411,9 +1419,7 @@ impl Ui {
self.placer.advance_after_rects(rect, rect, item_spacing);
register_rect(self, rect);

let id = Id::new(self.next_auto_id_salt);
self.next_auto_id_salt = self.next_auto_id_salt.wrapping_add(1);
id
self.get_auto_id()
}

pub(crate) fn placer(&self) -> &Placer {
Expand Down
Loading