FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kColor Class Reference

Description

Color as an integer with 8-bit alpha, red, green, and blue components.

Inheritance diagram for kColor:
Inheritance graph

Public Member Functions

k32s kColor_A (kColor color)
 Returns the alpha component of a color value. More...
 
k32s kColor_B (kColor color)
 Returns the blue component of a color value. More...
 
kColor kColor_FromArgb (k32s alpha, k32s red, k32s green, k32s blue)
 Returns a color value with the specified components. More...
 
kColor kColor_FromHsl (k32s hue, k32s saturation, k32s lightness)
 Returns a color value based on the specified hue, saturation, and lightness. More...
 
kColor kColor_FromRgb (k32s red, k32s green, k32s blue)
 Returns a color value with the specified components. More...
 
k32s kColor_G (kColor color)
 Returns the green component of a color value. More...
 
k32s kColor_R (kColor color)
 Returns the red component of a color value. More...
 
kStatus kColor_ToArgb (kColor color, k32s *alpha, k32s *red, k32s *green, k32s *blue)
 Gets the alpha, red, green, and blue components from a color value. More...
 
kStatus kColor_ToHsl (kColor color, k32s *hue, k32s *saturation, k32s *lightness)
 Computes hue, saturation, and lightness values from a given color value. More...
 
kStatus kColor_ToRgb (kColor color, k32s *red, k32s *green, k32s *blue)
 Gets the red, green, and blue components from a color value. More...
 

Related

#define kCOLOR_ARGB_MAX
 Maximum value for an alpha, red, green, or blue color component.
 
#define kCOLOR_HSL_MAX
 Maximum value for a hue, saturation, or lightness value.
 
#define kCOLOR_ALPHA_OPAQUE
 Alpha value of an opaque color.
 
#define kCOLOR_ALPHA_CLEAR
 Alpha value of a transparent color.
 
#define kCOLOR_ALICE_BLUE
 Alice blue.
 
#define kCOLOR_ANTIQUE_WHITE
 Antique white.
 
#define kCOLOR_AQUA
 Aqua.
 
#define kCOLOR_AQUAMARINE
 Aquamarine.
 
#define kCOLOR_AZURE
 Azure.
 
#define kCOLOR_BEIGE
 Beige.
 
#define kCOLOR_BISQUE
 Bisque.
 
#define kCOLOR_BLACK
 Black.
 
#define kCOLOR_BLANCHED_ALMOND
 Blanched almond.
 
#define kCOLOR_BLUE
 Blue.
 
#define kCOLOR_BLUE_VIOLET
 Blue violet.
 
#define kCOLOR_BROWN
 Brown.
 
#define kCOLOR_BURLY_WOOD
 Burly wood.
 
#define kCOLOR_CADET_BLUE
 Cadet blue.
 
#define kCOLOR_CHARTREUSE
 Chartreuse.
 
#define kCOLOR_CHOCOLATE
 Chocolate.
 
#define kCOLOR_CORAL
 Coral.
 
#define kCOLOR_CORNFLOWER_BLUE
 Cornflower blue.
 
#define kCOLOR_CORNSILK
 Cornsilk.
 
#define kCOLOR_CRIMSON
 Crimson.
 
#define kCOLOR_CYAN
 Cyan.
 
#define kCOLOR_DARK_BLUE
 Dark blue.
 
#define kCOLOR_DARK_CYAN
 Dark cyan.
 
#define kCOLOR_DARK_GOLDENROD
 Dark goldenrod.
 
#define kCOLOR_DARK_GRAY
 Dark gray.
 
#define kCOLOR_DARK_GREEN
 Dark green.
 
#define kCOLOR_DARK_KHAKI
 Dark khaki.
 
#define kCOLOR_DARK_MAGENTA
 Dark magenta.
 
#define kCOLOR_DARK_OLIVE_GREEN
 Dark olive green.
 
#define kCOLOR_DARK_ORANGE
 Dark orange.
 
