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

Typos and doc improvements

This commit is contained in:
Emil Ernerfeldt 2023-12-22 17:33:01 +01:00
parent 0561fcaba9
commit ffcc3f066c
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/ecolor/src/color32.rs
View File

@ -71,7 +71,7 @@ impl Color32 {
/// i.e. often taken to mean "no color". /// i.e. often taken to mean "no color".
pub const PLACEHOLDER: Color32 = Color32::from_rgba_premultiplied(64, 254, 0, 128); pub const PLACEHOLDER: Color32 = Color32::from_rgba_premultiplied(64, 254, 0, 128);
#[deprecated = "Renmaed to PLACEHOLDER"] #[deprecated = "Renamed to PLACEHOLDER"]
pub const TEMPORARY_COLOR: Color32 = Self::PLACEHOLDER; pub const TEMPORARY_COLOR: Color32 = Self::PLACEHOLDER;
#[inline] #[inline]

2
crates/eframe/src/epi.rs
View File

@ -581,7 +581,7 @@ impl std::str::FromStr for Renderer {
/// Represents the surroundings of your app. /// Represents the surroundings of your app.
/// ///
/// It provides methods to inspect the surroundings (are we on the web?), /// It provides methods to inspect the surroundings (are we on the web?),
/// allocate textures, and change settings (e.g. window size). /// access to persistent storage, and access to the rendering backend.
pub struct Frame { pub struct Frame {
/// Information about the integration. /// Information about the integration.
pub(crate) info: IntegrationInfo, pub(crate) info: IntegrationInfo,

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

@ -1191,11 +1191,13 @@ impl Context {
/// If this is called at least once in a frame, then there will be another frame right after this. /// If this is called at least once in a frame, then there will be another frame right after this.
/// Call as many times as you wish, only one repaint will be issued. /// Call as many times as you wish, only one repaint will be issued.
/// ///
/// To request repaint with a delay, use [`Self::request_repaint_after`].
///
/// If called from outside the UI thread, the UI thread will wake up and run, /// If called from outside the UI thread, the UI thread will wake up and run,
/// provided the egui integration has set that up via [`Self::set_request_repaint_callback`] /// provided the egui integration has set that up via [`Self::set_request_repaint_callback`]
/// (this will work on `eframe`). /// (this will work on `eframe`).
/// ///
/// This will repaint the current viewport /// This will repaint the current viewport.
pub fn request_repaint(&self) { pub fn request_repaint(&self) {
self.request_repaint_of(self.viewport_id()); self.request_repaint_of(self.viewport_id());
} }
@ -1205,11 +1207,13 @@ impl Context {
/// If this is called at least once in a frame, then there will be another frame right after this. /// If this is called at least once in a frame, then there will be another frame right after this.
/// Call as many times as you wish, only one repaint will be issued. /// Call as many times as you wish, only one repaint will be issued.
/// ///
/// To request repaint with a delay, use [`Self::request_repaint_after_for`].
///
/// If called from outside the UI thread, the UI thread will wake up and run, /// If called from outside the UI thread, the UI thread will wake up and run,
/// provided the egui integration has set that up via [`Self::set_request_repaint_callback`] /// provided the egui integration has set that up via [`Self::set_request_repaint_callback`]
/// (this will work on `eframe`). /// (this will work on `eframe`).
/// ///
/// This will repaint the specified viewport /// This will repaint the specified viewport.
pub fn request_repaint_of(&self, id: ViewportId) { pub fn request_repaint_of(&self, id: ViewportId) {
self.write(|ctx| ctx.request_repaint(id)); self.write(|ctx| ctx.request_repaint(id));
} }