IconFontGolang

README

Support development of IconFontCppHeaders through GitHub Sponsors or Patreon

IconFontCppHeaders

https://github.com/juliettef/IconFontCppHeaders

C, C++ headers and C# classes for icon fonts Font Awesome, Fork Awesome, Google Material Design icons, Kenney game icons and Fontaudio.

A set of header files and classes for using icon fonts in C, C++ and C#, along with the python generator used to create the files.

Each header contains defines for one font, with each icon code point defined as ICON_*, along with the min and max code points for font loading purposes.

In addition the python script can be used to convert ttf font files to C and C++ headers. Each ttf icon font file is converted to a C and C++ header file containing a single array of bytes. To enable conversion, run the GenerateIconFontCppHeaders.py script with 'ttf2headerC = True'.

Icon Fonts

Font Awesome

• https://github.com/FortAwesome/Font-Awesome

Font Awesome 4

• icons.yml
• fontawesome-webfont.ttf

Font Awesome 5 - see notes below

• icons.yml
• fa-brands-400.ttf
• fa-regular-400.ttf
• fa-solid-900.ttf

Font Awesome 5 Pro - this is a paid product, see notes below

Files downloaded from fontawesome.com

• ..\fontawesome-pro-n.n.n-web\metadata\icons.yml
• ..\fontawesome-pro-n.n.n-web\webfonts\fa-brands-400.ttf
• ..\fontawesome-pro-n.n.n-web\webfonts\fa-light-300.ttf
• ..\fontawesome-pro-n.n.n-web\webfonts\fa-regular-400.ttf
• ..\fontawesome-pro-n.n.n-web\webfonts\fa-solid-900.ttf

Fork Awesome

• https://github.com/ForkAwesome/Fork-Awesome
• icons.yml
• forkawesome-webfont.ttf

Google Material Design icons - see Issue #19

• https://github.com/google/material-design-icons
• codepoints
• MaterialIcons-Regular.ttf

Kenney Game icons and Game icons expansion

• https://github.com/nicodinh/kenney-icon-font
• kenney-icons.css
• kenney-icon-font.ttf

Fontaudio

• https://github.com/fefanto/fontaudio
• fontaudio.css
• fontaudio.ttf

Notes about Font Awesome 5

Codepoints grouping

Font Awesome 5 splits the different styles of icons into different font files with identical codepoints for light, regular and solid styles, and a different set of codepoints for brands. We have put the brands into a separate header file.

Generating Pro header files

Download the Font Awesome Pro Web package. To generate the headers, drop icons.yml in the same directory as GenerateIconFontCppHeaders.py before running the script. The file icons.yml is under ..\fontawesome-pro-n.n.n-web\metadata\icons.yml where n.n.n is the version number.

Ionicons and webfont Material Design Icons

Unsupported as of 29 Apr 2020. See Issue #16.

Example Code

Using Dear ImGui as an example UI library:

#include "IconsFontAwesome5.h"

ImGuiIO& io = ImGui::GetIO();
io.Fonts->AddFontDefault();
 
// merge in icons from Font Awesome
static const ImWchar icons_ranges[] = { ICON_MIN_FA, ICON_MAX_FA, 0 };
ImFontConfig icons_config; icons_config.MergeMode = true; icons_config.PixelSnapH = true;
io.Fonts->AddFontFromFileTTF( FONT_ICON_FILE_NAME_FAS, 16.0f, &icons_config, icons_ranges );
// use FONT_ICON_FILE_NAME_FAR if you want regular instead of solid

// in an imgui window somewhere...
ImGui::Text( ICON_FA_PAINT_BRUSH "  Paint" );    // use string literal concatenation
// outputs a paint brush icon and 'Paint' as a string.

Projects using the font icon header files

Avoyd

Avoyd is a 6 degrees of freedom voxel game that includes a voxel editor tool.
www.avoyd.com

The voxel editor's UI uses Dear ImGui with Font Awesome icon fonts.

bgfx

Cross-platform rendering library.
bkaradzic.github.io/bgfx/overview

glChAoS.P

Real time 3D strange attractors scout.
www.michelemorrone.eu/glchaosp

iPlug2

Cross platform C++ audio plug-in framework
iplug2.github.io

Lumix Engine

3D C++ open source game engine

Tracy Profiler

Real time, nanosecond resolution, remote telemetry frame profiler for games and other applications.

Visual 6502 Remix

Transistor level 6502 Hardware Simulation
floooh.github.io/visual6502remix

Credits

Development - Juliette Foucaut - @juliettef
Requirements - Doug Binks - @dougbinks
None language implementation and refactoring - Leonard Ritter - @paniq
Suggestion to add a define for the ttf file name - Sean Barrett - @nothings
Initial Font Awesome 5 implementation - Codecat - @codecat
Suggestion to add Fork Awesome - Julien Deswaef - @xuv
Suggestion to add Ionicons - Omar Cornut - @ocornut
C# language implementation - Rokas Kupstys - @rokups
Suggestion to add Material Design Icons - Gustav Madeso - @madeso
Fontaudio implementation - Oli Larkin - @olilarkin
Initial ttf to C and C++ headers conversion implementation - Charles Mailly - @Caerind