WIP - Fonts: added RemoveCustomRect().

+ internally add ImFontAtlasPackReuseRectEntry()

Author: ocornut

imgui.h

@@ -3731,6 +3731,7 @@ struct ImFontAtlas
     //   - AddCustomRectFontGlyph() --> Prefer using custom ImFontLoader inside ImFontConfig
     //   - ImFontAtlasCustomRect    --> Renamed to ImFontAtlasRect
     IMGUI_API ImFontAtlasRectId AddCustomRect(int width, int height);                               // Register a rectangle. Return -1 (ImFontAtlasRectId_Invalid) on error.
+    IMGUI_API void              RemoveCustomRect(ImFontAtlasRectId id);                             // Unregister a rectangle. Existing pixels will stay in texture until resized / garbage collected.
     IMGUI_API bool              GetCustomRect(ImFontAtlasRectId id, ImFontAtlasRect* out_r) const;  // Get rectangle coordinates for current texture. Valid immediately, never store this (read above)!
 
     //-------------------------------------------

imgui_draw.cpp

@@ -2501,8 +2501,10 @@ void ImTextureData::DestroyPixels()
 // - ImFontAtlasBuildNotifySetFont()
 //-----------------------------------------------------------------------------
 // - ImFontAtlas::AddCustomRect()
-// - ImFontAtlas::AddCustomRectFontGlyph()
+// - ImFontAtlas::RemoveCustomRect()
 // - ImFontAtlas::GetCustomRect()
+// - ImFontAtlas::AddCustomRectFontGlyph() [legacy]
+// - ImFontAtlas::AddCustomRectFontGlyphForSize() [legacy]
 // - ImFontAtlasGetMouseCursorTexData()
 //-----------------------------------------------------------------------------
 // - ImFontAtlasBuildMain()
@@ -2540,6 +2542,7 @@ void ImTextureData::DestroyPixels()
 //-----------------------------------------------------------------------------
 // - ImFontAtlasPackInit()
 // - ImFontAtlasPackAllocRectEntry()
+// - ImFontAtlasPackReuseRectEntry()
 // - ImFontAtlasPackDiscardRect()
 // - ImFontAtlasPackAddRect()
 // - ImFontAtlasPackGetRect()
@@ -3242,6 +3245,12 @@ ImFontAtlasRectId ImFontAtlas::AddCustomRect(int width, int height)
     return r_id;
 }
 
+void ImFontAtlas::RemoveCustomRect(ImFontAtlasRectId id)
+{
+    IM_ASSERT(id != ImFontAtlasRectId_Invalid);
+    ImFontAtlasPackDiscardRect(this, id);
+}
+
 #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
 // This API does not make sense anymore with scalable fonts.
 // - Prefer adding a font source (ImFontConfig) using a custom/procedural loader.
@@ -4098,7 +4107,7 @@ ImVec2i ImFontAtlasBuildGetTextureSizeEstimate(ImFontAtlas* atlas)
     return ImVec2i(new_tex_w, new_tex_h);
 }
 
-// Clear all output. Invalidates all AddCustomRectXXX return values.
+// Clear all output. Invalidates all AddCustomRect() return values!
 void ImFontAtlasBuildClear(ImFontAtlas* atlas)
 {
     ImVec2i new_tex_size = ImFontAtlasBuildGetTextureSizeEstimate(atlas);
@@ -4240,6 +4249,13 @@ static ImFontAtlasRectId ImFontAtlasPackAllocRectEntry(ImFontAtlas* atlas, int r
     return (ImFontAtlasRectId)index_idx;
 }
 
+static ImFontAtlasRectId ImFontAtlasPackReuseRectEntry(ImFontAtlas* atlas, ImFontAtlasRectEntry* overwrite_entry)
+{
+    IM_ASSERT(overwrite_entry->Used);
+    overwrite_entry->TargetIndex = atlas->Builder->Rects.Size - 1;
+    return atlas->Builder->RectsIndex.index_from_ptr(overwrite_entry);
+}
+
 // This is expected to be called in batches and followed by a repack
 void ImFontAtlasPackDiscardRect(ImFontAtlas* atlas, ImFontAtlasRectId id)
 {
@@ -4303,16 +4319,9 @@ ImFontAtlasRectId ImFontAtlasPackAddRect(ImFontAtlas* atlas, int w, int h, ImFon
 
     builder->Rects.push_back(r);
     if (overwrite_entry != NULL)
-    {
-        // Write into an existing entry instead of adding one (used during repack)
-        IM_ASSERT(overwrite_entry->Used);
-        overwrite_entry->TargetIndex = builder->Rects.Size - 1;
-        return builder->RectsIndex.index_from_ptr(overwrite_entry);
-    }
+        return ImFontAtlasPackReuseRectEntry(atlas, overwrite_entry); // Write into an existing entry instead of adding one (used during repack)
     else
-    {
         return ImFontAtlasPackAllocRectEntry(atlas, builder->Rects.Size - 1);
-    }
 }
 
 // Important: don'return pointer valid until next call to AddRect(), e.g. FindGlyph(), CalcTextSize() can all potentially invalidate previous pointers.

imgui_internal.h

@@ -3988,8 +3988,8 @@ IMGUI_API const ImFontLoader* ImFontAtlasGetFontLoaderForStbTruetype();
 // Having this also makes it easier to e.g. sort rectangles during repack.
 struct ImFontAtlasRectEntry
 {
-    int             TargetIndex : 31; // When Used: ImFontAtlasRectId -> into Rects[]. When unused: index to next unused RectsIndex[] slot to consume free-list.
-    unsigned int    Used : 1;
+    int                 TargetIndex : 31;   // When Used: ImFontAtlasRectId -> into Rects[]. When unused: index to next unused RectsIndex[] slot to consume free-list.
+    unsigned int        Used : 1;
 };
 
 // Data available to potential texture post-processing functions