moonpower/imgui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(Breaking) Fonts: rename GetCustomRectByIndex() to GetCustomRect(). Made return struct const.

Browse Source
This commit is contained in:
ocornut
2025-06-11 15:52:12 +02:00
parent 85d0507580
commit f816b861fc
4 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
imgui.h
+14 -14
View File
@@ -3574,24 +3574,24 @@ struct ImFontAtlas
// [ALPHA] Custom Rectangles/Glyphs API
//-------------------------------------------
// You can request arbitrary rectangles to be packed into the atlas, for your own purpose.
// You can request your rectangles to be mapped as font glyph (given a font + Unicode point),
// so you can render e.g. custom colorful icons and use them as regular glyphs.
// - Since 1.92.X, packing is done immediately in the function call. Returns -1 on error.
// Register and retrieve custom rectangles
// - You can request arbitrary rectangles to be packed into the atlas, for your own purpose.
// - You can request your rectangles to be mapped as font glyph (given a font + Unicode point),
// so you can render e.g. custom colorful icons and use them as regular glyphs.
// - Since 1.92.X, packing is done immediately in the function call.
// - You can render your pixels into the texture right after calling the AddCustomRectXXX() functions.
// - If your backend supports ImGuiBackendFlags_RendererHasTextures:
// Texture may be resized, so you cannot cache UV coordinates: always use CalcCustomRectUV().
// - If you render colored output into your AddCustomRectRegular() rectangle: set 'atlas->TexPixelsUseColors = true'
// as this may help some backends decide of preferred texture format.
// - Texture may be resized, so you cannot cache UV coordinates: always use CalcCustomRectUV()!
// - If you render colored output into your AddCustomRectRegular() rectangle: set 'atlas->TexPixelsUseColors = true' as this may help some backends decide of preferred texture format.
// - Read docs/FONTS.md for more details about using colorful icons.
// - Note: this API may be redesigned later in order to support multi-monitor varying DPI settings.
IMGUI_API int AddCustomRectRegular(int width, int height);
// - Note: this API may be reworked further in order to facilitate supporting e.g. multi-monitor, varying DPI settings.
IMGUI_API int AddCustomRectRegular(int width, int height); // Register a rectangle. Return -1 on error.
IMGUI_API const ImTextureRect* GetCustomRect(int id); // Get rectangle coordinate in current texture.
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
IMGUI_API int AddCustomRectFontGlyph(ImFont* font, ImWchar codepoint, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
IMGUI_API int AddCustomRectFontGlyphForSize(ImFont* font, float font_size, ImWchar codepoint, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
IMGUI_API int AddCustomRectFontGlyph(ImFont* font, ImWchar codepoint, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
IMGUI_API int AddCustomRectFontGlyphForSize(ImFont* font, float font_size, ImWchar codepoint, int width, int height, float advance_x, const ImVec2& offset = ImVec2(0, 0));
inline const ImTextureRect* GetCustomRectByIndex(int id) { return GetCustomRect(id); }
#endif
IMGUI_API ImTextureRect* GetCustomRectByIndex(int index);
IMGUI_API void CalcCustomRectUV(const ImTextureRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const;
IMGUI_API void CalcCustomRectUV(const ImTextureRect* rect, ImVec2* out_uv_min, ImVec2* out_uv_max) const;
//-------------------------------------------
// Members