imgui-inspect 0.7.1

Traits and default implementations for inspecting values with imgui.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

mod default_bool;
mod default_f32;
mod default_option;
mod default_u32;
mod default_usize;
mod default_string;

pub use super::*;

/// Options for using the default rendering style for the element. The options here are a superset
/// of all other options since "default" could be any of the widgets
///
/// So, not all elements will necessarily be used/respected. Use the non-default traits for typesafe
/// changes.
///
/// Marking a struct element with something like `#[inspect(min_value = 5.0, max_value = 53.0)]`
/// will make the widget for that member default to those values.
#[derive(Debug, Default, Clone)]
pub struct InspectArgsDefault {
    /// If true, the struct will have a visual/expandable header added to it. This defaults to true.
    ///
    /// To customize this, disable this header programmatically by passing your own
    /// InspectArgsDefault into `render` or `render_mut`
    pub header: Option<bool>,

    /// If true, any child elements (i.e. struct members) will be indented. This defaults to true.
    pub indent_children: Option<bool>,

    /// Minimum value for the widget. The precise meaning of this can vary depending on the widget type
    pub min_value: Option<f32>,

    /// Maximum value for the widget. The precise meaning of this can vary depending on the widget type
    pub max_value: Option<f32>,

    /// Minimum value for the widget. The precise meaning of this can vary depending on the widget type
    pub step: Option<f32>,
}

/// Renders a value using the default widget
pub trait InspectRenderDefault<T> {
    /// Render the element in an immutable way (i.e. static text)
    ///
    /// (Hopefully in the future this can be better. See
    /// https://github.com/ocornut/imgui/issues/211)
    fn render(
        data: &[&T],
        label: &'static str,
        ui: &imgui::Ui,
        args: &InspectArgsDefault,
    );

    /// Render the element in a mutable way. Using this trait, the default widget to use is based
    /// on the type.
    fn render_mut(
        data: &mut [&mut T],
        label: &'static str,
        ui: &imgui::Ui,
        args: &InspectArgsDefault,
    ) -> bool;
}