color

Documentation

Overview

Package color handles Color components

Index

• Constants
• Variables
• type Gradient
• type GradientDirection
• type Solid
  • func (rc Solid) Alpha(alpha uint8) Solid
  • func (rc Solid) Blend(other Solid, scale float32) Solid
  • func (rc Solid) Inverse() Solid

Constants

const (
	GradientHorizontal = GradientDirection(iota) // GradientHorizontal is a horizontal color.Gradient
	GradientVertical                             // GradientHorizontal is a vertical color.Gradient
)

Directions for a color.Gradient

Variables

var (
	Black      = Solid{A: 255}                         // Black Color
	White      = Solid{R: 255, G: 255, B: 255, A: 255} // White Color
	Magenta    = Solid{R: 255, B: 255, A: 255}         // Magenta Color
	LightGray  = Solid{R: 200, G: 200, B: 200, A: 255} // LightGray is a Light Gray Color
	Gray       = Solid{R: 130, G: 130, B: 130, A: 255} // Gray Color
	DarkGray   = Solid{R: 80, G: 80, B: 80, A: 255}    // DarkGray Dark Gray
	Yellow     = Solid{R: 253, G: 249, A: 255}         // Yellow Color
	Gold       = Solid{R: 255, G: 203, A: 255}         // Gold Color
	Orange     = Solid{R: 255, G: 161, A: 255}         // Orange Color
	Pink       = Solid{R: 255, G: 109, B: 194, A: 255} // Pink Color
	Red        = Solid{R: 230, G: 41, B: 55, A: 255}   // Red Color
	Maroon     = Solid{R: 190, G: 33, B: 55, A: 255}   // Marron Color
	Green      = Solid{G: 228, B: 48, A: 255}          // Green Color
	Lime       = Solid{G: 158, B: 47, A: 255}          // Lime Color
	DarkGreen  = Solid{G: 117, B: 44, A: 255}          // DarkGreen is a Dark Green Color
	SkyBlue    = Solid{R: 102, G: 191, B: 255, A: 255} // SkyBlue Color
	Blue       = Solid{G: 121, B: 241, A: 255}         // Blue Color
	DarkBlue   = Solid{G: 82, B: 172, A: 255}          // DarkBlue is a Dark Blue Color
	Purple     = Solid{R: 200, G: 122, B: 255, A: 255} // Purple Color
	Violet     = Solid{R: 135, G: 60, B: 190, A: 255}  // Violet Color
	DarkPurple = Solid{R: 112, G: 31, B: 126, A: 255}  // DarkPurple is a Dark Purple Color
	Beige      = Solid{R: 211, G: 176, B: 131, A: 255} // Beige Color
	Brown      = Solid{R: 127, G: 106, B: 79, A: 255}  // Brown Color
	DarkBrown  = Solid{R: 76, G: 63, B: 47, A: 255}    // DarkBrown Color
	Gopher     = Solid{R: 106, G: 215, B: 229, A: 255} // Gopher Color
)

var Get = gets{

	Solid: func(e *entity.Entity) Solid {
		return e.Get(TYPE.Solid).(Solid)
	},

	Gradient: func(e *entity.Entity) Gradient {
		return e.Get(TYPE.Gradient).(Gradient)
	},
}

Get a color component

var TYPE = types{
	Solid:    reflect.TypeOf(Solid{}),
	Gradient: reflect.TypeOf(Gradient{}),
}

TYPE hold the reflect.Type for our color components

Types

type Gradient

type Gradient struct {
	From      Solid             // From what color.Solid the gradient stars
	To        Solid             // To what color.Solid the gradient ends
	Direction GradientDirection // Direction is GradientDirection for this color.Gradient
}

Gradient represents a gradient color

type GradientDirection

type GradientDirection int

GradientDirection is the direction of color.Gradient

type Solid

type Solid struct {
	R uint8 // R is the green Color component
	G uint8 // G is the green Color component
	B uint8 // B is the blue Color component
	A uint8 // A is the alpha Color component
}

Solid represents a RGBA color

func (Solid) Alpha

func (rc Solid) Alpha(alpha uint8) Solid

Alpha returns a new Color modifying the A component

func (Solid) Blend

func (rc Solid) Blend(other Solid, scale float32) Solid

Blend the Color with a given Color using an scale

func (Solid) Inverse

func (rc Solid) Inverse() Solid

Inverse the color.Solid