From 46fbff50cf367c6d5708cd66b18bf3a6c867dd4f Mon Sep 17 00:00:00 2001 From: ocornut Date: Sun, 18 Jan 2015 12:19:49 +0000 Subject: [PATCH] Documentation --- extra_fonts/README.txt | 59 ++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 23 deletions(-) diff --git a/extra_fonts/README.txt b/extra_fonts/README.txt index 1e69d08e..ed600ff3 100644 --- a/extra_fonts/README.txt +++ b/extra_fonts/README.txt @@ -1,42 +1,55 @@ + The code in imgui.cpp embeds a copy of 'ProggyClean.ttf' that you can use without any external files. + --------------------------------- EXTRA FONTS FOR IMGUI --------------------------------- ProggyClean.ttf - Copyright (c) 2004, 2005 Tristan Grimmer - MIT License + Copyright (c) 2004, 2005 Tristan Grimmer + MIT License + recommended loading setting in ImGui: Size = 13.0, DisplayOffset.Y = +1 ProggyTiny.ttf - Copyright (c) 2004, 2005 Tristan Grimmer - MIT License + Copyright (c) 2004, 2005 Tristan Grimmer + MIT License + recommended loading setting in ImGui: Size = 10.0, DisplayOffset.Y = +1 Karla-Regular - Copyright (c) 2012, Jonathan Pinhorn - SIL OPEN FONT LICENSE Version 1.1 + Copyright (c) 2012, Jonathan Pinhorn + SIL OPEN FONT LICENSE Version 1.1 + +--------------------------------- + OTHER FONTS +--------------------------------- -imgui.cpp embeds a copy of 'ProggyClean.ttf' that you can use without any external files. + For Japanese: + + M+ fonts by Coji Morishita are free and include most useful Kanjis you would need. + mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html + + For Japanese, Chinese, Korean: + + You can use Arial Unicode or other Unicode fonts provided with Windows (not sure of their license). + Other suggestions? -Load .TTF file with: +--------------------------------- + LOADING INSTRUCTIONS +--------------------------------- - ImGuiIO& io = ImGui::GetIO(); - io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels); + Load .TTF file with: + + ImGuiIO& io = ImGui::GetIO(); + io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels); -Add a third parameter to bake specific font ranges: + Add a third parameter to bake specific font ranges: - io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesDefault()); // Basic Latin, Extended Latin - io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesJapanese()); // Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs - io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesChinese()); // Include full set of about 21000 CJK Unified Ideographs + io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesDefault()); // Basic Latin, Extended Latin + io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesJapanese()); // Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs + io.Fonts->LoadFromFileTTF("myfontfile.ttf", size_pixels, io.Fonts->GetGlyphRangesChinese()); // Include full set of about 21000 CJK Unified Ideographs Offset font by altering the io.Font->DisplayOffset value: - ImFont* font = io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels); - font->DisplayOffset.y += 1; // Render 1 pixel down - ------------------------------------ - RECOMMENDED SIZES ------------------------------------ + ImFont* font = io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels); + font->DisplayOffset.y += 1; // Render 1 pixel down - ProggyTiny.ttf Size: 10.0f Offset: Y: +1 - ProggyClean.ttf Size: 13.0f Offset: Y: +1 -