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

Document that CtxRef is generational and shouldn't be stored

Browse source 
Related to https://github.com/emilk/egui/issues/1005
This commit is contained in:
Emil Ernerfeldt 2021-12-28 10:05:10 +01:00
parent b7441eeee7
commit b88bec9ca3
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
egui/src/context.rs
View file

@ -26,6 +26,9 @@ use epaint::{stats::*, text::Fonts, *};
/// ///
/// [`CtxRef`] is cheap to clone, and any clones refers to the same mutable data. /// [`CtxRef`] is cheap to clone, and any clones refers to the same mutable data.
/// ///
/// A [`CtxRef`] is only valid for the duration of a frame, and so you should not store a [`CtxRef`] between frames.
/// A new [`CtxRef`] is created each frame by calling [`Self::run`].
///
/// # Example: /// # Example:
/// ///
/// ``` no_run /// ``` no_run
@ -49,7 +52,6 @@ use epaint::{stats::*, text::Fonts, *};
/// paint(clipped_meshes); /// paint(clipped_meshes);
/// } /// }
/// ``` /// ```
///
#[derive(Clone)] #[derive(Clone)]
pub struct CtxRef(std::sync::Arc<Context>); pub struct CtxRef(std::sync::Arc<Context>);
@ -325,16 +327,17 @@ impl CtxRef {
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/// This is the first thing you need when working with egui. Create using [`CtxRef`]. /// Your handle to egui.
/// ///
/// Contains the [`InputState`], [`Memory`], [`Output`], and more. /// This is the first thing you need when working with egui.
/// Use [`CtxRef`] to create and refer to a [`Context`].
/// ///
/// Your handle to Egui. /// Contains the [`InputState`], [`Memory`], [`Output`], and more.///
/// ///
/// Almost all methods are marked `&self`, `Context` has interior mutability (protected by mutexes). /// Almost all methods are marked `&self`, [`Context`] has interior mutability (protected by mutexes).
/// Multi-threaded access to a [`Context`] is behind the feature flag `multi_threaded`. /// Multi-threaded access to a [`Context`] is behind the feature flag `multi_threaded`.
/// Normally you'd always do all ui work on one thread, or perhaps use multiple contexts, /// Normally you'd always do all ui work on one thread, or perhaps use multiple contexts,
/// but if you really want to access the same Context from multiple threads, it *SHOULD* be fine, /// but if you really want to access the same [`Context`] from multiple threads, it *SHOULD* be fine,
/// but you are likely the first person to try it. /// but you are likely the first person to try it.
#[derive(Default)] #[derive(Default)]
pub struct Context { pub struct Context {
@ -343,7 +346,7 @@ pub struct Context {
// This means everything else needs to be behind an Arc. // This means everything else needs to be behind an Arc.
// We can probably come up with a nicer design. // We can probably come up with a nicer design.
// //
/// None until first call to `begin_frame`. /// `None` until the start of the first frame.
fonts: Option<Arc<Fonts>>, fonts: Option<Arc<Fonts>>,
memory: Arc<Mutex<Memory>>, memory: Arc<Mutex<Memory>>,
animation_manager: Arc<Mutex<AnimationManager>>, animation_manager: Arc<Mutex<AnimationManager>>,