package color

Import Path
	image/color (on go.dev)

Dependency Relation
	imports 0 packages, and imported by 2 packages

Involved Source Files

	  d color.go
		Package color implements a basic color library.

	    ycbcr.go
Package-Level Type Names (total 15, in which 14 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Alpha (struct)
		Alpha represents an 8-bit alpha color.

		Fields (only one, which is exported)
			A uint8
		Methods (only one, which is exported)
			( Alpha) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 Alpha : Color
		As Outputs Of (at least one exported)
			func image.(*Alpha).AlphaAt(x, y int) Alpha
		As Inputs Of (at least one exported)
			func image.(*Alpha).SetAlpha(x, y int, c Alpha)

	 type Alpha16 (struct)
		Alpha16 represents a 16-bit alpha color.

		Fields (only one, which is exported)
			A uint16
		Methods (only one, which is exported)
			( Alpha16) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 Alpha16 : Color
		As Outputs Of (at least one exported)
			func image.(*Alpha16).Alpha16At(x, y int) Alpha16
		As Inputs Of (at least one exported)
			func image.(*Alpha16).SetAlpha16(x, y int, c Alpha16)
		As Types Of (total 2, both are exported)
			  var Opaque
			  var Transparent

	 type CMYK (struct)
		CMYK represents a fully opaque CMYK color, having 8 bits for each of cyan,
		magenta, yellow and black.
		
		It is not associated with any particular color profile.

		Fields (total 4, all are exported)
			C uint8
			K uint8
			M uint8
			Y uint8
		Methods (only one, which is exported)
			( CMYK) RGBA() (uint32, uint32, uint32, uint32)
		Implements (at least one exported)
			 CMYK : Color
		As Outputs Of (at least one exported)
			func image.(*CMYK).CMYKAt(x, y int) CMYK
		As Inputs Of (at least one exported)
			func image.(*CMYK).SetCMYK(x, y int, c CMYK)

	 type Color (interface)
		Color can convert itself to alpha-premultiplied 16-bits per channel RGBA.
		The conversion may be lossy.

		Methods (only one, which is exported)
			( Color) RGBA() (r, g, b, a uint32)
				RGBA returns the alpha-premultiplied red, green, blue and alpha values
				for the color. Each value ranges within [0, 0xffff], but is represented
				by a uint32 so that multiplying by a blend factor up to 0xffff will not
				overflow.
				
				An alpha-premultiplied color component c has been scaled by alpha (a),
				so has valid values 0 <= c <= a.

		Implemented By (at least 12, all are exported)
			 Alpha
			 Alpha16
			 CMYK
			 Gray
			 Gray16
			 NRGBA
			 NRGBA64
			 NYCbCrA
			 RGBA
			 RGBA64
			 YCbCr
			*image.Uniform
		As Outputs Of (at least 31, in which 20 are exported)
			func Model.Convert(c Color) Color
			func Palette.Convert(c Color) Color
			func image.(*Alpha).At(x, y int) Color
			func image.(*Alpha16).At(x, y int) Color
			func image.(*CMYK).At(x, y int) Color
			func image.(*Gray).At(x, y int) Color
			func image.(*Gray16).At(x, y int) Color
			func image.Image.At(x, y int) Color
			func image.(*NRGBA).At(x, y int) Color
			func image.(*NRGBA64).At(x, y int) Color
			func image.(*NYCbCrA).At(x, y int) Color
			func image.(*Paletted).At(x, y int) Color
			func image.PalettedImage.At(x, y int) Color
			func image.Rectangle.At(x, y int) Color
			func image.(*RGBA).At(x, y int) Color
			func image.(*RGBA64).At(x, y int) Color
			func image.RGBA64Image.At(x, y int) Color
			func image.(*Uniform).At(x, y int) Color
			func image.(*Uniform).Convert(Color) Color
			func image.(*YCbCr).At(x, y int) Color
			/* 11+ unexporteds ... *//* 11+ unexporteds: */
			func alpha16Model(c Color) Color
			func alphaModel(c Color) Color
			func cmykModel(c Color) Color
			func gray16Model(c Color) Color
			func grayModel(c Color) Color
			func nrgba64Model(c Color) Color
			func nrgbaModel(c Color) Color
			func nYCbCrAModel(c Color) Color
			func rgba64Model(c Color) Color
			func rgbaModel(c Color) Color
			func yCbCrModel(c Color) Color
		As Inputs Of (at least 26, in which 15 are exported)
			func Model.Convert(c Color) Color
			func Palette.Convert(c Color) Color
			func Palette.Index(c Color) int
			func image.NewUniform(c Color) *image.Uniform
			func image.(*Alpha).Set(x, y int, c Color)
			func image.(*Alpha16).Set(x, y int, c Color)
			func image.(*CMYK).Set(x, y int, c Color)
			func image.(*Gray).Set(x, y int, c Color)
			func image.(*Gray16).Set(x, y int, c Color)
			func image.(*NRGBA).Set(x, y int, c Color)
			func image.(*NRGBA64).Set(x, y int, c Color)
			func image.(*Paletted).Set(x, y int, c Color)
			func image.(*RGBA).Set(x, y int, c Color)
			func image.(*RGBA64).Set(x, y int, c Color)
			func image.(*Uniform).Convert(Color) Color
			/* 11+ unexporteds ... *//* 11+ unexporteds: */
			func alpha16Model(c Color) Color
			func alphaModel(c Color) Color
			func cmykModel(c Color) Color
			func gray16Model(c Color) Color
			func grayModel(c Color) Color
			func nrgba64Model(c Color) Color
			func nrgbaModel(c Color) Color
			func nYCbCrAModel(c Color) Color
			func rgba64Model(c Color) Color
			func rgbaModel(c Color) Color
			func yCbCrModel(c Color) Color
		As Types Of (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			  var rsc.io/qr.blackColor
			  var rsc.io/qr.whiteColor

	 type Gray (struct)
		Gray represents an 8-bit grayscale color.

		Fields (only one, which is exported)
			Y uint8
		Methods (only one, which is exported)
			( Gray) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 Gray : Color
		As Outputs Of (at least one exported)
			func image.(*Gray).GrayAt(x, y int) Gray
		As Inputs Of (at least one exported)
			func image.(*Gray).SetGray(x, y int, c Gray)

	 type Gray16 (struct)
		Gray16 represents a 16-bit grayscale color.

		Fields (only one, which is exported)
			Y uint16
		Methods (only one, which is exported)
			( Gray16) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 Gray16 : Color
		As Outputs Of (at least one exported)
			func image.(*Gray16).Gray16At(x, y int) Gray16
		As Inputs Of (at least one exported)
			func image.(*Gray16).SetGray16(x, y int, c Gray16)
		As Types Of (total 2, both are exported)
			  var Black
			  var White

	 type Model (interface)
		Model can convert any Color to one from its own color model. The conversion
		may be lossy.

		Methods (only one, which is exported)
			( Model) Convert(c Color) Color
		Implemented By (at least 3, in which 2 are exported)
			 Palette
			*image.Uniform
			/* at least one unexported ... *//* at least one unexported: */
			*modelFunc
		As Outputs Of (at least 18, all are exported)
			func ModelFunc(f func(Color) Color) Model
			func image.(*Alpha).ColorModel() Model
			func image.(*Alpha16).ColorModel() Model
			func image.(*CMYK).ColorModel() Model
			func image.(*Gray).ColorModel() Model
			func image.(*Gray16).ColorModel() Model
			func image.Image.ColorModel() Model
			func image.(*NRGBA).ColorModel() Model
			func image.(*NRGBA64).ColorModel() Model
			func image.(*NYCbCrA).ColorModel() Model
			func image.(*Paletted).ColorModel() Model
			func image.PalettedImage.ColorModel() Model
			func image.Rectangle.ColorModel() Model
			func image.(*RGBA).ColorModel() Model
			func image.(*RGBA64).ColorModel() Model
			func image.RGBA64Image.ColorModel() Model
			func image.(*Uniform).ColorModel() Model
			func image.(*YCbCr).ColorModel() Model
		As Types Of (total 11, all are exported)
			  var Alpha16Model
			  var AlphaModel
			  var CMYKModel
			  var Gray16Model
			  var GrayModel
			  var NRGBA64Model
			  var NRGBAModel
			  var NYCbCrAModel
			  var RGBA64Model
			  var RGBAModel
			  var YCbCrModel

	 type NRGBA (struct)
		NRGBA represents a non-alpha-premultiplied 32-bit color.

		Fields (total 4, all are exported)
			A uint8
			B uint8
			G uint8
			R uint8
		Methods (only one, which is exported)
			( NRGBA) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 NRGBA : Color
		As Outputs Of (at least one exported)
			func image.(*NRGBA).NRGBAAt(x, y int) NRGBA
		As Inputs Of (at least one exported)
			func image.(*NRGBA).SetNRGBA(x, y int, c NRGBA)

	 type NRGBA64 (struct)
		NRGBA64 represents a non-alpha-premultiplied 64-bit color,
		having 16 bits for each of red, green, blue and alpha.

		Fields (total 4, all are exported)
			A uint16
			B uint16
			G uint16
			R uint16
		Methods (only one, which is exported)
			( NRGBA64) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 NRGBA64 : Color
		As Outputs Of (at least one exported)
			func image.(*NRGBA64).NRGBA64At(x, y int) NRGBA64
		As Inputs Of (at least one exported)
			func image.(*NRGBA64).SetNRGBA64(x, y int, c NRGBA64)

	 type NYCbCrA (struct)
		NYCbCrA represents a non-alpha-premultiplied Y'CbCr-with-alpha color, having
		8 bits each for one luma, two chroma and one alpha component.

		Fields (total 5, all are exported)
			A uint8
			YCbCr YCbCr
			YCbCr.Cb uint8
			YCbCr.Cr uint8
			YCbCr.Y uint8
		Methods (only one, which is exported)
			( NYCbCrA) RGBA() (uint32, uint32, uint32, uint32)
		Implements (at least one exported)
			 NYCbCrA : Color
		As Outputs Of (at least one exported)
			func image.(*NYCbCrA).NYCbCrAAt(x, y int) NYCbCrA

	 type Palette ([])
		Palette is a palette of colors.

		Methods (total 2, both are exported)
			( Palette) Convert(c Color) Color
				Convert returns the palette color closest to c in Euclidean R,G,B space.

			( Palette) Index(c Color) int
				Index returns the index of the palette color closest to c in Euclidean
				R,G,B,A space.

		Implements (at least one exported)
			 Palette : Model
		As Inputs Of (at least one exported)
			func image.NewPaletted(r image.Rectangle, p Palette) *image.Paletted

	 type RGBA (struct)
		RGBA represents a traditional 32-bit alpha-premultiplied color, having 8
		bits for each of red, green, blue and alpha.
		
		An alpha-premultiplied color component C has been scaled by alpha (A), so
		has valid values 0 <= C <= A.

		Fields (total 4, all are exported)
			A uint8
			B uint8
			G uint8
			R uint8
		Methods (only one, which is exported)
			( RGBA) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 RGBA : Color
		As Outputs Of (at least one exported)
			func image.(*RGBA).RGBAAt(x, y int) RGBA
		As Inputs Of (at least one exported)
			func image.(*RGBA).SetRGBA(x, y int, c RGBA)

	 type RGBA64 (struct)
		RGBA64 represents a 64-bit alpha-premultiplied color, having 16 bits for
		each of red, green, blue and alpha.
		
		An alpha-premultiplied color component C has been scaled by alpha (A), so
		has valid values 0 <= C <= A.

		Fields (total 4, all are exported)
			A uint16
			B uint16
			G uint16
			R uint16
		Methods (only one, which is exported)
			( RGBA64) RGBA() (r, g, b, a uint32)
		Implements (at least one exported)
			 RGBA64 : Color
		As Outputs Of (at least 15, all are exported)
			func image.(*Alpha).RGBA64At(x, y int) RGBA64
			func image.(*Alpha16).RGBA64At(x, y int) RGBA64
			func image.(*CMYK).RGBA64At(x, y int) RGBA64
			func image.(*Gray).RGBA64At(x, y int) RGBA64
			func image.(*Gray16).RGBA64At(x, y int) RGBA64
			func image.(*NRGBA).RGBA64At(x, y int) RGBA64
			func image.(*NRGBA64).RGBA64At(x, y int) RGBA64
			func image.(*NYCbCrA).RGBA64At(x, y int) RGBA64
			func image.(*Paletted).RGBA64At(x, y int) RGBA64
			func image.Rectangle.RGBA64At(x, y int) RGBA64
			func image.(*RGBA).RGBA64At(x, y int) RGBA64
			func image.(*RGBA64).RGBA64At(x, y int) RGBA64
			func image.RGBA64Image.RGBA64At(x, y int) RGBA64
			func image.(*Uniform).RGBA64At(x, y int) RGBA64
			func image.(*YCbCr).RGBA64At(x, y int) RGBA64
		As Inputs Of (at least 10, all are exported)
			func image.(*Alpha).SetRGBA64(x, y int, c RGBA64)
			func image.(*Alpha16).SetRGBA64(x, y int, c RGBA64)
			func image.(*CMYK).SetRGBA64(x, y int, c RGBA64)
			func image.(*Gray).SetRGBA64(x, y int, c RGBA64)
			func image.(*Gray16).SetRGBA64(x, y int, c RGBA64)
			func image.(*NRGBA).SetRGBA64(x, y int, c RGBA64)
			func image.(*NRGBA64).SetRGBA64(x, y int, c RGBA64)
			func image.(*Paletted).SetRGBA64(x, y int, c RGBA64)
			func image.(*RGBA).SetRGBA64(x, y int, c RGBA64)
			func image.(*RGBA64).SetRGBA64(x, y int, c RGBA64)

	 type YCbCr (struct)
		YCbCr represents a fully opaque 24-bit Y'CbCr color, having 8 bits each for
		one luma and two chroma components.
		
		JPEG, VP8, the MPEG family and other codecs use this color model. Such
		codecs often use the terms YUV and Y'CbCr interchangeably, but strictly
		speaking, the term YUV applies only to analog video signals, and Y' (luma)
		is Y (luminance) after applying gamma correction.
		
		Conversion between RGB and Y'CbCr is lossy and there are multiple, slightly
		different formulae for converting between the two. This package follows
		the JFIF specification at https://www.w3.org/Graphics/JPEG/jfif3.pdf.

		Fields (total 3, all are exported)
			Cb uint8
			Cr uint8
			Y uint8
		Methods (only one, which is exported)
			( YCbCr) RGBA() (uint32, uint32, uint32, uint32)
		Implements (at least one exported)
			 YCbCr : Color
		As Outputs Of (at least one exported)
			func image.(*YCbCr).YCbCrAt(x, y int) YCbCr

	/* one unexported ... *//* one unexported: */
	 type modelFunc (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			f func(Color) Color
		Methods (only one, which is exported)
			(*modelFunc) Convert(c Color) Color
		Implements (at least one exported)
			*modelFunc : Model


Package-Level Functions (total 17, in which 5 are exported)

	 func CMYKToRGB(c, m, y, k uint8) (uint8, uint8, uint8)
		CMYKToRGB converts a CMYK quadruple to an RGB triple.

	 func ModelFunc(f func(Color) Color) Model
		ModelFunc returns a Model that invokes f to implement the conversion.

	 func RGBToCMYK(r, g, b uint8) (uint8, uint8, uint8, uint8)
		RGBToCMYK converts an RGB triple to a CMYK quadruple.

	 func RGBToYCbCr(r, g, b uint8) (uint8, uint8, uint8)
		RGBToYCbCr converts an RGB triple to a Y'CbCr triple.

	 func YCbCrToRGB(y, cb, cr uint8) (uint8, uint8, uint8)
		YCbCrToRGB converts a Y'CbCr triple to an RGB triple.

	/* 12 unexporteds ... *//* 12 unexporteds: */
	 func alpha16Model(c Color) Color
	 func alphaModel(c Color) Color
	 func cmykModel(c Color) Color
	 func gray16Model(c Color) Color
	 func grayModel(c Color) Color
	 func nrgba64Model(c Color) Color
	 func nrgbaModel(c Color) Color
	 func nYCbCrAModel(c Color) Color
	 func rgba64Model(c Color) Color
	 func rgbaModel(c Color) Color
	 func sqDiff(x, y uint32) uint32
		sqDiff returns the squared-difference of x and y, shifted by 2 so that
		adding four of those won't overflow a uint32.
		
		x and y are both assumed to be in the range [0, 0xffff].

	 func yCbCrModel(c Color) Color
Package-Level Variables (total 15, all are exported)

	  var Alpha16Model Model
		Models for the standard color types.

	  var AlphaModel Model
		Models for the standard color types.

	  var Black Gray16
		Standard colors.

	  var CMYKModel Model
		CMYKModel is the Model for CMYK colors.

	  var Gray16Model Model
		Models for the standard color types.

	  var GrayModel Model
		Models for the standard color types.

	  var NRGBA64Model Model
		Models for the standard color types.

	  var NRGBAModel Model
		Models for the standard color types.

	  var NYCbCrAModel Model
		NYCbCrAModel is the Model for non-alpha-premultiplied Y'CbCr-with-alpha
		colors.

	  var Opaque Alpha16
		Standard colors.

	  var RGBA64Model Model
		Models for the standard color types.

	  var RGBAModel Model
		Models for the standard color types.

	  var Transparent Alpha16
		Standard colors.

	  var White Gray16
		Standard colors.

	  var YCbCrModel Model
		YCbCrModel is the Model for Y'CbCr colors.

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