package di

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

Dependency Relation
	imports one package, and imported by 2 packages

Involved Source Files

	    direction.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Axis bool (basic type)
		Axis indicates the axis of layout for a piece of text.

		As Outputs Of (at least one exported)
			func Direction.Axis() Axis
		As Types Of (total 2)
			const Horizontal
			const Vertical

	 type Direction uint8 (basic type)
		Direction indicates the layout direction of a piece of text.

		Methods (total 9)
			( Direction) Axis() Axis
				Axis returns the layout axis for d.

			( Direction) Harfbuzz() harfbuzz.Direction
				Harfbuzz returns the equivalent direction used by harfbuzz.

			( Direction) HasVerticalOrientation() bool
				HasVerticalOrientation returns true if the direction has set up
				an orientation for vertical text (typically using [SetSideways] or [SetUpright])

			( Direction) IsSideways() bool
				IsSideways returns true if the direction is vertical with a 'sideways'
				orientation.
				
				When shaping vertical text, 'sideways' means that the glyphs are rotated
				by 90°, clock-wise. This flag should be used by renderers to properly
				rotate the glyphs when drawing.

			( Direction) IsVertical() bool
				IsVertical returns whether d is laid out on a vertical
				axis. If the return value is false, d is on the horizontal
				axis.

			( Direction) Progression() Progression
				Progression returns the text layout progression for d.

			(*Direction) SetProgression(p Progression)
				SetProgression sets the progression, preserving the others bits.

			(*Direction) SetSideways(sideways bool)
				SetSideways makes d vertical with 'sideways' or 'upright' orientation, preserving only the
				progression.

			( Direction) SwitchAxis() Direction
				SwitchAxis switches from horizontal to vertical (and vice versa), preserving
				the progression.

		As Outputs Of (at least one exported)
			func Direction.SwitchAxis() Direction
		As Types Of (total 4)
			const DirectionBTT
			const DirectionLTR
			const DirectionRTL
			const DirectionTTB

	 type Progression bool (basic type)
		Progression indicates how text is read within its Axis relative
		to the top left corner.

		As Outputs Of (at least one exported)
			func Direction.Progression() Progression
		As Inputs Of (at least one exported)
			func (*Direction).SetProgression(p Progression)
		As Types Of (total 2)
			const FromTopLeft
			const TowardTopLeft


Package-Level Constants (total 8)

	const DirectionBTT Direction = 3
		DirectionBTT is for Bottom-to-Top text.

	const DirectionLTR Direction = 0
		DirectionLTR is for Left-to-Right text.

	const DirectionRTL Direction = 1
		DirectionRTL is for Right-to-Left text.

	const DirectionTTB Direction = 2
		DirectionTTB is for Top-to-Bottom text.

	const FromTopLeft Progression = false
		FromTopLeft indicates text in which a reader starts reading
		at the top left corner of the text and moves away from it.
		DirectionLTR and DirectionTTB are examples of FromTopLeft
		Progression.

	const Horizontal Axis = false
	const TowardTopLeft Progression = true
		TowardTopLeft indicates text in which a reader starts reading
		at the opposite end of the text's Axis from the top left corner
		and moves towards it. DirectionRTL and DirectionBTT are examples
		of TowardTopLeft progression.

	const Vertical Axis = true

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.