skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Align `available_rect` docs with the new reality after #4590 (#5701) 

...as after #4590, `Window`/`Area` is not constrained within it.
This commit is contained in:
Piotr Podusowski 2025-02-18 18:03:42 +01:00 committed by GitHub
parent b48c7a164b
commit 9dad7f827d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 1 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/egui/src/context.rs
View File

@ -2549,10 +2549,7 @@ impl Context {
self.input(|i| i.screen_rect()).round_ui() self.input(|i| i.screen_rect()).round_ui()
} }
/// How much space is still available after panels has been added. /// How much space is still available after panels have been added.
///
/// This is the "background" area, what egui doesn't cover with panels (but may cover with windows).
/// This is also the area to which windows are constrained.
pub fn available_rect(&self) -> Rect { pub fn available_rect(&self) -> Rect {
self.pass_state(|s| s.available_rect()).round_ui() self.pass_state(|s| s.available_rect()).round_ui()
} }

3
crates/egui/src/pass_state.rs
View File

@ -202,7 +202,6 @@ pub struct PassState {
/// Starts off as the `screen_rect`, shrinks as panels are added. /// Starts off as the `screen_rect`, shrinks as panels are added.
/// The [`crate::CentralPanel`] does not change this. /// The [`crate::CentralPanel`] does not change this.
/// This is the area available to Window's.
pub available_rect: Rect, pub available_rect: Rect,
/// Starts off as the `screen_rect`, shrinks as panels are added. /// Starts off as the `screen_rect`, shrinks as panels are added.
@ -303,8 +302,6 @@ impl PassState {
} }
/// How much space is still available after panels has been added. /// How much space is still available after panels has been added.
/// This is the "background" area, what egui doesn't cover with panels (but may cover with windows).
/// This is also the area to which windows are constrained.
pub(crate) fn available_rect(&self) -> Rect { pub(crate) fn available_rect(&self) -> Rect {
debug_assert!( debug_assert!(
self.available_rect.is_finite(), self.available_rect.is_finite(),