From 470200ee5c7810e8c832897b359b7fed7c4aa91d Mon Sep 17 00:00:00 2001 From: ocornut Date: Wed, 5 Aug 2015 21:59:07 -0600 Subject: [PATCH] Update documentation --- examples/README.txt | 8 +-- extra_fonts/README.txt | 123 ++++++++++++++++++++++------------------- 2 files changed, 71 insertions(+), 60 deletions(-) diff --git a/examples/README.txt b/examples/README.txt index aa1a392bc..4313356cc 100644 --- a/examples/README.txt +++ b/examples/README.txt @@ -10,13 +10,13 @@ TL;DR; ImGui is highly portable and only requires a few things to run: - Providing mouse/keyboard inputs - Load the font atlas texture into GPU memory - - Providing a render function to process the drawing commands (we rendere indexed textured triangles) - - Extra just as clipboard support, mouse cursor supports, Windows IME support. + - Providing a render function to render indexed textured triangles + - Optional: clipboard support, mouse cursor supports, Windows IME support, etc. So this is essentially what those examples are doing + the obligatory cruft for portability. Unfortunately in 2015 it is still a massive pain to create and maintain portable build files using -external library like the ones we're using here. -For most example here I choose to provide Visual Studio 10 .sln files and Makefile for Linux/OSX. +external library like the ones we're using here to provide 3D rendering. +For most examples here I choose to provide Visual Studio 10 .sln files and Makefile for Linux/OSX. Please let me know if they don't work with your setup! You can probably just import the imgui_impl_xxx.cpp/.h files into your own codebase or compile those directly with a command-line compiler. diff --git a/extra_fonts/README.txt b/extra_fonts/README.txt index 2a8e0da6e..586fb4ed5 100644 --- a/extra_fonts/README.txt +++ b/extra_fonts/README.txt @@ -2,57 +2,6 @@ The code in imgui.cpp embeds a copy of 'ProggyClean.ttf' that you can use without any external files. Those are only provided as a convenience, you can load your own .TTF files. ---------------------------------- - LINKS ---------------------------------- - - Typefaces for source code beautification - https://github.com/chrissimpkins/codeface - - Proggy Programming Fonts - http://upperbounds.net - - Inconsolata - http://www.levien.com/type/myfonts/inconsolata.html - - Adobe Source Code Pro: Monospaced font family for user interface and coding environments - https://github.com/adobe-fonts/source-code-pro - - Monospace/Fixed Width Programmer's Fonts - http://www.lowing.org/fonts/ - - (Japanese) M+ fonts by Coji Morishita are free and include most useful Kanjis you would need. - http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html - - Or use Arial Unicode or other Unicode fonts provided with Windows for full characters coverage (not sure of their licensing). - ---------------------------------- - INCLUDED FONTS ---------------------------------- - - Cousine-Regular.ttf - Digitized data copyright (c) 2010 Google Corporation. - Licensed under the SIL Open Font License, Version 1.1 - - DroidSans.ttf - Copyright (c) Steve Matteson - Apache License, version 2.0 - http://www.google.com/fonts/specimen/Droid+Sans - - ProggyClean.ttf - 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 - 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 - --------------------------------- LOADING INSTRUCTIONS --------------------------------- @@ -75,7 +24,7 @@ config.GlyphExtraSpacing.x = 1.0f; io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, &config); - Merge two fonts: + Combine two fonts into one: // Load main font io.Fonts->AddFontDefault(); @@ -89,17 +38,79 @@ Add a fourth parameter to bake specific font ranges only: - io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesDefault()); // Basic Latin, Extended Latin - io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesJapanese()); // Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs - io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesChinese()); // Include full set of about 21000 CJK Unified Ideographs + // Basic Latin, Extended Latin + io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesDefault()); + + // Include full set of about 21000 CJK Unified Ideographs + io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesJapanese()); + + // Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs + io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels, NULL, io.Fonts->GetGlyphRangesChinese()); Offset font vertically by altering the io.Font->DisplayOffset value: ImFont* font = io.Fonts->AddFontFromFileTTF("myfontfile.ttf", size_pixels); font->DisplayOffset.y += 1; // Render 1 pixel down - If you want to embed the font in source code (e.g. in your engine, so it doesn't have file-system dependencies); +--------------------------------- + EMBED A FONT IN SOURCE CODE +--------------------------------- + Compile and use 'binary_to_compressed_c.cpp' to create a compressed C style array. Then load the font with: ImFont* font = io.Fonts->AddFontFromMemoryCompressedTTF(compressed_data, compressed_data_size, size_pixels, ...); + + Or + + ImFont* font = io.Fonts->AddFontFromMemoryCompressedBase85TTF(compressed_data_base85, size_pixels, ...); + +--------------------------------- + INCLUDED FONT FILES +--------------------------------- + Cousine-Regular.ttf + Digitized data copyright (c) 2010 Google Corporation. + Licensed under the SIL Open Font License, Version 1.1 + + DroidSans.ttf + Copyright (c) Steve Matteson + Apache License, version 2.0 + http://www.google.com/fonts/specimen/Droid+Sans + + ProggyClean.ttf + 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 + 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 + +--------------------------------- + LINKS +--------------------------------- + + Typefaces for source code beautification + https://github.com/chrissimpkins/codeface + + Proggy Programming Fonts + http://upperbounds.net + + Inconsolata + http://www.levien.com/type/myfonts/inconsolata.html + + Adobe Source Code Pro: Monospaced font family for user interface and coding environments + https://github.com/adobe-fonts/source-code-pro + + Monospace/Fixed Width Programmer's Fonts + http://www.lowing.org/fonts/ + + (Japanese) M+ fonts by Coji Morishita are free and include most useful Kanjis you would need. + http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html + + Or use Arial Unicode or other Unicode fonts provided with Windows for full characters coverage (not sure of their licensing).