CLRColorUtils Class Reference


                    
                    
                    +toColorFromHexRed:andGreen:andBlue:

Convert the hex color values to a hex color

Declaration

Objective-C

+ (NSString *)toColorFromHexRed:(NSString *)red
                       andGreen:(NSString *)green
                        andBlue:(NSString *)blue;

Swift

class func toColor(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B

Return Value

hex color in format #RRGGBB

Show on GitHub


                    
                    
                    +toColorShorthandFromHexRed:andGreen:andBlue:

Convert the hex color values to a hex color, shorthanded when possible

Declaration

Objective-C

+ (NSString *)toColorShorthandFromHexRed:(NSString *)red
                                andGreen:(NSString *)green
                                 andBlue:(NSString *)blue;

Swift

class func toColorShorthand(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B

Return Value

hex color in format #RGB or #RRGGBB

Show on GitHub


                    
                    
                    +toColorWithAlphaFromHexRed:andGreen:andBlue:

Convert the hex color values to a hex color including an opaque alpha value of FF

Declaration

Objective-C

+ (NSString *)toColorWithAlphaFromHexRed:(NSString *)red
                                andGreen:(NSString *)green
                                 andBlue:(NSString *)blue;

Swift

class func toColorWithAlpha(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B

Return Value

hex color in format #AARRGGBB

Show on GitHub


                    
                    
                    +toColorShorthandWithAlphaFromHexRed:andGreen:andBlue:

Convert the hex color values to a hex color including an opaque alpha value of FF or F, shorthanded when possible

Declaration

Objective-C

+ (NSString *)toColorShorthandWithAlphaFromHexRed:(NSString *)red
                                         andGreen:(NSString *)green
                                          andBlue:(NSString *)blue;

Swift

class func toColorShorthandWithAlpha(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B

Return Value

hex color in format #ARGB or #AARRGGBB

Show on GitHub


                    
                    
                    +toColorWithAlphaFromHexRed:andGreen:andBlue:andAlpha:

Convert the hex color values to a hex color

Declaration

Objective-C

+ (NSString *)toColorWithAlphaFromHexRed:(NSString *)red
                                andGreen:(NSString *)green
                                 andBlue:(NSString *)blue
                                andAlpha:(NSString *)alpha;

Swift

class func toColorWithAlpha(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!, andAlpha alpha: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B
`alpha`	alpha hex color in format AA or A, null to not include alpha

Return Value

hex color in format #AARRGGBB or #RRGGBB

Show on GitHub


                    
                    
                    +toColorShorthandWithAlphaFromHexRed:andGreen:andBlue:andAlpha:

Convert the hex color values to a hex color, shorthanded when possible

Declaration

Objective-C

+ (NSString *)toColorShorthandWithAlphaFromHexRed:(NSString *)red
                                         andGreen:(NSString *)green
                                          andBlue:(NSString *)blue
                                         andAlpha:(NSString *)alpha;

Swift

class func toColorShorthandWithAlpha(fromHexRed red: String!, andGreen green: String!, andBlue blue: String!, andAlpha alpha: String!) -> String!

Parameters

`red`	red hex color in format RR or R
`green`	green hex color in format GG or G
`blue`	blue hex color in format BB or B
`alpha`	alpha hex color in format AA or A, null to not include alpha

Return Value

hex color in format #ARGB, #RGB, #AARRGGBB, or #RRGGBB

Show on GitHub


                    
                    
                    +toColorFromRed:andGreen:andBlue:

Convert the RBG values to a color integer

Declaration

Objective-C

+ (int)toColorFromRed:(int)red andGreen:(int)green andBlue:(int)blue;

Swift

class func toColor(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32) -> Int32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255

Return Value

integer color

Show on GitHub


                    
                    
                    +toUnsignedColorFromRed:andGreen:andBlue:

Convert the RBG values to a color unsigned integer

Declaration

Objective-C

+ (unsigned int)toUnsignedColorFromRed:(int)red
                              andGreen:(int)green
                               andBlue:(int)blue;

Swift

class func toUnsignedColor(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32) -> UInt32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255

Return Value

unsigned integer color

Show on GitHub


                    
                    
                    +toColorWithAlphaFromRed:andGreen:andBlue:

Convert the RBG values to a color integer including an opaque alpha value of 255

Declaration

Objective-C

+ (int)toColorWithAlphaFromRed:(int)red andGreen:(int)green andBlue:(int)blue;

Swift

class func toColorWithAlpha(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32) -> Int32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255

Return Value

integer color

Show on GitHub


                    
                    
                    +toUnsignedColorWithAlphaFromRed:andGreen:andBlue:

Convert the RBG values to a color unsigned integer including an opaque alpha value of 255

Declaration

Objective-C

+ (unsigned int)toUnsignedColorWithAlphaFromRed:(int)red
                                       andGreen:(int)green
                                        andBlue:(int)blue;

Swift

class func toUnsignedColorWithAlpha(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32) -> UInt32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255

Return Value

unsigned integer color

Show on GitHub


                    
                    
                    +toColorWithAlphaFromRed:andGreen:andBlue:andAlpha:

Convert the RBGA values to a color integer

Declaration

Objective-C

+ (int)toColorWithAlphaFromRed:(int)red
                      andGreen:(int)green
                       andBlue:(int)blue
                      andAlpha:(int)alpha;

Swift

class func toColorWithAlpha(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32, andAlpha alpha: Int32) -> Int32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255
`alpha`	alpha integer color inclusively between 0 and 255, -1 to not include alpha

Return Value

integer color

Show on GitHub


                    
                    
                    +toUnsignedColorWithAlphaFromRed:andGreen:andBlue:andAlpha:

Convert the RBGA values to a color unsigned integer

Declaration

Objective-C

+ (unsigned int)toUnsignedColorWithAlphaFromRed:(int)red
                                       andGreen:(int)green
                                        andBlue:(int)blue
                                       andAlpha:(int)alpha;

Swift

class func toUnsignedColorWithAlpha(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32, andAlpha alpha: Int32) -> UInt32

Parameters

`red`	red integer color inclusively between 0 and 255
`green`	green integer color inclusively between 0 and 255
`blue`	blue integer color inclusively between 0 and 255
`alpha`	alpha integer color inclusively between 0 and 255, -1 to not include alpha

Return Value

unsigned integer color

Show on GitHub


                    
                    
                    +toHexFromRGB:

Convert the RGB integer to a hex single color

Declaration

Objective-C

+ (NSString *)toHexFromRGB:(int)color;

Swift

class func toHex(fromRGB color: Int32) -> String!

Parameters


                                color

integer color inclusively between 0 and 255

Return Value

hex single color in format FF

Show on GitHub


                    
                    
                    +toHexFromArithmeticRGB:

Convert the arithmetic RGB float to a hex single color

Declaration

Objective-C

+ (NSString *)toHexFromArithmeticRGB:(float)color;

Swift

class func toHex(fromArithmeticRGB color: Float) -> String!

Parameters


                                color

float color inclusively between 0.0 and 1.0

Return Value

hex single color in format FF

Show on GitHub


                    
                    
                    +toRGBFromHex:

Convert the hex single color to a RBG integer

Declaration

Objective-C

+ (int)toRGBFromHex:(NSString *)color;

Swift

class func toRGB(fromHex color: String!) -> Int32

Parameters


                                color

hex single color in format FF or F

Return Value

integer color inclusively between 0 and 255

Show on GitHub


                    
                    
                    +toRGBFromArithmeticRGB:

Convert the arithmetic RGB float to a RBG integer

Declaration

Objective-C

+ (int)toRGBFromArithmeticRGB:(float)color;

Swift

class func toRGB(fromArithmeticRGB color: Float) -> Int32

Parameters


                                color

float color inclusively between 0.0 and 1.0

Return Value

integer color inclusively between 0 and 255

Show on GitHub


                    
                    
                    +toArithmeticRGBFromHex:

Convert the hex single color to an arithmetic RBG float

Declaration

Objective-C

+ (float)toArithmeticRGBFromHex:(NSString *)color;

Swift

class func toArithmeticRGB(fromHex color: String!) -> Float

Parameters


                                color

hex single color in format FF or F

Return Value

float color inclusively between 0.0 and 1.0

Show on GitHub


                    
                    
                    +toArithmeticRGBFromRGB:

Convert the RGB integer to an arithmetic RBG float

Declaration

Objective-C

+ (float)toArithmeticRGBFromRGB:(int)color;

Swift

class func toArithmeticRGB(fromRGB color: Int32) -> Float

Parameters


                                color

integer color inclusively between 0 and 255

Return Value

float color inclusively between 0.0 and 1.0

Show on GitHub


                    
                    
                    +toHSLFromArithmeticRed:andGreen:andBlue:

Convert red, green, and blue arithmetic values to HSL (hue, saturation, lightness) values

Declaration

Objective-C

+ (float *)toHSLFromArithmeticRed:(float)red
                         andGreen:(float)green
                          andBlue:(float)blue;

Swift

class func toHSL(fromArithmeticRed red: Float, andGreen green: Float, andBlue blue: Float) -> UnsafeMutablePointer<Float>!

Parameters

`red`	red color inclusively between 0.0 and 1.0
`green`	green color inclusively between 0.0 and 1.0
`blue`	blue color inclusively between 0.0 and 1.0

Return Value

HSL array where: 0 = hue, 1 = saturation, 2 = lightness

Show on GitHub


                    
                    
                    +toHSLFromRed:andGreen:andBlue:

Convert red, green, and blue integer values to HSL (hue, saturation, lightness) values

Declaration

Objective-C

+ (float *)toHSLFromRed:(int)red andGreen:(int)green andBlue:(int)blue;

Swift

class func toHSL(fromRed red: Int32, andGreen green: Int32, andBlue blue: Int32) -> UnsafeMutablePointer<Float>!

Parameters

`red`	red color inclusively between 0 and 255
`green`	green color inclusively between 0 and 255
`blue`	blue color inclusively between 0 and 255

Return Value

HSL array where: 0 = hue, 1 = saturation, 2 = lightness

Show on GitHub


                    
                    
                    +toArithmeticRGBFromHue:andSaturation:andLightness:

Convert HSL (hue, saturation, and lightness) values to RGB arithmetic values

Declaration

Objective-C

+ (float *)toArithmeticRGBFromHue:(float)hue
                    andSaturation:(float)saturation
                     andLightness:(float)lightness;

Swift

class func toArithmeticRGB(fromHue hue: Float, andSaturation saturation: Float, andLightness lightness: Float) -> UnsafeMutablePointer<Float>!

Parameters

`hue`	hue value inclusively between 0.0 and 360.0
`saturation`	saturation inclusively between 0.0 and 1.0
`lightness`	lightness inclusively between 0.0 and 1.0

Return Value

arithmetic RGB array where: 0 = red, 1 = green, 2 = blue

Show on GitHub


                    
                    
                    +toRGBFromHue:andSaturation:andLightness:

Convert HSL (hue, saturation, and lightness) values to RGB integer values

Declaration

Objective-C

+ (int *)toRGBFromHue:(float)hue
        andSaturation:(float)saturation
         andLightness:(float)lightness;

Swift

class func toRGB(fromHue hue: Float, andSaturation saturation: Float, andLightness lightness: Float) -> UnsafeMutablePointer<Int32>!

Parameters

`hue`	hue value inclusively between 0.0 and 360.0
`saturation`	saturation inclusively between 0.0 and 1.0
`lightness`	lightness inclusively between 0.0 and 1.0

Return Value

RGB integer array where: 0 = red, 1 = green, 2 = blue

Show on GitHub


                    
                    
                    +redHexFromHex:

Get the hex red color from the hex string

Declaration

Objective-C

+ (NSString *)redHexFromHex:(NSString *)hex;

Swift

class func redHex(fromHex hex: String!) -> String!

Parameters

hex

hex color

Return Value

hex red color in format RR

Show on GitHub


                    
                    
                    +greenHexFromHex:

Get the hex green color from the hex string

Declaration

Objective-C

+ (NSString *)greenHexFromHex:(NSString *)hex;

Swift

class func greenHex(fromHex hex: String!) -> String!

Parameters

hex

hex color

Return Value

hex green color in format GG

Show on GitHub


                    
                    
                    +blueHexFromHex:

Get the hex blue color from the hex string

Declaration

Objective-C

+ (NSString *)blueHexFromHex:(NSString *)hex;

Swift

class func blueHex(fromHex hex: String!) -> String!

Parameters

hex

hex color

Return Value

hex blue color in format BB

Show on GitHub


                    
                    
                    +alphaHexFromHex:

Get the hex alpha color from the hex string if it exists

Declaration

Objective-C

+ (NSString *)alphaHexFromHex:(NSString *)hex;

Swift

class func alphaHex(fromHex hex: String!) -> String!

Parameters

hex

hex color

Return Value

hex alpha color in format AA or null

Show on GitHub


                    
                    
                    +redFromColor:

Get the red color from color integer

Declaration

Objective-C

+ (int)redFromColor:(int)color;

Swift

class func red(fromColor color: Int32) -> Int32

Parameters


                                color

color integer

Return Value

red color

Show on GitHub


                    
                    
                    +redFromUnsignedColor:

Get the red color from color unsigned integer

Declaration

Objective-C

+ (int)redFromUnsignedColor:(unsigned int)color;

Swift

class func red(fromUnsignedColor color: UInt32) -> Int32

Parameters


                                color

color unsigned integer

Return Value

red color

Show on GitHub


                    
                    
                    +greenFromColor:

Get the green color from color integer

Declaration

Objective-C

+ (int)greenFromColor:(int)color;

Swift

class func green(fromColor color: Int32) -> Int32

Parameters


                                color

color integer

Return Value

green color

Show on GitHub


                    
                    
                    +greenFromUnsignedColor:

Get the green color from color unsigned integer

Declaration

Objective-C

+ (int)greenFromUnsignedColor:(unsigned int)color;

Swift

class func green(fromUnsignedColor color: UInt32) -> Int32

Parameters


                                color

color unsigned integer

Return Value

green color

Show on GitHub


                    
                    
                    +blueFromColor:

Get the blue color from color integer

Declaration

Objective-C

+ (int)blueFromColor:(int)color;

Swift

class func blue(fromColor color: Int32) -> Int32

Parameters


                                color

color integer

Return Value

blue color

Show on GitHub


                    
                    
                    +blueFromUnsignedColor:

Get the blue color from color unsigned integer

Declaration

Objective-C

+ (int)blueFromUnsignedColor:(unsigned int)color;

Swift

class func blue(fromUnsignedColor color: UInt32) -> Int32

Parameters


                                color

color unsigned integer

Return Value

blue color

Show on GitHub


                    
                    
                    +alphaFromColor:

Get the alpha color from color integer

Declaration

Objective-C

+ (int)alphaFromColor:(int)color;

Swift

class func alpha(fromColor color: Int32) -> Int32

Parameters


                                color

color integer

Return Value

alpha color

Show on GitHub


                    
                    
                    +alphaFromUnsignedColor:

Get the alpha color from color unsigned integer

Declaration

Objective-C

+ (int)alphaFromUnsignedColor:(unsigned int)color;

Swift

class func alpha(fromUnsignedColor color: UInt32) -> Int32

Parameters


                                color

color unsigned integer

Return Value

alpha color

Show on GitHub


                    
                    
                    +shorthandHex:

Shorthand the hex color if possible

Declaration

Objective-C

+ (NSString *)shorthandHex:(NSString *)color;

Swift

class func shorthandHex(_ color: String!) -> String!

Parameters


                                color

hex color

Return Value

shorthand hex color or original value

Show on GitHub


                    
                    
                    +expandShorthandHex:

Expand the hex if it is in shorthand

Declaration

Objective-C

+ (NSString *)expandShorthandHex:(NSString *)color;

Swift

class func expandShorthandHex(_ color: String!) -> String!

Parameters


                                color

hex color

Return Value

expanded hex color or original value

Show on GitHub


                    
                    
                    +shorthandHexSingle:

Shorthand the hex single color if possible

Declaration

Objective-C

+ (NSString *)shorthandHexSingle:(NSString *)color;

Swift

class func shorthandHexSingle(_ color: String!) -> String!

Parameters


                                color

hex single color

Return Value

shorthand hex color or original value

Show on GitHub


                    
                    
                    +expandShorthandHexSingle:

Expand the hex single if it is in shorthand

Declaration

Objective-C

+ (NSString *)expandShorthandHexSingle:(NSString *)color;

Swift

class func expandShorthandHexSingle(_ color: String!) -> String!

Parameters


                                color

hex single color

Return Value

expanded hex color or original value

Show on GitHub


                    
                    
                    +isValidHex:

Check if the hex color value is valid

Declaration

Objective-C

+ (BOOL)isValidHex:(NSString *)color;

Swift

class func isValidHex(_ color: String!) -> Bool

Parameters


                                color

hex color

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateHex:

Validate the hex color value

Declaration

Objective-C

+ (void)validateHex:(NSString *)color;

Swift

class func validateHex(_ color: String!)

Parameters


                                color

hex color

Show on GitHub


                    
                    
                    +isValidHexSingle:

Check if the hex single color value is valid

Declaration

Objective-C

+ (BOOL)isValidHexSingle:(NSString *)color;

Swift

class func isValidHexSingle(_ color: String!) -> Bool

Parameters


                                color

hex single color

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateHexSingle:

Validate the hex single color value

Declaration

Objective-C

+ (void)validateHexSingle:(NSString *)color;

Swift

class func validateHexSingle(_ color: String!)

Parameters


                                color

hex single color

Show on GitHub


                    
                    
                    +isValidRGB:

Check if the RBG integer color is valid, inclusively between 0 and 255

Declaration

Objective-C

+ (BOOL)isValidRGB:(int)color;

Swift

class func isValidRGB(_ color: Int32) -> Bool

Parameters


                                color

decimal color

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateRGB:

Validate the RBG integer color is inclusively between 0 and 255

Declaration

Objective-C

+ (void)validateRGB:(int)color;

Swift

class func validateRGB(_ color: Int32)

Parameters


                                color

decimal color

Show on GitHub


                    
                    
                    +isValidArithmeticRGB:

Check if the arithmetic RGB float color is valid, inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (BOOL)isValidArithmeticRGB:(float)color;

Swift

class func isValidArithmeticRGB(_ color: Float) -> Bool

Parameters


                                color

decimal color

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateArithmeticRGB:

Validate the arithmetic RGB float color is inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (void)validateArithmeticRGB:(float)color;

Swift

class func validateArithmeticRGB(_ color: Float)

Parameters


                                color

decimal color

Show on GitHub


                    
                    
                    +isValidHue:

Check if the HSL hue float value is valid, inclusively between 0.0 and 360.0

Declaration

Objective-C

+ (BOOL)isValidHue:(float)hue;

Swift

class func isValidHue(_ hue: Float) -> Bool

Parameters

hue

hue value

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateHue:

Validate the HSL hue float value is inclusively between 0.0 and 360.0

Declaration

Objective-C

+ (void)validateHue:(float)hue;

Swift

class func validateHue(_ hue: Float)

Parameters

hue

hue value

Show on GitHub


                    
                    
                    +isValidSaturation:

Check if the HSL saturation float value is valid, inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (BOOL)isValidSaturation:(float)saturation;

Swift

class func isValidSaturation(_ saturation: Float) -> Bool

Parameters


                                saturation

saturation value

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateSaturation:

Validate the HSL saturation float value is inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (void)validateSaturation:(float)saturation;

Swift

class func validateSaturation(_ saturation: Float)

Parameters


                                saturation

saturation value

Show on GitHub


                    
                    
                    +isValidLightness:

Check if the HSL lightness float value is valid, inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (BOOL)isValidLightness:(float)lightness;

Swift

class func isValidLightness(_ lightness: Float) -> Bool

Parameters


                                lightness

lightness value

Return Value

true if valid

Show on GitHub


                    
                    
                    +validateLightness:

Validate the HSL lightness float value is inclusively between 0.0 and 1.0

Declaration

Objective-C

+ (void)validateLightness:(float)lightness;

Swift

class func validateLightness(_ lightness: Float)

Parameters


                                lightness

lightness value

Show on GitHub