#define kCOLOR_DARK_ORCHID
 Dark orchid.
 
#define kCOLOR_DARK_RED
 Dark red.
 
#define kCOLOR_DARK_SALMON
 Dark salmon.
 
#define kCOLOR_DARK_SEA_GREEN
 Dark sea green.
 
#define kCOLOR_DARK_SLATE_BLUE
 Dark slate blue.
 
#define kCOLOR_DARK_SLATE_GRAY
 Dark slate gray.
 
#define kCOLOR_DARK_TURQUOISE
 Dark turquoise.
 
#define kCOLOR_DARK_VIOLET
 Dark violet.
 
#define kCOLOR_DEEP_PINK
 Deep pink.
 
#define kCOLOR_DEEP_SKY_BLUE
 Deep sky blue.
 
#define kCOLOR_DIM_GRAY
 Dim gray.
 
#define kCOLOR_DODGER_BLUE
 Dodger blue.
 
#define kCOLOR_FIRE_BRICK
 Fire brick.
 
#define kCOLOR_FLORAL_WHITE
 Floral white.
 
#define kCOLOR_FOREST_GREEN
 Forest green.
 
#define kCOLOR_FUCHSIA
 Fuchsia.
 
#define kCOLOR_GAINSBORO
 Gainsboro.
 
#define kCOLOR_GHOST_WHITE
 Ghost white.
 
#define kCOLOR_GOLD
 Gold.
 
#define kCOLOR_GOLDENROD
 Goldenrod.
 
#define kCOLOR_GRAY
 Gray.
 
#define kCOLOR_GREEN
 Green.
 
#define kCOLOR_GREEN_YELLOW
 Green yellow.
 
#define kCOLOR_HONEYDEW
 Honeydew.
 
#define kCOLOR_HOT_PINK
 Hot pink.
 
#define kCOLOR_INDIAN_RED
 Indian red.
 
#define kCOLOR_INDIGO
 Indigo.
 
#define kCOLOR_IVORY
 Ivory.
 
#define kCOLOR_KHAKI
 Khaki.
 
#define kCOLOR_LAVENDER
 Lavender.
 
#define kCOLOR_LAVENDER_BLUSH
 Lavender blush.
 
#define kCOLOR_LAWN_GREEN
 Lawn green.
 
#define kCOLOR_LEMON_CHIFFON
 Lemon chiffon.
 
#define kCOLOR_LIGHT_BLUE
 Light blue.
 
#define kCOLOR_LIGHT_CORAL
 Light coral.
 
#define kCOLOR_LIGHT_CYAN
 Light cyan.
 
#define kCOLOR_LIGHT_GOLDENROD_YELLOW
 Light goldenrod yellow.
 
#define kCOLOR_LIGHT_GRAY
 Light gray.
 
#define kCOLOR_LIGHT_GREEN
 Light green.
 
#define kCOLOR_LIGHT_PINK
 Light pink.
 
#define kCOLOR_LIGHT_SALMON
 Light salmon.
 
#define kCOLOR_LIGHT_SEA_GREEN
 Light sea green.
 
#define kCOLOR_LIGHT_SKY_BLUE
 Light sky blue.
 
#define kCOLOR_LIGHT_SLATE_GRAY
 Light slate gray.
 
#define kCOLOR_LIGHT_STEEL_BLUE
 Light steel blue.
 
#define kCOLOR_LIGHT_YELLOW
 Light yellow.
 
#define kCOLOR_LIME
 Lime.
 
#define kCOLOR_LIME_GREEN
 Lime green.
 
#define kCOLOR_LINEN
 Linen.
 
#define kCOLOR_MAGENTA
 Magenta.
 
#define kCOLOR_MAROON
 Maroon.
 
#define kCOLOR_MEDIUM_AQUAMARINE
 Medium aquamarine.
 
#define kCOLOR_MEDIUM_BLUE
 Medium blue.
 
#define kCOLOR_MEDIUM_ORCHID
 Medium orchid.
 
