package draw

Import Path
	image/draw (on golang.org and go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files
	   d➜ draw.go
		Package draw provides image composition functions.

		See "The Go image/draw package" for an introduction to this package:
		https://golang.org/doc/articles/image_draw.html
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Drawer (interface)
		Drawer contains the Draw method.

		Methods (only one)
			( T) Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point)
				Draw aligns r.Min in dst with sp in src and then replaces the
				rectangle r in dst with the result of drawing src on dst.

		Implemented By (at least one exported)
			 Op
		As Types Of (only one)
			  var FloydSteinberg

	 type Image (interface)
		Image is an image.Image with a Set method to change a single pixel.

		Methods (total 4)
			( T) At(x, y int) color.Color
				At returns the color of the pixel at (x, y).
				At(Bounds().Min.X, Bounds().Min.Y) returns the upper-left pixel of the grid.
				At(Bounds().Max.X-1, Bounds().Max.Y-1) returns the lower-right one.

			( T) Bounds() image.Rectangle
				Bounds returns the domain for which At can return non-zero color.
				The bounds do not necessarily contain the point (0, 0).

			( T) ColorModel() color.Model
				ColorModel returns the Image's color model.

			( T) Set(x, y int, c color.Color)
		Implemented By (at least 10)
			*image.Alpha
			*image.Alpha16
			*image.CMYK
			*image.Gray
			*image.Gray16
			*image.NRGBA
			*image.NRGBA64
			*image.Paletted
			*image.RGBA
			*image.RGBA64
		Implements (at least one exported)
			 T : image.Image
		As Inputs Of (at least 4)
			func Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point, op Op)
			func DrawMask(dst Image, r image.Rectangle, src image.Image, sp image.Point, mask image.Image, mp image.Point, op Op)
			func Drawer.Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point)
			func Op.Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point)

	 type Op int (basic type)
		Op is a Porter-Duff compositing operator.

		Methods (only one)
			( T) Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point)
				Draw implements the Drawer interface by calling the Draw function with this
				Op.

		Implements (at least one exported)
			 T : Drawer
		As Inputs Of (at least 2)
			func Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point, op Op)
			func DrawMask(dst Image, r image.Rectangle, src image.Image, sp image.Point, mask image.Image, mp image.Point, op Op)
		As Types Of (total 2)
			const Over
			const Src

	 type Quantizer (interface)
		Quantizer produces a palette for an image.

		Methods (only one)
			( T) Quantize(p color.Palette, m image.Image) color.Palette
				Quantize appends up to cap(p) - len(p) colors to p and returns the
				updated palette suitable for converting m to a paletted image.



Package-Level Functions (total 2)

	 func Draw(dst Image, r image.Rectangle, src image.Image, sp image.Point, op Op)
		Draw calls DrawMask with a nil mask.

	 func DrawMask(dst Image, r image.Rectangle, src image.Image, sp image.Point, mask image.Image, mp image.Point, op Op)
		DrawMask aligns r.Min in dst with sp in src and mp in mask and then replaces the rectangle r
		in dst with the result of a Porter-Duff composition. A nil mask is treated as opaque.


Package-Level Variables (only one)

	  var FloydSteinberg Drawer
		FloydSteinberg is a Drawer that is the Src Op with Floyd-Steinberg error
		diffusion.


Package-Level Constants (total 2)

	const Over Op = 0
		Over specifies ``(src in mask) over dst''.

	const Src Op = 1
		Src specifies ``src in mask''.

The pages are generated with Golds v0.2.5. (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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.