Skip to content

Commit

Permalink
Clarified eframe::run_simple_native() persistence (#4846)
Browse files Browse the repository at this point in the history
* [x] I have followed the instructions in the PR template

Clarified that `eframe::run_simple_native()` does in fact save some
state (if persistence is enabled) but does not allow user to save state.
  • Loading branch information
tpstevens authored Jul 30, 2024
1 parent 057033e commit 7736192
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion crates/eframe/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,9 @@ pub fn run_native(

/// The simplest way to get started when writing a native app.
///
/// This does NOT support persistence. For that you need to use [`run_native`].
/// This does NOT support persistence of custom user data. For that you need to use [`run_native`].
/// However, it DOES support persistence of egui data (window positions and sizes, how far the user has scrolled in a
/// [`ScrollArea`](egui::ScrollArea), etc.) if the persistence feature is enabled.
///
/// # Example
/// ``` no_run
Expand Down

0 comments on commit 7736192

Please sign in to comment.