#define kCOLOR_MEDIUM_PURPLE
 Medium purple.
 
#define kCOLOR_MEDIUM_SEA_GREEN
 Medium sea green.
 
#define kCOLOR_MEDIUM_SLATE_BLUE
 Medium slate blue.
 
#define kCOLOR_MEDIUM_SPRING_GREEN
 Medium spring green.
 
#define kCOLOR_MEDIUM_TURQUOISE
 Medium turquoise.
 
#define kCOLOR_MEDIUM_VIOLET_RED
 Medium violet red.
 
#define kCOLOR_MIDNIGHT_BLUE
 Midnight blue.
 
#define kCOLOR_MINT_CREAM
 Mint cream.
 
#define kCOLOR_MISTY_ROSE
 Misty rose.
 
#define kCOLOR_MOCCASIN
 Moccasin.
 
#define kCOLOR_NAVAJO_WHITE
 Navajo white.
 
#define kCOLOR_NAVY
 Navy.
 
#define kCOLOR_OLD_LACE
 Old lace.
 
#define kCOLOR_OLIVE
 Olive.
 
#define kCOLOR_OLIVE_DRAB
 Olive drab.
 
#define kCOLOR_ORANGE
 Orange.
 
#define kCOLOR_ORANGE_RED
 Orange red.
 
#define kCOLOR_ORCHID
 Orchid.
 
#define kCOLOR_PALE_GOLDENROD
 Pale goldenrod.
 
#define kCOLOR_PALE_GREEN
 Pale green.
 
#define kCOLOR_PALE_TURQUOISE
 Pale turquoise.
 
#define kCOLOR_PALE_VIOLET_RED
 Pale violet red.
 
#define kCOLOR_PAPAYA_WHIP
 Papaya whip.
 
#define kCOLOR_PEACH_PUFF
 Peach puff.
 
#define kCOLOR_PERU
 Peru.
 
#define kCOLOR_PINK
 Pink.
 
#define kCOLOR_PLUM
 Plum.
 
#define kCOLOR_POWDER_BLUE
 Powder blue.
 
#define kCOLOR_PURPLE
 Purple.
 
#define kCOLOR_RED
 Red.
 
#define kCOLOR_ROSY_BROWN
 Rosy brown.
 
#define kCOLOR_ROYAL_BLUE
 Royal blue.
 
#define kCOLOR_SADDLE_BROWN
 Saddle brown.
 
#define kCOLOR_SALMON
 Salmon.
 
#define kCOLOR_SANDY_BROWN
 Sandy brown.
 
#define kCOLOR_SEA_GREEN
 Sea green.
 
#define kCOLOR_SEA_SHELL
 Sea shell.
 
#define kCOLOR_SIENNA
 Sienna.
 
#define kCOLOR_SILVER
 Silver.
 
#define kCOLOR_SKY_BLUE
 Sky blue.
 
#define kCOLOR_SLATE_BLUE
 Slate blue.
 
#define kCOLOR_SLATE_GRAY
 Slate gray.
 
#define kCOLOR_SNOW
 Snow.
 
#define kCOLOR_SPRING_GREEN
 Spring green.
 
#define kCOLOR_STEEL_BLUE
 Steel blue.
 
#define kCOLOR_TAN
 Tan.
 
#define kCOLOR_TEAL
 Teal.
 
#define kCOLOR_THISTLE
 Thistle.
 
#define kCOLOR_TOMATO
 Tomato.
 
#define kCOLOR_TRANSPARENT
 Transparent.
 
#define kCOLOR_TURQUOISE
 Turquoise.
 
#define kCOLOR_VIOLET
 Violet.
 
#define kCOLOR_WHEAT
 Wheat.
 
#define kCOLOR_WHITE
 White.
 
#define kCOLOR_WHITE_SMOKE
 White smoke.
 
#define kCOLOR_YELLOW
 Yellow.
 
#define kCOLOR_YELLOW_GREEN
 Yellow green.
 

The documentation for this class was generated from the following file: