package opentype

Import Path
	github.com/go-text/typesetting/font/opentype (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 6 packages

Involved Source Files

	  d opentype.go
		Package opentype provides the low level routines
		required to read and write Opentype font files, including collections.
		
		This package is designed to provide an efficient, lazy, reading API.
		
		For the parsing of the various tables, see package [tables].

	    reader.go
	    reader_otf.go
	    reader_woff.go
	    writer.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type GID uint32 (basic type)

		As Inputs Of (at least one exported)
			func github.com/go-text/typesetting/font/cff.(*CFF).GlyphName(glyph GID) string
		As Types Of (only one)
			const github.com/go-text/typesetting/font.EmptyGlyph

	 type GlyphExtents (struct)

		Fields (total 4)
			Height float32
				// Distance from top to bottom side

			Width float32
				// Distance from left to right side

			XBearing float32
				// Left side of glyph from origin

			YBearing float32
				// Top side of glyph from origin

		As Outputs Of (at least one exported)
			func github.com/go-text/typesetting/font/cff/interpreter.(*PathBounds).ToExtents() GlyphExtents

	 type Loader (struct)
		Loader is the low level font reader, providing
		full control over table loading.

		Fields (only one)
			Type Tag
				Type represents the kind of this font being loaded.
				It is one of TrueType, TrueTypeApple, PostScript1, OpenType

		Methods (total 4)
			(*Loader) HasTable(table Tag) bool
				HasTable returns true if [table] is present.

			(*Loader) RawTable(tag Tag) ([]byte, error)
				RawTable returns the binary content of the given table,
				or an error if not found.

			(*Loader) RawTableTo(tag Tag, dst []byte) ([]byte, error)
				RawTable writes the binary content of the given table to [dst], returning it,
				or an error if not found.

			(*Loader) Tables() []Tag
				Tables returns all the tables found in the file,
				as a sorted slice.

		As Outputs Of (at least 2)
			func NewLoader(file Resource) (*Loader, error)
			func NewLoaders(file Resource) ([]*Loader, error)
		As Inputs Of (at least 3)
			func github.com/go-text/typesetting/font.Describe(ld *Loader, buffer []byte) (font.Description, []byte)
			func github.com/go-text/typesetting/font.LoadHeadTable(ld *Loader, buffer []byte) (tables.Head, []byte, error)
			func github.com/go-text/typesetting/font.NewFont(ld *Loader) (*font.Font, error)

	 type Resource (interface)

		Methods (total 3)
			( Resource) Read([]byte) (int, error)
			( Resource) ReadAt([]byte, int64) (int, error)
			( Resource) Seek(int64, int) (int64, error)
		Implemented By (at least 10)
			 github.com/apache/arrow-go/v18/arrow/ipc.ReadAtSeeker (interface)
			 github.com/apache/arrow-go/v18/internal/utils.Reader (interface)
			 github.com/coreos/etcd/pkg/fileutil.LockedFile
			*github.com/klauspost/compress/s2.ReadSeeker
			*github.com/polarsignals/wal/fs.File
			*bytes.Reader
			*io.SectionReader
			 mime/multipart.File (interface)
			*os.File
			*strings.Reader
		Implements (at least 7)
			 Resource : github.com/apache/arrow-go/v18/arrow/ipc.ReadAtSeeker
			 Resource : github.com/apache/arrow-go/v18/internal/utils.Reader
			 Resource : github.com/apache/arrow-go/v18/parquet.ReaderAtSeeker
			 Resource : io.Reader
			 Resource : io.ReaderAt
			 Resource : io.ReadSeeker
			 Resource : io.Seeker
		As Inputs Of (at least 2)
			func NewLoader(file Resource) (*Loader, error)
			func NewLoaders(file Resource) ([]*Loader, error)

	 type Segment (struct)

		Fields (total 2)
			Args [3]SegmentPoint
				Args is up to three (x, y) coordinates, depending on the
				operation.
				The Y axis increases up.

			Op SegmentOp
		Methods (only one)
			(*Segment) ArgsSlice() []SegmentPoint
				ArgsSlice returns the effective slice of points
				used (whose length is between 1 and 3).

		As Outputs Of (at least 2)
			func github.com/go-text/typesetting/font/cff.(*CFF).LoadGlyph(glyph tables.GlyphID) ([]Segment, ps.PathBounds, error)
			func github.com/go-text/typesetting/font/cff.(*CFF2).LoadGlyph(glyph tables.GlyphID, coords []tables.Coord) ([]Segment, ps.PathBounds, error)

	 type SegmentOp uint8 (basic type)

		As Types Of (total 4)
			const SegmentOpCubeTo
			const SegmentOpLineTo
			const SegmentOpMoveTo
			const SegmentOpQuadTo

	 type SegmentPoint (struct)

		Fields (total 2)
			X float32
				// expressed in fonts units

			Y float32
				// expressed in fonts units

		Methods (only one)
			(*SegmentPoint) Move(dx, dy float32)
				Move translates the point.

		As Outputs Of (at least one exported)
			func (*Segment).ArgsSlice() []SegmentPoint

	 type Table (struct)
		Table is one opentype binary table and its tag.

		Fields (total 2)
			Content []byte
			Tag Tag
		As Inputs Of (at least one exported)
			func WriteTTF(tables []Table) []byte

	 type Tag uint32 (basic type)

		Methods (only one)
			( Tag) String() string
				String return the ASCII form of the tag.

		Implements (at least 2)
			 Tag : expvar.Var
			 Tag : fmt.Stringer
		As Outputs Of (at least 3)
			func MustNewTag(str string) Tag
			func NewTag(a, b, c, d byte) Tag
			func (*Loader).Tables() []Tag
		As Inputs Of (at least 3)
			func (*Loader).HasTable(table Tag) bool
			func (*Loader).RawTable(tag Tag) ([]byte, error)
			func (*Loader).RawTableTo(tag Tag, dst []byte) ([]byte, error)
		As Types Of (total 4)
			  var AppleTrueType
			  var OpenType
			  var PostScript1
			  var TrueType


Package-Level Functions (total 5)

	 func MustNewTag(str string) Tag
		MustNewTag gives you the Tag corresponding to the acronym.
		This function will panic if the string passed in is not 4 bytes long.

	 func NewLoader(file Resource) (*Loader, error)
		NewLoader reads the `file` header and returns
		a new lazy ot.
		`file` will be used to parse tables, and should not be close.

	 func NewLoaders(file Resource) ([]*Loader, error)
		NewLoaders is the same as `NewLoader`, but supports collections.

	 func NewTag(a, b, c, d byte) Tag
		NewTag returns the tag for <abcd>.

	 func WriteTTF(tables []Table) []byte
		WriteTTF creates a single Truetype font file (.ttf) from the given [tables] slice,
		which must be sorted by Tag


Package-Level Variables (total 4)

	  var AppleTrueType Tag
		AppleTrueType is the first four bytes of an OpenType file containing a TrueType font
		(specifically one designed for Apple products, it's recommended to use TrueType instead)

	  var OpenType Tag
		OpenType is the first four bytes of an OpenType file containing a PostScript Type 2 font
		as specified by OpenType

	  var PostScript1 Tag
		PostScript1 is the first four bytes of an OpenType file containing a PostScript 1 font

	  var TrueType Tag
		TrueType is the first four bytes of an OpenType file containing a TrueType font


Package-Level Constants (total 4)

	const SegmentOpCubeTo SegmentOp = 3
	const SegmentOpLineTo SegmentOp = 1
	const SegmentOpMoveTo SegmentOp = 0
	const SegmentOpQuadTo SegmentOp = 2

The pages are generated with Golds v0.8.7. (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.