Skip to content

Commit

Permalink
More words in doc of imgui::Condition
Browse files Browse the repository at this point in the history
Mainly to try and clarify difference between Once/FirstUseEver
  • Loading branch information
dbr committed Sep 25, 2021
1 parent cc7ffbe commit 7953c48
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions imgui/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -771,15 +771,20 @@ impl<'ui> Ui<'ui> {
pub enum Condition {
/// Never apply the setting
Never = -1,
/// Always apply the setting

/// Apply the setting every frame
Always = sys::ImGuiCond_Always as i8,
/// Apply the setting once per runtime session (only the first call will succeed)

/// Apply the setting once per runtime session (only the first
/// call will succeed). Will ignore any setting saved in `.ini`
Once = sys::ImGuiCond_Once as i8,
/// Apply the setting if the object/window has no persistently saved data (no entry in .ini
/// file)

/// Apply the setting if the object/window has no persistently
/// saved data (but otherwise use the setting from the .ini file)
FirstUseEver = sys::ImGuiCond_FirstUseEver as i8,
/// Apply the setting if the object/window is appearing after being hidden/inactive (or the
/// first time)

/// Apply the setting if the object/window is appearing after
/// being hidden/inactive (or the first time)
Appearing = sys::ImGuiCond_Appearing as i8,
}

Expand Down

0 comments on commit 7953c48

Please sign in to comment.