tfm

Documentation

Overview

Package tfm implements a decoder for TFM (TeX Font Metrics) files.

Index

• type Font
  • func Parse(r io.Reader) (Font, error)
  • func (fnt *Font) Box(r rune) (w, h, d fixed.Int12_20, ok bool)
  • func (fnt *Font) Checksum() uint32
  • func (fnt *Font) CodingScheme() string
  • func (fnt *Font) DesignSize() fixed.Int12_20
  • func (fnt *Font) GlyphAdvance(r rune) (xfix.Int26_6, bool)
  • func (fnt *Font) GlyphBounds(r rune) (bounds xfix.Rectangle26_6, advance xfix.Int26_6, ok bool)
  • func (fnt *Font) Kern(r0, r1 rune) xfix.Int26_6
  • func (fnt *Font) MarshalText() ([]byte, error)
  • func (fnt *Font) Metrics() font.Metrics
  • func (fnt *Font) Name() string
  • func (fnt *Font) NumGlyphs() int

Types

type Font

type Font struct {
	// contains filtered or unexported fields
}

Font is a TeX Font metrics.

func Parse

func Parse(r io.Reader) (Font, error)

Parse parses a TFM file.

func (*Font) Box

func (fnt *Font) Box(r rune) (w, h, d fixed.Int12_20, ok bool)

Box returns the width, height and depth of r's glyph.

It returns !ok if the face does not contain a glyph for r.

func (*Font) Checksum

func (fnt *Font) Checksum() uint32

Checksum returns the checksum of the TeX font metrics file.

func (*Font) CodingScheme

func (fnt *Font) CodingScheme() string

func (*Font) DesignSize

func (fnt *Font) DesignSize() fixed.Int12_20

func (*Font) GlyphAdvance

func (fnt *Font) GlyphAdvance(r rune) (xfix.Int26_6, bool)

GlyphAdvance returns the advance width of r's glyph.

It returns !ok if the face does not contain a glyph for r.

func (*Font) GlyphBounds

func (fnt *Font) GlyphBounds(r rune) (bounds xfix.Rectangle26_6, advance xfix.Int26_6, ok bool)

GlyphBounds returns the bounding box of r's glyph, drawn at a dot equal to the origin, and that glyph's advance width.

It returns !ok if the face does not contain a glyph for r.

The glyph's ascent and descent equal -bounds.Min.Y and +bounds.Max.Y. A visual depiction of what these metrics are is at https://developer.apple.com/library/mac/documentation/TextFonts/Conceptual/CocoaTextArchitecture/Art/glyph_metrics_2x.png

func (*Font) Kern

func (fnt *Font) Kern(r0, r1 rune) xfix.Int26_6

Kern returns the horizontal adjustment for the kerning pair (r0, r1). A positive kern means to move the glyphs further apart.

func (*Font) MarshalText

func (fnt *Font) MarshalText() ([]byte, error)

func (*Font) Metrics

func (fnt *Font) Metrics() font.Metrics

Metrics returns the metrics for this Face.

func (*Font) Name

func (fnt *Font) Name() string

func (*Font) NumGlyphs

func (fnt *Font) NumGlyphs() int

NumGlyphs returns the number of glyphs in this font.