Browse Source

Font documentation

ocornut 10 years ago
parent
commit
ed23598e49
2 changed files with 21 additions and 10 deletions
  1. 2 3
      README.md
  2. 19 7
      extra_fonts/README.txt

+ 2 - 3
README.md

@@ -99,9 +99,8 @@ Credits
 
 
 Developed by [Omar Cornut](http://www.miracleworld.net) and every direct or indirect contributors to the GitHub. The early version of this library was developed with the support of [Media Molecule](http://www.mediamolecule.com) and first used internally on the game [Tearaway](http://tearaway.mediamolecule.com). 
 Developed by [Omar Cornut](http://www.miracleworld.net) and every direct or indirect contributors to the GitHub. The early version of this library was developed with the support of [Media Molecule](http://www.mediamolecule.com) and first used internally on the game [Tearaway](http://tearaway.mediamolecule.com). 
 
 
-Embeds [proggy_clean](http://upperbounds.net) font by Tristan Grimmer (MIT license).
-Embeds [M+ fonts](http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html) font by Coji Morishita (free software license).
-Embeds [stb_textedit.h](https://github.com/nothings/stb/) by Sean Barrett (public domain).
+Embeds [ProggyClean.ttf](http://upperbounds.net) font by Tristan Grimmer (MIT license).
+Embeds [stb_textedit.h, stb_truetype.h, stb_rectpack.h](https://github.com/nothings/stb/) by Sean Barrett (public domain).
 
 
 Inspiration, feedback, and testing for early versions: Casey Muratori, Atman Binstock, Mikko Mononen, Emmanuel Briney, Stefan Kamoda, Anton Mikhailov, Matt Willis. And everybody posting feedback, questions and patches on the GitHub.
 Inspiration, feedback, and testing for early versions: Casey Muratori, Atman Binstock, Mikko Mononen, Emmanuel Briney, Stefan Kamoda, Anton Mikhailov, Matt Willis. And everybody posting feedback, questions and patches on the GitHub.
 
 

+ 19 - 7
extra_fonts/README.txt

@@ -3,23 +3,35 @@
  EXTRA FONTS FOR IMGUI
  EXTRA FONTS FOR IMGUI
 ---------------------------------
 ---------------------------------
 
 
-ImGui embeds a copy of 'ProggyClean.ttf' that you can use without any external files.
+ ProggyClean.ttf
+ Copyright (c) 2004, 2005 Tristan Grimmer
+ MIT License
+
+ ProggyTiny.ttf
+ Copyright (c) 2004, 2005 Tristan Grimmer
+ MIT License
+
+ Karla-Regular
+ Copyright (c) 2012, Jonathan Pinhorn
+ SIL OPEN FONT LICENSE Version 1.1
+
+imgui.cpp embeds a copy of 'ProggyClean.ttf' that you can use without any external files.
 
 
 Load .TTF file with:
 Load .TTF file with:
 
 
   ImGuiIO& io = ImGui::GetIO();
   ImGuiIO& io = ImGui::GetIO();
-  io.Font = new ImFont();
-  io.Font->LoadFromFileTTF("myfontfile.ttf", size_pixels);
+  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.Font->LoadFromFileTTF("myfontfile.ttf", size_pixels, ImFont::GetGlyphRangesDefault());		// Basic Latin, Extended Latin 
-  io.Font->LoadFromFileTTF("myfontfile.ttf", size_pixels, ImFont::GetGlyphRangesJapanese());		// Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs
-  io.Font->LoadFromFileTTF("myfontfile.ttf", size_pixels, ImFont::GetGlyphRangesChinese());		// Japanese + 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:
 Offset font by altering the io.Font->DisplayOffset value:
 
 
-  io.Font->DisplayOffset.y += 1;   // Render 1 pixel down
+  ImFont* font = io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels);
+  font->DisplayOffset.y += 1;   // Render 1 pixel down
 
 
 -----------------------------------
 -----------------------------------
  RECOMMENDED SIZES
  RECOMMENDED SIZES