Skip to content

Commit 7863569

Browse files
committed
Switch to imgui_freetype for rendering text in Imgui dialogs
1 parent 3fd6844 commit 7863569

File tree

6 files changed

+850
-5226
lines changed

6 files changed

+850
-5226
lines changed

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ file(GLOB SRCS
128128
if(BACKEND_IMGUI)
129129
file(GLOB IMGUI_SRCS
130130
lib/imgui/*.cpp
131+
lib/imgui/misc/freetype/*.cpp
131132
src/ui/*.cc)
132133
list(APPEND SRCS ${IMGUI_SRCS})
133134
endif()

lib/imgui/copy.sh

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ cp ${IMGUI}/imconfig.h .
99
cp ${IMGUI}/imgui.{cpp,h} .
1010
cp ${IMGUI}/imgui_{demo,draw,tables,widgets}.cpp .
1111
cp ${IMGUI}/imgui_internal.h .
12-
cp ${IMGUI}/imstb_{rectpack,textedit,truetype}.h .
12+
cp ${IMGUI}/imstb_{rectpack,textedit}.h .
1313
cp ${IMGUI}/backends/imgui_impl_opengl3{.cpp,.h,_loader.h} .
1414
cp ${IMGUI}/misc/cpp/imgui_stdlib.{cpp,h} .
15+
16+
mkdir -p misc/freetype
17+
cp ${IMGUI}/misc/freetype/imgui_freetype.cpp misc/freetype/
18+
cp ${IMGUI}/misc/freetype/imgui_freetype.h misc/freetype/

lib/imgui/imconfig.h

Lines changed: 17 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,24 @@
1-
//-----------------------------------------------------------------------------
2-
// DEAR IMGUI COMPILE-TIME OPTIONS
3-
// Runtime options (clipboard callbacks, enabling various features, etc.) can generally be set via the ImGuiIO structure.
4-
// You can use ImGui::SetAllocatorFunctions() before calling ImGui::CreateContext() to rewire memory allocation functions.
5-
//-----------------------------------------------------------------------------
6-
// A) You may edit imconfig.h (and not overwrite it when updating Dear ImGui, or maintain a patch/rebased branch with your modifications to it)
7-
// B) or '#define IMGUI_USER_CONFIG "my_imgui_config.h"' in your project and then add directives in your own file without touching this template.
8-
//-----------------------------------------------------------------------------
9-
// You need to make sure that configuration settings are defined consistently _everywhere_ Dear ImGui is used, which include the imgui*.cpp
10-
// files but also _any_ of your code that uses Dear ImGui. This is because some compile-time options have an affect on data structures.
11-
// Defining those options in imconfig.h will ensure every compilation unit gets to see the same data structure layouts.
12-
// Call IMGUI_CHECKVERSION() from your .cpp file to verify that the data structures your files are using are matching the ones imgui.cpp is using.
13-
//-----------------------------------------------------------------------------
14-
1+
// This file has been customised for Principia. Reset the changes in this file when updating Imgui.
152
#pragma once
163

17-
//---- Define assertion handler. Defaults to calling assert().
18-
// - If your macro uses multiple statements, make sure is enclosed in a 'do { .. } while (0)' block so it can be used as a single statement.
19-
// - Compiling with NDEBUG will usually strip out assert() to nothing, which is NOT recommended because we use asserts to notify of programmer mistakes.
20-
//#define IM_ASSERT(_EXPR) MyAssert(_EXPR)
21-
//#define IM_ASSERT(_EXPR) ((void)(_EXPR)) // Disable asserts
22-
23-
//---- Define attributes of all API symbols declarations, e.g. for DLL under Windows
24-
// Using Dear ImGui via a shared library is not recommended, because of function call overhead and because we don't guarantee backward nor forward ABI compatibility.
25-
// - Windows DLL users: heaps and globals are not shared across DLL boundaries! You will need to call SetCurrentContext() + SetAllocatorFunctions()
26-
// for each static/DLL boundary you are calling from. Read "Context and Memory Allocators" section of imgui.cpp for more details.
27-
//#define IMGUI_API __declspec(dllexport) // MSVC Windows: DLL export
28-
//#define IMGUI_API __declspec(dllimport) // MSVC Windows: DLL import
29-
//#define IMGUI_API __attribute__((visibility("default"))) // GCC/Clang: override visibility when set is hidden
30-
31-
//---- Don't define obsolete functions/enums/behaviors. Consider enabling from time to time after updating to clean your code of obsolete function/names.
4+
// TODO: uncomment this when we're good
325
//#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
336

34-
//---- Disable all of Dear ImGui or don't implement standard windows/tools.
35-
// It is very strongly recommended to NOT disable the demo windows and debug tool during development. They are extremely useful in day to day work. Please read comments in imgui_demo.cpp.
36-
//#define IMGUI_DISABLE // Disable everything: all headers and source files will be empty.
37-
//#define IMGUI_DISABLE_DEMO_WINDOWS // Disable demo windows: ShowDemoWindow()/ShowStyleEditor() will be empty.
38-
//#define IMGUI_DISABLE_DEBUG_TOOLS // Disable metrics/debugger and other debug tools: ShowMetricsWindow(), ShowDebugLogWindow() and ShowIDStackToolWindow() will be empty.
39-
40-
//---- Don't implement some functions to reduce linkage requirements.
41-
//#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc. (user32.lib/.a, kernel32.lib/.a)
42-
//#define IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with Visual Studio] Implement default IME handler (require imm32.lib/.a, auto-link for Visual Studio, -limm32 on command-line for MinGW)
43-
//#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with non-Visual Studio compilers] Don't implement default IME handler (won't require imm32.lib/.a)
44-
//#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, IME).
45-
//#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS // [OSX] Implement default OSX clipboard handler (need to link with '-framework ApplicationServices', this is why this is not the default).
46-
//#define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS // Don't implement default platform_io.Platform_OpenInShellFn() handler (Win32: ShellExecute(), require shell32.lib/.a, Mac/Linux: use system("")).
47-
//#define IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS // Don't implement ImFormatString/ImFormatStringV so you can implement them yourself (e.g. if you don't want to link with vsnprintf)
48-
//#define IMGUI_DISABLE_DEFAULT_MATH_FUNCTIONS // Don't implement ImFabs/ImSqrt/ImPow/ImFmod/ImCos/ImSin/ImAcos/ImAtan2 so you can implement them yourself.
49-
//#define IMGUI_DISABLE_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle at all (replace them with dummies)
50-
//#define IMGUI_DISABLE_DEFAULT_FILE_FUNCTIONS // Don't implement ImFileOpen/ImFileClose/ImFileRead/ImFileWrite and ImFileHandle so you can implement them yourself if you don't want to link with fopen/fclose/fread/fwrite. This will also disable the LogToTTY() function.
51-
//#define IMGUI_DISABLE_DEFAULT_ALLOCATORS // Don't implement default allocators calling malloc()/free() to avoid linking with them. You will need to call ImGui::SetAllocatorFunctions().
52-
//#define IMGUI_DISABLE_DEFAULT_FONT // Disable default embedded fonts (ProggyClean/ProggyVector), remove ~9 KB + ~17 KB from output binary. AddFontDefaultXXX() functions will assert.
53-
//#define IMGUI_DISABLE_SSE // Disable use of SSE intrinsics even if available
54-
55-
//---- Enable Test Engine / Automation features.
56-
//#define IMGUI_ENABLE_TEST_ENGINE // Enable imgui_test_engine hooks. Generally set automatically by include "imgui_te_config.h", see Test Engine for details.
57-
58-
//---- Include imgui_user.h at the end of imgui.h as a convenience
59-
// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
60-
//#define IMGUI_INCLUDE_IMGUI_USER_H
61-
//#define IMGUI_USER_H_FILENAME "my_folder/my_imgui_user.h"
62-
63-
//---- Pack vertex colors as BGRA8 instead of RGBA8 (to avoid converting from one to another). Need dedicated backend support.
64-
//#define IMGUI_USE_BGRA_PACKED_COLOR
65-
66-
//---- Use legacy CRC32-adler tables (used before 1.91.6), in order to preserve old .ini data that you cannot afford to invalidate.
67-
//#define IMGUI_USE_LEGACY_CRC32_ADLER
68-
69-
//---- Use 32-bit for ImWchar (default is 16-bit) to support Unicode planes 1-16. (e.g. point beyond 0xFFFF like emoticons, dingbats, symbols, shapes, ancient languages, etc...)
70-
//#define IMGUI_USE_WCHAR32
71-
72-
//---- Avoid multiple STB libraries implementations, or redefine path/filenames to prioritize another version
73-
// By default the embedded implementations are declared static and not available outside of Dear ImGui sources files.
74-
//#define IMGUI_STB_TRUETYPE_FILENAME "my_folder/stb_truetype.h"
75-
//#define IMGUI_STB_RECT_PACK_FILENAME "my_folder/stb_rect_pack.h"
76-
//#define IMGUI_STB_SPRINTF_FILENAME "my_folder/stb_sprintf.h" // only used if IMGUI_USE_STB_SPRINTF is defined.
77-
//#define IMGUI_DISABLE_STB_TRUETYPE_IMPLEMENTATION
78-
//#define IMGUI_DISABLE_STB_RECT_PACK_IMPLEMENTATION
79-
//#define IMGUI_DISABLE_STB_SPRINTF_IMPLEMENTATION // only disabled if IMGUI_USE_STB_SPRINTF is defined.
80-
81-
//---- Use stb_sprintf.h for a faster implementation of vsnprintf instead of the one from libc (unless IMGUI_DISABLE_DEFAULT_FORMAT_FUNCTIONS is defined)
82-
// Compatibility checks of arguments and formats done by clang and GCC will be disabled in order to support the extra formats provided by stb_sprintf.h.
83-
//#define IMGUI_USE_STB_SPRINTF
84-
85-
//---- Use FreeType to build and rasterize the font atlas (instead of stb_truetype which is embedded by default in Dear ImGui)
86-
// Requires FreeType headers to be available in the include path. Requires program to be compiled with 'misc/freetype/imgui_freetype.cpp' (in this repository) + the FreeType library (not provided).
87-
// Note that imgui_freetype.cpp may be used _without_ this define, if you manually call ImFontAtlas::SetFontLoader(). The define is simply a convenience.
88-
// On Windows you may use vcpkg with 'vcpkg install freetype --triplet=x64-windows' + 'vcpkg integrate install'.
89-
//#define IMGUI_ENABLE_FREETYPE
90-
91-
//---- Use FreeType + plutosvg or lunasvg to render OpenType SVG fonts (SVGinOT)
92-
// Only works in combination with IMGUI_ENABLE_FREETYPE.
93-
// - plutosvg is currently easier to install, as e.g. it is part of vcpkg. It will support more fonts and may load them faster. See misc/freetype/README for instructions.
94-
// - Both require headers to be available in the include path + program to be linked with the library code (not provided).
95-
// - (note: lunasvg implementation is based on Freetype's rsvg-port.c which is licensed under CeCILL-C Free Software License Agreement)
96-
//#define IMGUI_ENABLE_FREETYPE_PLUTOSVG
97-
//#define IMGUI_ENABLE_FREETYPE_LUNASVG
98-
99-
//---- Use stb_truetype to build and rasterize the font atlas (default)
100-
// The only purpose of this define is if you want force compilation of the stb_truetype backend ALONG with the FreeType backend.
101-
//#define IMGUI_ENABLE_STB_TRUETYPE
102-
103-
//---- Define constructor and implicit cast operators to convert back<>forth between your math types and ImVec2/ImVec4.
104-
// This will be inlined as part of ImVec2 and ImVec4 class declarations.
105-
/*
106-
#define IM_VEC2_CLASS_EXTRA \
107-
constexpr ImVec2(const MyVec2& f) : x(f.x), y(f.y) {} \
108-
operator MyVec2() const { return MyVec2(x,y); }
109-
110-
#define IM_VEC4_CLASS_EXTRA \
111-
constexpr ImVec4(const MyVec4& f) : x(f.x), y(f.y), z(f.z), w(f.w) {} \
112-
operator MyVec4() const { return MyVec4(x,y,z,w); }
113-
*/
114-
//---- ...Or use Dear ImGui's own very basic math operators.
115-
//#define IMGUI_DEFINE_MATH_OPERATORS
116-
117-
//---- Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices.
118-
// Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices).
119-
// Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer.
120-
// Read about ImGuiBackendFlags_RendererHasVtxOffset for details.
121-
//#define ImDrawIdx unsigned int
122-
123-
//---- Override ImDrawCallback signature (will need to modify renderer backends accordingly)
124-
//struct ImDrawList;
125-
//struct ImDrawCmd;
126-
//typedef void (*MyImDrawCallback)(const ImDrawList* draw_list, const ImDrawCmd* cmd, void* my_renderer_user_data);
127-
//#define ImDrawCallback MyImDrawCallback
128-
129-
//---- Debug Tools: Macro to break in Debugger (we provide a default implementation of this in the codebase)
130-
// (use 'Metrics->Tools->Item Picker' to pick widgets with the mouse and break into them for easy debugging.)
131-
//#define IM_DEBUG_BREAK IM_ASSERT(0)
132-
//#define IM_DEBUG_BREAK __debugbreak()
7+
#ifndef DEBUG
8+
#define IMGUI_DISABLE_DEMO_WINDOWS
9+
#define IMGUI_DISABLE_DEBUG_TOOLS
10+
#endif
13311

134-
//---- Debug Tools: Enable highlight ID conflicts _before_ hovering items. When io.ConfigDebugHighlightIdConflicts is set.
135-
// (THIS WILL SLOW DOWN DEAR IMGUI. Only use occasionally and disable after use)
136-
//#define IMGUI_DEBUG_HIGHLIGHT_ALL_ID_CONFLICTS
12+
// This stuff is provided by SDL
13+
#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCTIONS // [Win32] Don't implement default clipboard handler. Won't use and link with OpenClipboard/GetClipboardData/CloseClipboard etc. (user32.lib/.a, kernel32.lib/.a)
14+
#define IMGUI_ENABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with Visual Studio] Implement default IME handler (require imm32.lib/.a, auto-link for Visual Studio, -limm32 on command-line for MinGW)
15+
#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS // [Win32] [Default with non-Visual Studio compilers] Don't implement default IME handler (won't require imm32.lib/.a)
16+
#define IMGUI_DISABLE_WIN32_FUNCTIONS // [Win32] Won't use and link with any Win32 function (clipboard, IME).
17+
#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS // [OSX] Implement default OSX clipboard handler (need to link with '-framework ApplicationServices', this is why this is not the default).
18+
#define IMGUI_DISABLE_DEFAULT_SHELL_FUNCTIONS // Don't implement default platform_io.Platform_OpenInShellFn() handler (Win32: ShellExecute(), require shell32.lib/.a, Mac/Linux: use system("")).
13719

138-
//---- Debug Tools: Enable slower asserts
139-
//#define IMGUI_DEBUG_PARANOID
20+
// We use freetype with a custom font
21+
#define IMGUI_DISABLE_DEFAULT_FONT
14022

141-
//---- Tip: You can add extra functions within the ImGui:: namespace from anywhere (e.g. your own sources/header files)
142-
/*
143-
namespace ImGui
144-
{
145-
void MyFunction(const char* name, MyMatrix44* mtx);
146-
}
147-
*/
23+
// Use imgui_freetype for font rendering
24+
#define IMGUI_ENABLE_FREETYPE

0 commit comments

Comments
 (0)