Skip to content

Commit

Permalink
feat: improved theme png rendering
Browse files Browse the repository at this point in the history
* feat: improved theme png rendering

Overall this improves glyph rendering in the theme PNGs for docs.
Changes:
- Replaces VictorMono with latest Hack nerd font
- When calculating overall width, count glyphs as double wide
- When rendering a glyph, allow ~1.7x space (this seemed right testing many)

I hope this is a net improvement that helps theme renders be a bit more accurate and shine!

* move to 2x for overall width expansion

1.7 introduces some odd offset problems with some backgrounds - 2x is stable.

* Based on data from:
https://github.com/ryanoasis/nerd-fonts/wiki/Glyph-Sets-and-Code-Points
...checking those points for nerd font glyphs in play

I'm unfamiliar with Go here and maybe there's a better way to implement,
but the results are much improved.

* tweak ranges and bg position for font diff

* exclude pixelated (e0c4-e0c7) from doube-width

* simplify cyclomatic complexity

Go checks were unhappy - this isn't a hot path so breaking it out
into a format that matches the docs, for easier maintenance.

* I have no idea what I'm doing

...but I hope this works - bit simpler layout to maintain too.

* fix: add comments

Good PR feedback - adding some more commentary for anyone coming across these bits later

* typo
  • Loading branch information
NickCraver committed Sep 18, 2021
1 parent 4eb3b43 commit e27d34a
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 10 deletions.
Binary file added src/font/Hack-Nerd-Bold.ttf
Binary file not shown.
Binary file added src/font/Hack-Nerd-Italic.ttf
Binary file not shown.
Binary file added src/font/Hack-Nerd-Regular.ttf
Binary file not shown.
Binary file removed src/font/VictorMono-Bold.ttf
Binary file not shown.
Binary file removed src/font/VictorMono-Italic.ttf
Binary file not shown.
Binary file removed src/font/VictorMono-Regular.ttf
Binary file not shown.
84 changes: 74 additions & 10 deletions src/image.go
Expand Up @@ -67,14 +67,14 @@ const (
link = "link"
)

//go:embed font/VictorMono-Bold.ttf
var victorMonoBold []byte
//go:embed font/Hack-Nerd-Bold.ttf
var hackBold []byte

//go:embed font/VictorMono-Regular.ttf
var victorMonoRegular []byte
//go:embed font/Hack-Nerd-Regular.ttf
var hackRegular []byte

//go:embed font/VictorMono-Italic.ttf
var victorMonoItalic []byte
//go:embed font/Hack-Nerd-Italic.ttf
var hackItalic []byte

type RGB struct {
r int
Expand Down Expand Up @@ -135,9 +135,9 @@ func (ir *ImageRenderer) init() {

ir.cleanContent()

fontRegular, _ := truetype.Parse(victorMonoRegular)
fontBold, _ := truetype.Parse(victorMonoBold)
fontItalic, _ := truetype.Parse(victorMonoItalic)
fontRegular, _ := truetype.Parse(hackRegular)
fontBold, _ := truetype.Parse(hackBold)
fontItalic, _ := truetype.Parse(hackItalic)
fontFaceOptions := &truetype.Options{Size: f * 12, DPI: 144}

ir.defaultForegroundColor = &RGB{255, 255, 255}
Expand Down Expand Up @@ -188,10 +188,65 @@ func (ir *ImageRenderer) fontHeight() float64 {
return float64(ir.regular.Metrics().Height >> 6)
}

type RuneRange struct {
Start rune
End rune
}

// If we're a Nerd Font code point, treat as double width
var doubleWidthRunes = []RuneRange{
// Seti-UI + Custom range
{Start: '\ue5fa', End: '\ue62b'},
// Devicons
{Start: '\ue700', End: '\ue7c5'},
// Font Awesome
{Start: '\uf000', End: '\uf2e0'},
// Font Awesome Extension
{Start: '\ue200', End: '\ue2a9'},
// Material Design Icons
{Start: '\uf500', End: '\ufd46'},
// Weather
{Start: '\ue300', End: '\ue3eb'},
// Octicons
{Start: '\uf400', End: '\uf4a8'},
{Start: '\u2665', End: '\u2665'},
{Start: '\u26A1', End: '\u26A1'},
{Start: '\uf27c', End: '\uf27c'},
// Powerline Extra Symbols (intentionally excluding single width bubbles (e0b4-e0b7) and pixelated (e0c4-e0c7))
{Start: '\ue0a3', End: '\ue0a3'},
{Start: '\ue0b8', End: '\ue0c3'},
{Start: '\ue0c8', End: '\ue0c8'},
{Start: '\ue0ca', End: '\ue0ca'},
{Start: '\ue0cc', End: '\ue0d2'},
{Start: '\ue0d4', End: '\ue0d4'},
// IEC Power Symbols
{Start: '\u23fb', End: '\u23fe'},
{Start: '\u2b58', End: '\u2b58'},
// Font Logos
{Start: '\uf300', End: '\uf313'},
// Pomicons
{Start: '\ue000', End: '\ue00d'},
}

// This is getting how many additional characters of width to allocate when drawing
// e.g. for characters that are 2 or more wide. A standard character will return 0
// Nerd Font glyphs will return 1, since most are double width
func (ir *ImageRenderer) runeAdditionalWidth(r rune) int {
for _, runeRange := range doubleWidthRunes {
if runeRange.Start <= r && r <= runeRange.End {
return 1
}
}
return 0
}

func (ir *ImageRenderer) calculateWidth() int {
longest := 0
for _, line := range strings.Split(ir.ansiString, "\n") {
length := ir.ansi.lenWithoutANSI(line)
for _, char := range line {
length += ir.runeAdditionalWidth(char)
}
if length > longest {
longest = length
}
Expand Down Expand Up @@ -320,9 +375,18 @@ func (ir *ImageRenderer) SavePNG(path string) error {
}

w, h := dc.MeasureString(str)
// The gg library unfortunately returns a single character width for *all* glyphs in a font.
// So if we know the glyph to occupy n additional characters in width, allocate that area
// e.g. this will double the space for Nerd Fonts, but some could even be 3 or 4 wide
// If there's 0 additional characters of width (the common case), this won't add anything
w += (w * float64(ir.runeAdditionalWidth(runes[0])))

if ir.backgroundColor != nil {
dc.SetRGB255(ir.backgroundColor.r, ir.backgroundColor.g, ir.backgroundColor.b)
dc.DrawRectangle(x, y-h, w, h+12)
// The background for a character needs love to align to the font we're using
// Not all fonts are rendered the same height or starting position,
// so we're shifting the background rectangles vertically to correct
dc.DrawRectangle(x, y-h+3, w, h+9)
dc.Fill()
}
if ir.foregroundColor != nil {
Expand Down

0 comments on commit e27d34a

Please sign in to comment.