Cool_Tools/imgui
1
0
Fork 0
mirror of https://github.com/ocornut/imgui.git synced 2024-12-23 21:15:03 +01:00
Code Releases Wiki Activity
947aa9c972
imgui/misc/freetype
History
ocornut 566558b17c Replacing NULL with nullptr in examples/backends when they creeped back. (#6313, #7071, #4537)
2024-12-05 12:25:02 +01:00
..
imgui_freetype.cpp Replacing NULL with nullptr in examples/backends when they creeped back. (#6313, #7071, #4537) 2024-12-05 12:25:02 +01:00
imgui_freetype.h imgui_freetype: Added support for plutosvg to render OpenType SVG fonts. (#7927, #7187 + #6591, #6607) 2024-10-17 11:01:59 +02:00
README.md imgui_freetype: Added support for plutosvg to render OpenType SVG fonts. (#7927, #7187 + #6591, #6607) 2024-10-17 11:01:59 +02:00

README.md

imgui_freetype

Build font atlases using FreeType instead of stb_truetype (which is the default font rasterizer).
by @vuhdo, @mikesart, @ocornut.

Usage

  1. Get latest FreeType binaries or build yourself (under Windows you may use vcpkg with vcpkg install freetype --triplet=x64-windows, vcpkg integrate install).
  2. Add imgui_freetype.h/cpp alongside your project files.
  3. Add #define IMGUI_ENABLE_FREETYPE in your imconfig.h file

About Gamma Correct Blending

FreeType assumes blending in linear space rather than gamma space. See FreeType note for FT_Render_Glyph. For correct results you need to be using sRGB and convert to linear space in the pixel shader output. The default Dear ImGui styles will be impacted by this change (alpha values will need tweaking).

Testbed for toying with settings (for developers)

See https://gist.github.com/ocornut/b3a9ecf13502fd818799a452969649ad

Known issues

  • Oversampling settings are ignored but also not so much necessary with the higher quality rendering.

Comparison

Small, thin anti-aliased fonts typically benefit a lot from FreeType's hinting: comparing_font_rasterizers

Colorful glyphs/emojis

You can use the ImGuiFreeTypeBuilderFlags_LoadColor flag to load certain colorful glyphs. See the "Using Colorful Glyphs/Emojis" section of FONTS.md.

colored glyphs

Using OpenType SVG fonts (SVGinOT)

  • SVG in Open Type is a standard by Adobe and Mozilla for color OpenType and Open Font Format fonts. It allows font creators to embed complete SVG files within a font enabling full color and even animations.
  • Popular fonts such as twemoji and fonts made with scfbuild is SVGinOT
  • Two alternatives are possible to render SVG fonts: use "lunasvg" or "plutosvg". plutosvg will support some more fonts (e.g. NotoColorEmoji-Regular) and may load them faster.

Using lunasvg

Requires: lunasvg v2.3.2 and above

  • Add #define IMGUI_ENABLE_FREETYPE_LUNASVG in your imconfig.h.
  • Get latest lunasvg binaries or build yourself. Under Windows you may use vcpkg with: vcpkg install lunasvg --triplet=x64-windows.

Using plutosvg (and plutovg)

  • Add #define IMGUI_ENABLE_FREETYPE_PLUTOSVG in your imconfig.h.
  • Compile and link with plutosvg and plutovg (which is required by plutosvg)

Compilation hints for plutovg

  • Compile all source files in plutovg/source/*.c
  • Add include directory: plutovg/include + plutovg/stb

Compilation hints for plutosvg

  • Compile plutosvg/source/plutosvg.c
  • Add include directory: plutosvg/source
  • Add define: PLUTOSVG_HAS_FREETYPE
  • Link with: plutovg, freetype