dear-imgui-rs 0.16.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
64
65
66
67
68
69
70
71
72

use crate::fonts::atlas::LegacyFontAtlas;
use crate::fonts::atlas::state::bump_custom_rect_generation;
use crate::fonts::atlas::validation::frame_count_to_i32;
use crate::sys;

use super::FontAtlas;

impl LegacyFontAtlas<'_> {
    /// Build the legacy font atlas texture.
    ///
    /// This is the complete build entry point for legacy renderers. Managed renderers build and
    /// upload the atlas through texture requests owned by their renderer consumer instead.
    #[doc(alias = "Build")]
    pub fn build(&self) {
        self.atlas
            .assert_mutation_allowed("LegacyFontAtlas::build()");
        let raw = self.atlas.raw();
        // NOTE: In Dear ImGui, `ImFontAtlasBuildMain()` will call `ImFontAtlasBuildInit()`
        // lazily if needed (Builder == NULL). Calling BuildInit unconditionally would leak
        // the builder and is not idempotent.
        unsafe {
            let rebuilds_builder =
                !(*raw).TexData.is_null() && (*(*raw).TexData).Format != (*raw).TexDesiredFormat;
            sys::igImFontAtlasBuildMain(raw);
            if rebuilds_builder {
                bump_custom_rect_generation(raw);
            }
        }
    }
}

impl FontAtlas {
    /// Discard baked font caches.
    ///
    /// This clears cached glyph data (including cached "not found" entries) so that
    /// newly added font sources (e.g. merged CJK/emoji fonts) can take effect.
    ///
    /// Pass `unused_frames = 0` to discard everything (recommended after font merging).
    ///
    /// Notes:
    /// - Only call this when the atlas is not locked (typically before `Context::frame()`).
    /// - No-op if the atlas builder hasn't been created yet.
    #[doc(alias = "ImFontAtlasBuildDiscardBakes")]
    pub fn discard_bakes(&self, unused_frames: usize) {
        self.assert_mutation_allowed("FontAtlas::discard_bakes()");
        let raw = self.raw();
        let unused_frames =
            frame_count_to_i32("FontAtlas::discard_bakes()", "unused_frames", unused_frames);
        unsafe {
            if (*raw).Builder.is_null() {
                return;
            }
            sys::igImFontAtlasBuildDiscardBakes(raw, unused_frames);
        }
    }

    /// Compact cached glyphs and the current atlas texture.
    ///
    /// This is a no-op before the atlas builder and texture have been created.
    /// It must not be called while the atlas is locked by a frame.
    #[doc(alias = "CompactCache")]
    pub fn compact_cache(&self) {
        self.assert_mutation_allowed("FontAtlas::compact_cache()");
        let raw = self.raw();
        unsafe {
            if (*raw).Builder.is_null() || (*raw).TexData.is_null() {
                return;
            }
            sys::ImFontAtlas_CompactCache(raw);
        }
    }
}