Added asserts to catch illegal modifications of the font atlas between NewFrame() and EndFrame()/Render(). (#1958)
diff --git a/imgui.cpp b/imgui.cpp
index 564708e..2e140e4 100644
--- a/imgui.cpp
+++ b/imgui.cpp
@@ -3810,6 +3810,7 @@
g.WindowsActiveCount = 0;
// Setup current font and draw list
+ g.IO.Fonts->Locked = true;
SetCurrentFont(GetDefaultFont());
IM_ASSERT(g.Font->IsLoaded());
g.DrawListSharedData.ClipRectFullscreen = ImVec4(0.0f, 0.0f, g.IO.DisplaySize.x, g.IO.DisplaySize.y);
@@ -4451,6 +4452,9 @@
IM_ASSERT(g.Windows.Size == g.WindowsSortBuffer.Size); // we done something wrong
g.Windows.swap(g.WindowsSortBuffer);
+ // Unlock font atlas
+ g.IO.Fonts->Locked = false;
+
// Clear Input data for next frame
g.IO.MouseWheel = g.IO.MouseWheelH = 0.0f;
memset(g.IO.InputCharacters, 0, sizeof(g.IO.InputCharacters));
diff --git a/imgui.h b/imgui.h
index f861fb3..0b963c1 100644
--- a/imgui.h
+++ b/imgui.h
@@ -1852,6 +1852,7 @@
// Members
//-------------------------------------------
+ bool Locked; // Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
ImFontAtlasFlags Flags; // Build flags (see ImFontAtlasFlags_)
ImTextureID TexID; // User data to refer to the texture once it has been uploaded to user's graphic systems. It is passed back to you during rendering via the ImDrawCmd structure.
int TexDesiredWidth; // Texture width desired by user before Build(). Must be a power-of-two. If have many glyphs your graphics API have texture size restrictions you may want to increase texture width to decrease height.
diff --git a/imgui_draw.cpp b/imgui_draw.cpp
index 0f69a82..bf5558d 100644
--- a/imgui_draw.cpp
+++ b/imgui_draw.cpp
@@ -1378,6 +1378,7 @@
ImFontAtlas::ImFontAtlas()
{
+ Locked = false;
Flags = 0x00;
TexID = NULL;
TexDesiredWidth = 0;
@@ -1394,11 +1395,13 @@
ImFontAtlas::~ImFontAtlas()
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
Clear();
}
void ImFontAtlas::ClearInputData()
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
for (int i = 0; i < ConfigData.Size; i++)
if (ConfigData[i].FontData && ConfigData[i].FontDataOwnedByAtlas)
{
@@ -1421,6 +1424,7 @@
void ImFontAtlas::ClearTexData()
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
if (TexPixelsAlpha8)
ImGui::MemFree(TexPixelsAlpha8);
if (TexPixelsRGBA32)
@@ -1431,6 +1435,7 @@
void ImFontAtlas::ClearFonts()
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
for (int i = 0; i < Fonts.Size; i++)
IM_DELETE(Fonts[i]);
Fonts.clear();
@@ -1485,6 +1490,7 @@
ImFont* ImFontAtlas::AddFont(const ImFontConfig* font_cfg)
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
IM_ASSERT(font_cfg->FontData != NULL && font_cfg->FontDataSize > 0);
IM_ASSERT(font_cfg->SizePixels > 0.0f);
@@ -1546,6 +1552,7 @@
ImFont* ImFontAtlas::AddFontFromFileTTF(const char* filename, float size_pixels, const ImFontConfig* font_cfg_template, const ImWchar* glyph_ranges)
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
size_t data_size = 0;
void* data = ImFileLoadToMemory(filename, "rb", &data_size, 0);
if (!data)
@@ -1567,6 +1574,7 @@
// NB: Transfer ownership of 'ttf_data' to ImFontAtlas, unless font_cfg_template->FontDataOwnedByAtlas == false. Owned TTF buffer will be deleted after Build().
ImFont* ImFontAtlas::AddFontFromMemoryTTF(void* ttf_data, int ttf_size, float size_pixels, const ImFontConfig* font_cfg_template, const ImWchar* glyph_ranges)
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
ImFontConfig font_cfg = font_cfg_template ? *font_cfg_template : ImFontConfig();
IM_ASSERT(font_cfg.FontData == NULL);
font_cfg.FontData = ttf_data;
@@ -1660,6 +1668,7 @@
bool ImFontAtlas::Build()
{
+ IM_ASSERT(!Locked && "Cannot modify a locked ImFontAtlas between NewFrame() and EndFrame/Render()!");
return ImFontAtlasBuildWithStbTruetype(this);
}
