package rough

Import Path
	github.com/d2lang/rough-go (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 2 packages

Involved Source Files

	    core.go
	    filler.go
	    filler_dashed.go
	    filler_dot.go
	    filler_hachure.go
	    filler_hatch.go
	    filler_scan_line_hachure.go
	    filler_zigzag.go
	    filler_zigzag_line.go
	    generator.go
	    geometry.go
	    math.go
	    number.go
	    path.go
	    renderer.go
Package-Level Type Names (total 15)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config configures a Generator.

		Fields (only one)
			Options *Options
		As Inputs Of (at least one exported)
			func NewGenerator(config *Config, surface ...*Surface) *Generator

	 type Drawable (struct)
		Drawable is the source-shaped output of Generator drawing methods.

		Fields (total 3)
			Options *ResolvedOptions
			Sets []OpSet
			Shape string
		As Outputs Of (at least 11)
			func (*Generator).Arc(x, y, width, height, start, stop float64, closed bool, options *Options) Drawable
			func (*Generator).Circle(x, y, diameter float64, options *Options) Drawable
			func (*Generator).Curve(points []Point, options *Options) Drawable
			func (*Generator).Ellipse(x, y, width, height float64, options *Options) Drawable
			func (*Generator).Line(x1, y1, x2, y2 float64, options *Options) Drawable
			func (*Generator).LinearPath(points []Point, options *Options) Drawable
			func (*Generator).Path(pathData string, options *Options) Drawable
			func (*Generator).Polygon(points []Point, options *Options) Drawable
			func (*Generator).Rectangle(x, y, width, height float64, options *Options) Drawable
			func github.com/pancsta/d2/d2renderers/d2sketch.ArrowheadDrawables(arrowhead d2target.Arrowhead, stroke string, strokeWidth int) ([]Drawable, bool)
			func github.com/pancsta/d2/d2renderers/d2sketch.ConnectionDrawable(ctx context.Context, path d2scene.Path, limits d2sketch.SceneLimits) (Drawable, error)
		As Inputs Of (at least 2)
			func (*Generator).ToPaths(d Drawable) []PathInfo
			func github.com/pancsta/d2/d2renderers/d2sketch.CompileScenePaths(ctx context.Context, drawable Drawable, limits d2sketch.SceneLimits) ([]d2sketch.ScenePath, error)

	 type Generator (struct)
		Generator creates Rough.js-compatible drawing operations.
		
		A Generator retains the same mutable default-option random state as
		Rough.js. Its methods are safe for concurrent use, though callers that need
		independent deterministic streams should use separate generators.

		Methods (total 12)
			(*Generator) Arc(x, y, width, height, start, stop float64, closed bool, options *Options) Drawable
				Arc creates a rough elliptical arc.

			(*Generator) Circle(x, y, diameter float64, options *Options) Drawable
				Circle creates a rough circle centered at x,y.

			(*Generator) Curve(points []Point, options *Options) Drawable
				Curve creates a rough curve through points.

			(*Generator) DefaultOptions() ResolvedOptions
				DefaultOptions returns a value copy of the generator's current defaults.

			(*Generator) Ellipse(x, y, width, height float64, options *Options) Drawable
				Ellipse creates a rough ellipse centered at x,y.

			(*Generator) Line(x1, y1, x2, y2 float64, options *Options) Drawable
				Line creates a rough line.

			(*Generator) LinearPath(points []Point, options *Options) Drawable
				LinearPath creates an open rough path through points.

			(*Generator) OpsToPath(drawing OpSet) string
				OpsToPath serializes operations using Rough.js's SVG punctuation and number
				formatting.

			(*Generator) Path(pathData string, options *Options) Drawable
				Path creates a rough rendering of SVG path data.

			(*Generator) Polygon(points []Point, options *Options) Drawable
				Polygon creates a closed rough polygon.

			(*Generator) Rectangle(x, y, width, height float64, options *Options) Drawable
				Rectangle creates a rough rectangle.

			(*Generator) ToPaths(d Drawable) []PathInfo
				ToPaths converts a Drawable into the ordered SVG path descriptions emitted
				by Rough.js's generator API.

		As Outputs Of (at least one exported)
			func NewGenerator(config *Config, surface ...*Surface) *Generator

	 type Line ([...])
		Line is a line segment represented by its two endpoints.

	 type Op (struct)
		Op is one path operation and its ordered numeric arguments.

		Fields (total 2)
			Data []float64
			Op OpType

	 type OpSet (struct)
		OpSet is one ordered set of path operations.

		Fields (total 4)
			Ops []Op
			Path string
			Size *Point
			Type OpSetType
		As Inputs Of (at least one exported)
			func (*Generator).OpsToPath(drawing OpSet) string

	 type OpSetType string (basic type)
		OpSetType identifies the rendering role of an operation set.

		As Types Of (total 5)
			const OpSetFillPath
			const OpSetFillSketch
			const OpSetPath
			const OpSetPath2DFill
			const OpSetPath2DPattern

	 type Options (struct)
		Options contains optional Rough.js drawing options. Pointer fields preserve
		the distinction between an omitted option and an explicit zero value.

		Fields (total 27)
			Bowing *float64
			CurveFitting *float64
			CurveStepCount *float64
			CurveTightness *float64
			DashGap *float64
			DashOffset *float64
			DisableMultiStroke *bool
			DisableMultiStrokeFill *bool
			Fill *string
			FillLineDash []float64
			FillLineDashOffset *float64
			FillShapeRoughnessGain *float64
			FillStyle *string
			FillWeight *float64
			FixedDecimalPlaceDigits *float64
			HachureAngle *float64
			HachureGap *float64
			MaxRandomnessOffset *float64
			PreserveVertices *bool
			Roughness *float64
			Seed *float64
			Simplification *float64
			Stroke *string
			StrokeLineDash []float64
			StrokeLineDashOffset *float64
			StrokeWidth *float64
			ZigzagOffset *float64
		As Inputs Of (at least 9)
			func (*Generator).Arc(x, y, width, height, start, stop float64, closed bool, options *Options) Drawable
			func (*Generator).Circle(x, y, diameter float64, options *Options) Drawable
			func (*Generator).Curve(points []Point, options *Options) Drawable
			func (*Generator).Ellipse(x, y, width, height float64, options *Options) Drawable
			func (*Generator).Line(x1, y1, x2, y2 float64, options *Options) Drawable
			func (*Generator).LinearPath(points []Point, options *Options) Drawable
			func (*Generator).Path(pathData string, options *Options) Drawable
			func (*Generator).Polygon(points []Point, options *Options) Drawable
			func (*Generator).Rectangle(x, y, width, height float64, options *Options) Drawable

	 type OpType string (basic type)
		OpType identifies a primitive path operation.

		As Types Of (total 4)
			const OpBCurveTo
			const OpLineTo
			const OpMove
			const OpQCurveTo

	 type PathInfo (struct)
		PathInfo is the SVG-oriented representation of an operation set.

		Fields (total 5)
			D string
			Fill string
			Pattern *PatternInfo
			Stroke string
			StrokeWidth float64
		As Outputs Of (at least one exported)
			func (*Generator).ToPaths(d Drawable) []PathInfo

	 type PatternInfo (struct)
		PatternInfo describes the pattern used by a patterned SVG path fill.

		Fields (total 7)
			Height float64
			Path PathInfo
			PatternUnits string
			ViewBox string
			Width float64
			X float64
			Y float64

	 type Point ([...])
		Point is a two-dimensional coordinate.

		As Inputs Of (at least 3)
			func (*Generator).Curve(points []Point, options *Options) Drawable
			func (*Generator).LinearPath(points []Point, options *Options) Drawable
			func (*Generator).Polygon(points []Point, options *Options) Drawable

	 type Rectangle (struct)
		Rectangle is an axis-aligned rectangle.

		Fields (total 4)
			Height float64
			Width float64
			X float64
			Y float64

	 type ResolvedOptions (struct)
		ResolvedOptions is the complete option set used by the renderer.

		Fields (total 28)
			Bowing float64
			CurveFitting float64
			CurveStepCount float64
			CurveTightness float64
			DashGap float64
			DashOffset float64
			DisableMultiStroke bool
			DisableMultiStrokeFill bool
			Fill string
			FillLineDash []float64
			FillLineDashOffset float64
			FillShapeRoughnessGain float64
			FillStyle string
			FillWeight float64
			FixedDecimalPlaceDigits *float64
			HachureAngle float64
			HachureGap float64
			MaxRandomnessOffset float64
			PreserveVertices bool
			Roughness float64
			RoughnessGain float64
				RoughnessGain is retained for source compatibility with v0.1.0. Rough.js
				4.6.6 computes the gain per line and no longer mutates this field.

			Seed float64
			Simplification float64
			Stroke string
			StrokeLineDash []float64
			StrokeLineDashOffset float64
			StrokeWidth float64
			ZigzagOffset float64
		As Outputs Of (at least one exported)
			func (*Generator).DefaultOptions() ResolvedOptions

	 type Surface (struct)
		Surface supplies the fallback dimensions used for patterned SVG path fills.

		Fields (total 2)
			Height float64
			Width float64
		As Inputs Of (at least one exported)
			func NewGenerator(config *Config, surface ...*Surface) *Generator


Package-Level Functions (total 6)

	 func Bool(v bool) *bool
		Bool returns a pointer suitable for a boolean Options field.

	 func Float64(v float64) *float64
		Float64 returns a pointer suitable for a numeric Options field.

	 func NewGenerator(config *Config, surface ...*Surface) *Generator
		NewGenerator creates a generator. A nil config uses Rough.js 4.6.6's
		defaults. The optional surface supplies patterned-path fallback dimensions.

	 func NewSeed() float64
		NewSeed returns a nondeterministic seed in Rough.js's supported range.

	 func NumberString(v float64) string
		NumberString formats v the way JavaScript coerces a Number to a string.
		It is useful when surrounding SVG serialization must remain byte-compatible
		with Rough.js output.

	 func String(v string) *string
		String returns a pointer suitable for a string Options field.


Package-Level Constants (total 9)

	const OpBCurveTo OpType = "bcurveTo"
	const OpLineTo OpType = "lineTo"
	const OpMove OpType = "move"
	const OpQCurveTo OpType = "qcurveTo"
	const OpSetFillPath OpSetType = "fillPath"
	const OpSetFillSketch OpSetType = "fillSketch"
	const OpSetPath OpSetType = "path"
	const OpSetPath2DFill OpSetType = "path2Dfill"
	const OpSetPath2DPattern OpSetType = "path2Dpattern"

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.