UIImageColors

iTunes style color fetcher for UIImage. This is based on Panic's OS X ColorArt for iOS Swift.

In other words, it fetches the most dominant and prominent colors.

Example

Asynchronous example:

let image = UIImage(named: "yeezus.png")

image.getColors { colors in
  backgroundView.backgroundColor = colors.background
  mainLabel.textColor = colors.primary
  secondaryLabel.textColor = colors.secondary
  detailLabel.textColor = colors.detail
}

Synchronous example:

let colors = UIImage(named: "yeezus.png").getColors()

backgroundView.backgroundColor = colors.background
mainLabel.textColor = colors.primary
secondaryLabel.textColor = colors.secondary
detailLabel.textColor = colors.detail

UIImage Methods

getColors() -> UIImageColors

Returns a UIImageColors object. The sample image is rescaled to a width of 250px and the aspect ratio height. This blocks the main thread.

getColors(scaleDownSize: CGSize) -> UIImageColors

Returns a UIImageColors object with a custom image rescale. Use smaller sizes for better performance at the cost of quality colors. Use larger sizes for better color sampling and quality at the cost of performance. This blocks the main thread.

getColors(completionHandler: (UIImageColors) -> Void) -> Void

Passes a UIImageColors object into the closure. The sample image is rescaled to a width of 250px and the aspect ratio height. This runs on the background thread.

getColors(scaleDownSize: CGSize, completionHandler: (UIImageColors) -> Void) -> Void

Passes a UIImageColors object into the closure, with a custom image rescale. Use smaller sizes for better performance at the cost of quality colors. Use larger sizes for better color sampling and quality at the cost of performance. This runs on the background thread.

UIImageColors Object

UIImageColors is struct that contains four different UIColor variables.

public struct UIImageColors {
    public var background: UIColor!
    public var primary: UIColor!
    public var secondary: UIColor!
    public var detail: UIColor!
}

Installation

You can either directly copy UIImageColors.swift into your project or you can use CocoaPods: UIImageColors.

License

The license is provided in the project folder. Please also refer to Panic's original license.

---

June 2015 - Toronto