package truetype

Import Path
	github.com/golang/freetype/truetype (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	    face.go
	    glyph.go
	    hint.go
	    opcodes.go
	  d truetype.go
		Package truetype provides a parser for the TTF and TTC file formats.
		Those formats are documented at http://developer.apple.com/fonts/TTRefMan/
		and http://www.microsoft.com/typography/otspec/
		
		Some of a font's methods provide lengths or co-ordinates, e.g. bounds, font
		metrics and control points. All these methods take a scale parameter, which
		is the number of pixels in 1 em, expressed as a 26.6 fixed point value. For
		example, if 1 em is 10 pixels then scale is fixed.I(10), which is equal to
		fixed.Int26_6(10 << 6).
		
		To measure a TrueType font in ideal FUnit space, use scale equal to
		font.FUnitsPerEm().
Package-Level Type Names (total 10)

	/* sort by: alphabet | popularity */
	 type Font (struct)
		A Font represents a Truetype font.

		Methods (total 7)
			(*Font) Bounds(scale fixed.Int26_6) fixed.Rectangle26_6
				Bounds returns the union of a Font's glyphs' bounds.

			(*Font) FUnitsPerEm() int32
				FUnitsPerEm returns the number of FUnits in a Font's em-square's side.

			(*Font) HMetric(scale fixed.Int26_6, i Index) HMetric
				HMetric returns the horizontal metrics for the glyph with the given index.

			(*Font) Index(x rune) Index
				Index returns a Font's index for the given rune.

			(*Font) Kern(scale fixed.Int26_6, i0, i1 Index) fixed.Int26_6
				Kern returns the horizontal adjustment for the given glyph pair. A positive
				kern means to move the glyphs further apart.

			(*Font) Name(id NameID) string
				Name returns the Font's name value for the given NameID. It returns "" if
				there was an error, or if that name was not found.

			(*Font) VMetric(scale fixed.Int26_6, i Index) VMetric
				VMetric returns the vertical metrics for the glyph with the given index.

		As Outputs Of (at least one exported)
			func Parse(ttf []byte) (font *Font, err error)
		As Inputs Of (at least 2)
			func NewFace(f *Font, opts *Options) font.Face
			func (*GlyphBuf).Load(f *Font, scale fixed.Int26_6, i Index, h font.Hinting) error

	 type FormatError string (basic type)
		A FormatError reports that the input is not a valid TrueType font.

		Methods (only one)
			( FormatError) Error() string
		Implements (at least one exported)
			 FormatError : error

	 type GlyphBuf (struct)
		A GlyphBuf holds a glyph's contours. A GlyphBuf can be re-used to load a
		series of glyphs from a Font.

		Fields (total 6)
			AdvanceWidth fixed.Int26_6
				AdvanceWidth is the glyph's advance width.

			Bounds fixed.Rectangle26_6
				Bounds is the glyph's bounding box.

			Ends []int
				Ends is the point indexes of the end point of each contour. The length
				of Ends is the number of contours in the glyph. The i'th contour
				consists of points Points[Ends[i-1]:Ends[i]], where Ends[-1] is
				interpreted to mean zero.

			InFontUnits []Point
				Points contains all Points from all contours of the glyph. If hinting
				was used to load a glyph then Unhinted contains those Points before they
				were hinted, and InFontUnits contains those Points before they were
				hinted and scaled.

			Points []Point
				Points contains all Points from all contours of the glyph. If hinting
				was used to load a glyph then Unhinted contains those Points before they
				were hinted, and InFontUnits contains those Points before they were
				hinted and scaled.

			Unhinted []Point
				Points contains all Points from all contours of the glyph. If hinting
				was used to load a glyph then Unhinted contains those Points before they
				were hinted, and InFontUnits contains those Points before they were
				hinted and scaled.

		Methods (only one)
			(*GlyphBuf) Load(f *Font, scale fixed.Int26_6, i Index, h font.Hinting) error
				Load loads a glyph's contours from a Font, overwriting any previously loaded
				contours for this GlyphBuf. scale is the number of 26.6 fixed point units in
				1 em, i is the glyph index, and h is the hinting policy.


	 type HMetric (struct)
		An HMetric holds the horizontal metrics of a single glyph.

		Fields (total 2)
			AdvanceWidth fixed.Int26_6
			LeftSideBearing fixed.Int26_6
		As Outputs Of (at least one exported)
			func (*Font).HMetric(scale fixed.Int26_6, i Index) HMetric

	 type Index uint16 (basic type)
		An Index is a Font's index of a rune.

		As Outputs Of (at least one exported)
			func (*Font).Index(x rune) Index
		As Inputs Of (at least 4)
			func (*Font).HMetric(scale fixed.Int26_6, i Index) HMetric
			func (*Font).Kern(scale fixed.Int26_6, i0, i1 Index) fixed.Int26_6
			func (*Font).VMetric(scale fixed.Int26_6, i Index) VMetric
			func (*GlyphBuf).Load(f *Font, scale fixed.Int26_6, i Index, h font.Hinting) error

	 type NameID uint16 (basic type)
		A NameID identifies a name table entry.
		
		See https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6name.html

		As Inputs Of (at least one exported)
			func (*Font).Name(id NameID) string
		As Types Of (only one)
			const NameIDCopyright

	 type Options (struct)
		Options are optional arguments to NewFace.

		Fields (total 6)
			DPI float64
				DPI is the dots-per-inch resolution.
				
				A zero value means to use 72 DPI.

			GlyphCacheEntries int
				GlyphCacheEntries is the number of entries in the glyph mask image
				cache.
				
				If non-zero, it must be a power of 2.
				
				A zero value means to use 512 entries.

			Hinting font.Hinting
				Hinting is how to quantize the glyph nodes.
				
				A zero value means to use no hinting.

			Size float64
				Size is the font size in points, as in "a 10 point font size".
				
				A zero value means to use a 12 point font size.

			SubPixelsX int
				SubPixelsX is the number of sub-pixel locations a glyph's dot is
				quantized to, in the horizontal direction. For example, a value of 8
				means that the dot is quantized to 1/8th of a pixel. This quantization
				only affects the glyph mask image, not its bounding box or advance
				width. A higher value gives a more faithful glyph image, but reduces the
				effectiveness of the glyph cache.
				
				If non-zero, it must be a power of 2, and be between 1 and 64 inclusive.
				
				A zero value means to use 4 sub-pixel locations.

			SubPixelsY int
				SubPixelsY is the number of sub-pixel locations a glyph's dot is
				quantized to, in the vertical direction. For example, a value of 8
				means that the dot is quantized to 1/8th of a pixel. This quantization
				only affects the glyph mask image, not its bounding box or advance
				width. A higher value gives a more faithful glyph image, but reduces the
				effectiveness of the glyph cache.
				
				If non-zero, it must be a power of 2, and be between 1 and 64 inclusive.
				
				A zero value means to use 1 sub-pixel location.

		As Inputs Of (at least one exported)
			func NewFace(f *Font, opts *Options) font.Face

	 type Point (struct)
		A Point is a co-ordinate pair plus whether it is 'on' a contour or an 'off'
		control point.

		Fields (total 3)
			Flags uint32
				The Flags' LSB means whether or not this Point is 'on' the contour.
				Other bits are reserved for internal use.

			X fixed.Int26_6
			Y fixed.Int26_6

	 type UnsupportedError string (basic type)
		An UnsupportedError reports that the input uses a valid but unimplemented
		TrueType feature.

		Methods (only one)
			( UnsupportedError) Error() string
		Implements (at least one exported)
			 UnsupportedError : error

	 type VMetric (struct)
		A VMetric holds the vertical metrics of a single glyph.

		Fields (total 2)
			AdvanceHeight fixed.Int26_6
			TopSideBearing fixed.Int26_6
		As Outputs Of (at least one exported)
			func (*Font).VMetric(scale fixed.Int26_6, i Index) VMetric


Package-Level Functions (total 2)

	 func NewFace(f *Font, opts *Options) font.Face
		NewFace returns a new font.Face for the given Font.

	 func Parse(ttf []byte) (font *Font, err error)
		Parse returns a new Font for the given TTF or TTC data.
		
		For TrueType Collections, the first font in the collection is parsed.


Package-Level Constants (total 19)

	const NameIDCompatibleName = 18
	const NameIDCopyright NameID = 0
	const NameIDDesignerName = 9
	const NameIDFontDescription = 10
	const NameIDFontDesignerURL = 12
	const NameIDFontFamily = 1
	const NameIDFontFullName = 4
	const NameIDFontLicense = 13
	const NameIDFontLicenseURL = 14
	const NameIDFontSubfamily = 2
	const NameIDFontVendorURL = 11
	const NameIDManufacturerName = 8
	const NameIDNameTableVersion = 5
	const NameIDPostscriptName = 6
	const NameIDPreferredFamily = 16
	const NameIDPreferredSubfamily = 17
	const NameIDSampleText = 19
	const NameIDTrademarkNotice = 7
	const NameIDUniqueSubfamilyID = 3

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.