dear-imgui-rs 0.17.0

High-level Rust bindings to Dear ImGui v1.92.9b with docking, WGPU/GL backends, and extensions (ImPlot/ImPlot3D, ImNodes, ImGuizmo, file browser, reflection-based UI)
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
61
62
63

use crate::fonts::FontId;
use crate::fonts::atlas::id::validate_font_id_for_atlas;
use crate::fonts::atlas::state::{
    bump_custom_rect_generation, bump_font_atlas_generation, reset_font_atlas_mode_after_full_clear,
};
use crate::sys;

use super::FontAtlas;

impl FontAtlas {
    /// Remove a font from the atlas.
    ///
    /// Existing [`FontId`] handles from this atlas are invalidated.
    #[doc(alias = "RemoveFont")]
    pub fn remove_font(&self, font: FontId) {
        self.assert_mutation_allowed("FontAtlas::remove_font()");
        let raw = self.raw();
        let font = validate_font_id_for_atlas(font, raw, "FontAtlas::remove_font()");
        unsafe { sys::ImFontAtlas_RemoveFont(raw, font) }
        bump_font_atlas_generation(raw);
    }

    /// Clear all fonts and texture data.
    ///
    /// Existing [`FontId`] handles from this atlas are invalidated.
    /// A legacy renderer claim is released only when no [`LegacyFontAtlas`](crate::LegacyFontAtlas)
    /// capability remains alive. Drop every legacy capability before calling this method when
    /// preparing the atlas for a managed renderer.
    #[doc(alias = "Clear")]
    pub fn clear(&self) {
        self.assert_mutation_allowed("FontAtlas::clear()");
        let raw = self.raw();
        unsafe { sys::ImFontAtlas_Clear(raw) }
        bump_font_atlas_generation(raw);
        bump_custom_rect_generation(raw);
        reset_font_atlas_mode_after_full_clear(raw);
    }

    /// Clear only the fonts (keep texture data).
    ///
    /// Existing [`FontId`] handles from this atlas are invalidated.
    #[doc(alias = "ClearFonts")]
    pub fn clear_fonts(&self) {
        self.assert_mutation_allowed("FontAtlas::clear_fonts()");
        let raw = self.raw();
        unsafe { sys::ImFontAtlas_ClearFonts(raw) }
        bump_font_atlas_generation(raw);
        bump_custom_rect_generation(raw);
    }
}

impl crate::fonts::atlas::LegacyFontAtlas<'_> {
    /// Clear only the CPU atlas texture data while keeping font sources.
    ///
    /// This does not release any renderer-owned GPU texture. The legacy renderer remains
    /// responsible for retiring that resource after its last use.
    #[doc(alias = "ClearTexData")]
    pub fn clear_cpu_texture_data(&self) {
        self.atlas
            .assert_mutation_allowed("LegacyFontAtlas::clear_cpu_texture_data()");
        unsafe { sys::ImFontAtlas_ClearTexData(self.atlas.raw()) }
    }
}