djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove references to the old begin_frame

Browse source
This commit is contained in:
Emil Ernerfeldt 2021-11-03 23:00:00 +01:00
parent 6d33beabb1
commit 0ab93576da
2 changed files with 8 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
egui/src/context.rs
View file

@ -97,31 +97,19 @@ impl CtxRef {
/// ///
/// This will modify the internal reference to point to a new generation of [`Context`]. /// This will modify the internal reference to point to a new generation of [`Context`].
/// Any old clones of this [`CtxRef`] will refer to the old [`Context`], which will not get new input. /// Any old clones of this [`CtxRef`] will refer to the old [`Context`], which will not get new input.
///
/// This is a convenience for calling [`Self::begin_frame`] and [`Context::end_frame`]
#[must_use] #[must_use]
pub fn run( pub fn run(
&mut self, &mut self,
new_input: RawInput, new_input: RawInput,
run_ui: impl FnOnce(&CtxRef), run_ui: impl FnOnce(&CtxRef),
) -> (Output, Vec<ClippedShape>) { ) -> (Output, Vec<ClippedShape>) {
self.begin_frame(new_input);
run_ui(self);
self.end_frame()
}
/// Alternative to [`Self::run`].
///
/// Call at the start of every frame. Match with a call to [`Context::end_frame`].
///
/// This will modify the internal reference to point to a new generation of [`Context`].
/// Any old clones of this [`CtxRef`] will refer to the old [`Context`], which will not get new input.
///
/// Put your widgets into a [`SidePanel`], [`TopBottomPanel`], [`CentralPanel`], [`Window`] or [`Area`].
fn begin_frame(&mut self, new_input: RawInput) {
let mut self_: Context = (*self.0).clone(); let mut self_: Context = (*self.0).clone();
self_.begin_frame_mut(new_input); self_.begin_frame_mut(new_input);
*self = Self(Arc::new(self_)); *self = Self(Arc::new(self_));
run_ui(self);
self.end_frame()
} }
// --------------------------------------------------------------------- // ---------------------------------------------------------------------
@ -438,17 +426,17 @@ impl Context {
&self.input &self.input
} }
/// Not valid until first call to [`CtxRef::begin_frame()`]. /// Not valid until first call to [`CtxRef::run()`].
/// That's because since we don't know the proper `pixels_per_point` until then. /// That's because since we don't know the proper `pixels_per_point` until then.
pub fn fonts(&self) -> &Fonts { pub fn fonts(&self) -> &Fonts {
&*self &*self
.fonts .fonts
.as_ref() .as_ref()
.expect("No fonts available until first call to CtxRef::begin_frame()") .expect("No fonts available until first call to CtxRef::run()")
} }
/// The egui texture, containing font characters etc. /// The egui texture, containing font characters etc.
/// Not valid until first call to [`CtxRef::begin_frame()`]. /// Not valid until first call to [`CtxRef::run()`].
/// That's because since we don't know the proper `pixels_per_point` until then. /// That's because since we don't know the proper `pixels_per_point` until then.
pub fn texture(&self) -> Arc<epaint::Texture> { pub fn texture(&self) -> Arc<epaint::Texture> {
self.fonts().texture() self.fonts().texture()

2
egui/src/frame_state.rs
View file

@ -72,7 +72,7 @@ impl FrameState {
pub(crate) fn available_rect(&self) -> Rect { pub(crate) fn available_rect(&self) -> Rect {
crate::egui_assert!( crate::egui_assert!(
self.available_rect.is_finite(), self.available_rect.is_finite(),
"Called `available_rect()` before `CtxRef::begin_frame()`" "Called `available_rect()` before `CtxRef::run()`"
); );
self.available_rect self.available_rect
} }