color

Documentation

Overview

Package color provides support for Allegro's color addon.

Index

• Constants
• func Cmyk(cyan, magenta, yellow, key float32) allegro.Color
• func CmykToRgb(cyan, magenta, yellow, key float32) (red, green, blue float32)
• func ForName(name Name) allegro.Color
• func Hsl(hue, saturation, lightness float32) allegro.Color
• func HslToRgb(hue, saturation, lightness float32) (red, green, blue float32)
• func HsvToRgb(hue, saturation, value float32) (red, green, blue float32)
• func HtmlToRgb(str string) (red, green, blue float32)
• func NameToRgb(name Name) (red, green, blue float32, err error)
• func RgbToCmyk(red, green, blue float32) (cyan, magenta, yellow, key float32)
• func RgbToHsl(red, green, blue float32) (hue, saturation, lightness float32)
• func RgbToHsv(red, green, blue float32) (hue, saturation, value float32)
• func RgbToHtml(red, green, blue float32) string
• func RgbToName(red, green, blue float32) string
• func RgbToYuv(red, green, blue float32) (y, u, v float32)
• func Version() (major, minor, revision, release uint8)
• func Yuv(y, u, v float32) allegro.Color
• func YuvToRgb(y, u, v float32) (red, green, blue float32)
• type Name

Constants

const (
	ALICE_BLUE             Name = "aliceblue"
	ANTIQUE_WHITE               = "antiquewhite"
	AQUA                        = "aqua"
	AQUAMARINE                  = "aquamarine"
	AZURE                       = "azure"
	BEIGE                       = "beige"
	BISQUE                      = "bisque"
	BLACK                       = "black"
	BLANCHED_ALMOND             = "blanchedalmond"
	BLUE                        = "blue"
	BLUE_VIOLET                 = "blueviolet"
	BROWN                       = "brown"
	BURLYWOOD                   = "burlywood"
	CADET_BLUE                  = "cadetblue"
	CHARTREUSE                  = "chartreuse"
	CHOCOLATE                   = "chocolate"
	CORAL                       = "coral"
	CORNFLOWER_BLUE             = "cornflowerblue"
	CORN_SILK                   = "cornsilk"
	CRIMSON                     = "crimson"
	CYAN                        = "cyan"
	DARK_BLUE                   = "darkblue"
	DARK_CYAN                   = "darkcyan"
	DARK_GOLDENROD              = "darkgoldenrod"
	DARK_GRAY                   = "darkgray"
	DARK_GREEN                  = "darkgreen"
	DARK_KHAKI                  = "darkkhaki"
	DARK_MAGENTA                = "darkmagenta"
	DARK_OLIVE_GREEN            = "darkolivegreen"
	DARK_ORANGE                 = "darkorange"
	DARK_ORCHID                 = "darkorchid"
	DARK_RED                    = "darkred"
	DARK_SALMON                 = "darksalmon"
	DARK_SEA_GREEN              = "darkseagreen"
	DARK_SLATE_BLUE             = "darkslateblue"
	DARK_SLATE_GRAY             = "darkslategray"
	DARK_TURQUOISE              = "darkturquoise"
	DARK_VIOLET                 = "darkviolet"
	DEEP_PINK                   = "deeppink"
	DEEP_SKY_BLUE               = "deepskyblue"
	DIM_GRAY                    = "dimgray"
	DODGER_BLUE                 = "dodgerblue"
	FIREBRICK                   = "firebrick"
	FLORAL_WHITE                = "floralwhite"
	FOREST_GREEN                = "forestgreen"
	FUCHSIA                     = "fuchsia"
	GAINSBORO                   = "gainsboro"
	GHOST_WHITE                 = "ghostwhite"
	GOLDENROD                   = "goldenrod"
	GOLD                        = "gold"
	GRAY                        = "gray"
	GREEN                       = "green"
	GREEN_YELLOW                = "greenyellow"
	HONEYDEW                    = "honeydew"
	HOT_PINK                    = "hotpink"
	INDIAN_RED                  = "indianred"
	INDIGO                      = "indigo"
	IVORY                       = "ivory"
	KHAKI                       = "khaki"
	LAVENDER_BLUSH              = "lavenderblush"
	LAVENDER                    = "lavender"
	LAWN_GREEN                  = "lawngreen"
	LEMON_CHIFFON               = "lemonchiffon"
	LIGHT_BLUE                  = "lightblue"
	LIGHT_CORAL                 = "lightcoral"
	LIGHT_CYAN                  = "lightcyan"
	LIGHT_GOLDENROD_YELLOW      = "lightgoldenrodyellow"
	LIGHT_GREEN                 = "lightgreen"
	LIGHT_GREY                  = "lightgrey"
	LIGHT_PINK                  = "lightpink"
	LIGHT_SALMON                = "lightsalmon"
	LIGHT_SEA_GREEN             = "lightseagreen"
	LIGHT_SKY_BLUE              = "lightskyblue"
	LIGHT_SLATE_GRAY            = "lightslategray"
	LIGHT_STEEL_BLUE            = "lightsteelblue"
	LIGHT_YELLOW                = "lightyellow"
	LIME                        = "lime"
	LIME_GREEN                  = "limegreen"
	LINEN                       = "linen"
	MAGENTA                     = "magenta"
	MAROON                      = "maroon"
	MEDIUM_AQUAMARINE           = "mediumaquamarine"
	MEDIUM_BLUE                 = "mediumblue"
	MEDIUM_ORCHID               = "mediumorchid"
	MEDIUM_PURPLE               = "mediumpurple"
	MEDIUM_SEA_GREEN            = "mediumseagreen"
	MEDIUM_SLATE_BLUE           = "mediumslateblue"
	MEDIUM_SPRING_GREEN         = "mediumspringgreen"
	MEDIUM_TURQUOISE            = "mediumturquoise"
	MEDIUM_VIOLET_RED           = "mediumvioletred"
	MIDNIGHT_BLUE               = "midnightblue"
	MINT_CREAM                  = "mintcream"
	MISTY_ROSE                  = "mistyrose"
	MOCCASIN                    = "moccasin"
	NAVAJO_WHITE                = "navajowhite"
	NAVY                        = "navy"
	OLDLACE                     = "oldlace"
	OLIVE                       = "olive"
	OLIVE_DRAB                  = "olivedrab"
	ORANGE                      = "orange"
	ORANGE_RED                  = "orangered"
	ORCHID                      = "orchid"
	PALE_GOLDENROD              = "palegoldenrod"
	PALE_GREEN                  = "palegreen"
	PALE_TURQUOISE              = "paleturquoise"
	PALE_VIOLET_RED             = "palevioletred"
	PAPAYA_WHIP                 = "papayawhip"
	PEACH_PUFF                  = "peachpuff"
	PERU                        = "peru"
	PINK                        = "pink"
	PLUM                        = "plum"
	POWDER_BLUE                 = "powderblue"
	PURPLE                      = "purple"
	RED                         = "red"
	ROSY_BROWN                  = "rosybrown"
	ROYAL_BLUE                  = "royalblue"
	SADDLE_BROWN                = "saddlebrown"
	SALMON                      = "salmon"
	SANDY_BROWN                 = "sandybrown"
	SEA_GREEN                   = "seagreen"
	SEA_SHELL                   = "seashell"
	SIENNA                      = "sienna"
	SILVER                      = "silver"
	SKY_BLUE                    = "skyblue"
	SLATE_BLUE                  = "slateblue"
	SLATE_GRAY                  = "slategray"
	SNOW                        = "snow"
	SPRING_GREEN                = "springgreen"
	STEEL_BLUE                  = "steelblue"
	TAN                         = "tan"
	TEAL                        = "teal"
	THISTLE                     = "thistle"
	TOMATO                      = "tomato"
	TURQUOISE                   = "turquoise"
	VIOLET                      = "violet"
	WHEAT                       = "wheat"
	WHITE                       = "white"
	WHITE_SMOKE                 = "whitesmoke"
	YELLOW                      = "yellow"
	YELLOW_GREEN                = "yellowgreen"
)

