[go: up one dir, main page]

egui 0.33.3

An easy-to-use immediate mode GUI that runs on both web and native
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

#[expect(unused_imports)]
use crate::{Ui, UiBuilder};
use std::sync::atomic::AtomicBool;

/// A tag to mark a container as closable.
///
/// Usually set via [`UiBuilder::closable`].
///
/// [`Ui::close`] will find the closest parent [`ClosableTag`] and set its `close` field to `true`.
/// Use [`Ui::should_close`] to check if close has been called.
#[derive(Debug, Default)]
pub struct ClosableTag {
    pub close: AtomicBool,
}

impl ClosableTag {
    pub const NAME: &'static str = "egui_close_tag";

    /// Set close to `true`
    pub fn set_close(&self) {
        self.close.store(true, std::sync::atomic::Ordering::Relaxed);
    }

    /// Returns `true` if [`ClosableTag::set_close`] has been called.
    pub fn should_close(&self) -> bool {
        self.close.load(std::sync::atomic::Ordering::Relaxed)
    }
}