version: 1.10

package color

import "image/color"

Overview

Package color implements a basic color library.

Index

Package files

color.go ycbcr.go

Variables

  1. var (
  2.     Black       = Gray16{0}
  3.     White       = Gray16{0xffff}
  4.     Transparent = Alpha16{0}
  5.     Opaque      = Alpha16{0xffff}
  6. )

Standard colors.

func CMYKToRGB

  1. func CMYKToRGB(c, m, y, k uint8) (uint8, uint8, uint8)

CMYKToRGB converts a CMYK quadruple to an RGB triple.

func RGBToCMYK

  1. func RGBToCMYK(r, g, b uint8) (uint8, uint8, uint8, uint8)

RGBToCMYK converts an RGB triple to a CMYK quadruple.

func RGBToYCbCr

  1. func RGBToYCbCr(r, g, b uint8) (uint8, uint8, uint8)

RGBToYCbCr converts an RGB triple to a Y’CbCr triple.

func YCbCrToRGB

  1. func YCbCrToRGB(y, cb, cr uint8) (uint8, uint8, uint8)

YCbCrToRGB converts a Y’CbCr triple to an RGB triple.

type Alpha

  1. type Alpha struct {
  2.     A uint8
  3. }

Alpha represents an 8-bit alpha color.

func (Alpha) RGBA

  1. func (c Alpha) RGBA() (r, g, b, a uint32)

type Alpha16

  1. type Alpha16 struct {
  2.     A uint16
  3. }

Alpha16 represents a 16-bit alpha color.

func (Alpha16) RGBA

  1. func (c Alpha16) RGBA() (r, g, b, a uint32)

type CMYK

  1. type CMYK struct {
  2.     C, M, Y, K uint8
  3. }

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.

func (CMYK) RGBA

  1. func (c CMYK) RGBA() (uint32, uint32, uint32, uint32)

type Color

  1. type Color interface {
  2.     // RGBA returns the alpha-premultiplied red, green, blue and alpha values
  3.     // for the color. Each value ranges within [0, 0xffff], but is represented
  4.     // by a uint32 so that multiplying by a blend factor up to 0xffff will not
  5.     // overflow.
  6.     //
  7.     // An alpha-premultiplied color component c has been scaled by alpha (a),
  8.     // so has valid values 0 <= c <= a.
  9.     RGBA() (r, g, b, a uint32)
  10. }

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

type Gray

  1. type Gray struct {
  2.     Y uint8
  3. }

Gray represents an 8-bit grayscale color.

func (Gray) RGBA

  1. func (c Gray) RGBA() (r, g, b, a uint32)

type Gray16

  1. type Gray16 struct {
  2.     Y uint16
  3. }

Gray16 represents a 16-bit grayscale color.

func (Gray16) RGBA

  1. func (c Gray16) RGBA() (r, g, b, a uint32)

type Model

  1. type Model interface {
  2.     Convert(c Color) Color
  3. }

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

  1. var (
  2.     RGBAModel    Model = ModelFunc(rgbaModel)
  3.     RGBA64Model  Model = ModelFunc(rgba64Model)
  4.     NRGBAModel   Model = ModelFunc(nrgbaModel)
  5.     NRGBA64Model Model = ModelFunc(nrgba64Model)
  6.     AlphaModel   Model = ModelFunc(alphaModel)
  7.     Alpha16Model Model = ModelFunc(alpha16Model)
  8.     GrayModel    Model = ModelFunc(grayModel)
  9.     Gray16Model  Model = ModelFunc(gray16Model)
  10. )

Models for the standard color types.

  1. var CMYKModel Model = ModelFunc(cmykModel)

CMYKModel is the Model for CMYK colors.

  1. var NYCbCrAModel Model = ModelFunc(nYCbCrAModel)

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

  1. var YCbCrModel Model = ModelFunc(yCbCrModel)

YCbCrModel is the Model for Y’CbCr colors.

func ModelFunc

  1. func ModelFunc(f func(Color) Color) Model

ModelFunc returns a Model that invokes f to implement the conversion.

type NRGBA

  1. type NRGBA struct {
  2.     R, G, B, A uint8
  3. }

NRGBA represents a non-alpha-premultiplied 32-bit color.

func (NRGBA) RGBA

  1. func (c NRGBA) RGBA() (r, g, b, a uint32)

type NRGBA64

  1. type NRGBA64 struct {
  2.     R, G, B, A uint16
  3. }

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

func (NRGBA64) RGBA

  1. func (c NRGBA64) RGBA() (r, g, b, a uint32)

type NYCbCrA

  1. type NYCbCrA struct {
  2.     YCbCr
  3.     A uint8
  4. }

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

func (NYCbCrA) RGBA

  1. func (c NYCbCrA) RGBA() (uint32, uint32, uint32, uint32)

type Palette

  1. type Palette []Color

Palette is a palette of colors.

func (Palette) Convert

  1. func (p Palette) Convert(c Color) Color

Convert returns the palette color closest to c in Euclidean R,G,B space.

func (Palette) Index

  1. func (p Palette) Index(c Color) int

Index returns the index of the palette color closest to c in Euclidean R,G,B,A
space.

type RGBA

  1. type RGBA struct {
  2.     R, G, B, A uint8
  3. }

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.

func (RGBA) RGBA

  1. func (c RGBA) RGBA() (r, g, b, a uint32)

type RGBA64

  1. type RGBA64 struct {
  2.     R, G, B, A uint16
  3. }

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.

func (RGBA64) RGBA

  1. func (c RGBA64) RGBA() (r, g, b, a uint32)

type YCbCr

  1. type YCbCr struct {
  2.     Y, Cb, Cr uint8
  3. }

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 http://www.w3.org/Graphics/JPEG/jfif3.pdf.

func (YCbCr) RGBA

  1. func (c YCbCr) RGBA() (uint32, uint32, uint32, uint32)

Subdirectories