Struct DebugOptions

pub struct DebugOptions {
    pub debug_on_hover: bool,
    pub debug_on_hover_with_all_modifiers: bool,
    pub hover_shows_next: bool,
    pub show_expand_width: bool,
    pub show_expand_height: bool,
    pub show_resize: bool,
    pub show_interactive_widgets: bool,
    pub show_widget_hits: bool,
    pub show_unaligned: bool,
}

Options for help debug egui by adding extra visualization

Fields

debug_on_hover: bool

Always show callstack to ui on hover.

Useful for figuring out where in the code some UI is being created.

Only works in debug builds. Requires the callstack feature. Does not work on web.

debug_on_hover_with_all_modifiers: bool

Show callstack for the current widget on hover if all modifier keys are pressed down.

Useful for figuring out where in the code some UI is being created.

Only works in debug builds. Requires the callstack feature. Does not work on web.

Default is true in debug builds, on native, if the callstack feature is enabled.

hover_shows_next: bool

If we show the hover ui, include where the next widget is placed.

show_expand_width: bool

Show which widgets make their parent wider

show_expand_height: bool

Show which widgets make their parent higher

show_resize: bool

show_interactive_widgets: bool

Show an overlay on all interactive widgets.

show_widget_hits: bool

Show interesting widgets under the mouse cursor.

show_unaligned: bool

If true, highlight widgets that are not aligned to integer point coordinates.

It’s usually a good idea to keep to integer coordinates to avoid rounding issues.

See https://github.com/emilk/egui/issues/5163 for more.

Implementations

impl DebugOptions

pub fn ui(&mut self, ui: &mut Ui)

Trait Implementations

impl Clone for DebugOptions

fn clone(&self) -> DebugOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DebugOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DebugOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DebugOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DebugOptions

fn eq(&self, other: &DebugOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DebugOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DebugOptions

impl Eq for DebugOptions

impl StructuralPartialEq for DebugOptions