Functions

func Cmyk

func Cmyk(cyan, magenta, yellow, key float32) allegro.Color

Return an ALLEGRO_COLOR structure from CMYK values (cyan, magenta, yellow, black).

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_cmyk

func CmykToRgb

func CmykToRgb(cyan, magenta, yellow, key float32) (red, green, blue float32)

Convert CMYK values to RGB values.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_cmyk_to_rgb

func ForName

func ForName(name Name) allegro.Color

ForName returns the Color associated with the given name by mapping it to an RGB Value, and then mapping that to a color. It is equivalent to calling color.NameToRgb followed by allegro.MapRGBf, except that this method panics if an error occurs.

func Hsl

func Hsl(hue, saturation, lightness float32) allegro.Color

Return an ALLEGRO_COLOR structure from HSL (hue, saturation, lightness) values.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_hsl

func HslToRgb

func HslToRgb(hue, saturation, lightness float32) (red, green, blue float32)

Convert values in HSL color model to RGB color model.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_hsl_to_rgb

func HsvToRgb

func HsvToRgb(hue, saturation, value float32) (red, green, blue float32)

Convert values in HSV color model to RGB color model.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_hsv_to_rgb

func HtmlToRgb

func HtmlToRgb(str string) (red, green, blue float32)

Interprets an HTML-style hex number (e.g. #00faff) as a color. The only accepted formats are "#RRGGBB" and "RRGGBB" where R, G, B are hexadecimal digits [0-9A-Fa-f].

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_html_to_rgb

func NameToRgb

func NameToRgb(name Name) (red, green, blue float32, err error)

Parameters:

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_name_to_rgb

func RgbToCmyk

func RgbToCmyk(red, green, blue float32) (cyan, magenta, yellow, key float32)

Each RGB color can be represented in CMYK with a K component of 0 with the following formula:

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_cmyk

func RgbToHsl

func RgbToHsl(red, green, blue float32) (hue, saturation, lightness float32)

Given an RGB triplet with components in the range 0..1, return the hue in degrees from 0..360 and saturation and lightness in the range 0..1.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_hsl

func RgbToHsv

func RgbToHsv(red, green, blue float32) (hue, saturation, value float32)

Given an RGB triplet with components in the range 0..1, return the hue in degrees from 0..360 and saturation and value in the range 0..1.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_hsv

func RgbToHtml

func RgbToHtml(red, green, blue float32) string

Create an HTML-style string representation of an ALLEGRO_COLOR, e.g. #00faff.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_html

func RgbToName

func RgbToName(red, green, blue float32) string

Given an RGB triplet with components in the range 0..1, find a color name describing it approximately.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_name

func RgbToYuv

func RgbToYuv(red, green, blue float32) (y, u, v float32)

Convert RGB values to YUV color space.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_rgb_to_yuv

func Version

func Version() (major, minor, revision, release uint8)

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.

See https://liballeg.org/a5docs/5.2.6/color.html#al_get_allegro_color_version

func Yuv

func Yuv(y, u, v float32) allegro.Color

Return an ALLEGRO_COLOR structure from YUV values.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_yuv

func YuvToRgb

func YuvToRgb(y, u, v float32) (red, green, blue float32)

Convert YUV color values to RGB color space.

See https://liballeg.org/a5docs/5.2.6/color.html#al_color_yuv_to_rgb

Types

type Name

type Name string