Structures

Undocumented

Undocumented

Undocumented

Wrapper for a Transformer of CIImage filters.

Download task.

The default processor. It convert the input data to a valid image. Images of .PNG, .JPEG and .GIF format are supported. If an image is given, DefaultImageProcessor will do nothing on it and just return that image.

Undocumented

Processor for adding an blend mode to images. Only CG-based images are supported.

Processor for adding an compositing operation to images. Only CG-based images are supported in macOS.

Processor for making round corner images. Only CG-based images are supported in macOS, if a non-CG image passed in, the processor will do nothing.

Processor for resizing images. Only CG-based images are supported in macOS.

Processor for adding blur effect to images. Accelerate.framework is used underhood for a better performance. A simulated Gaussian blur with specified blur radius will be applied.

Processor for adding an overlay to images. Only CG-based images are supported in macOS.

Processor for tint images with color. Only CG-based images are supported.

Processor for applying some color control to images. Only CG-based images are supported. watchOS is not supported.

Processor for applying black and white effect to images. Only CG-based images are supported. watchOS is not supported.

Processor for cropping an image. Only CG-based images are supported. watchOS is not supported.

ImageResource is a simple combination of downloadURL and cacheKey.

When passed to image view set methods, Kingfisher will try to download the target image from the downloadURL, and then store it with the cacheKey as the key in cache.

Undocumented

DefaultCacheSerializer is a basic CacheSerializer used in default cache of Kingfisher. It could serialize and deserialize PNG, JEPG and GIF images. For image other than these formats, a normalized pngRepresentation will be used.

The default modifier. Does nothing and returns the image it was given

A custom modifier. Can be initialized with a block to modify images in a custom way

Modifier for setting the rendering mode of images. Only UI-based images are supported; if a non-UI image is passed in, the modifier will do nothing.

Modifier for setting the flipsForRightToLeftLayoutDirection property of images. Only UI-based images are supported; if a non-UI image is passed in, the modifier will do nothing.

Modifier for setting the alignmentRectInsets property of images. Only UI-based images are supported; if a non-UI image is passed in, the modifier will do nothing.

FormatIndicatedCacheSerializer let you indicate an image format for serialized caches.

It could serialize and deserialize PNG, JEPG and GIF images. For image other than these formats, a normalized pngRepresentation will be used.

Example:

 private let profileImageSize = CGSize(width: 44, height: 44)

 private let imageProcessor = RoundCornerImageProcessor(
     cornerRadius: profileImageSize.width / 2, targetSize: profileImageSize)

 private let optionsInfo: KingfisherOptionsInfo = [
     .cacheSerializer(FormatIndicatedCacheSerializer.png), 
     .backgroundDecode, .processor(imageProcessor), .scaleFactor(UIScreen.main.scale)]

 extension UIImageView {
    func setProfileImage(with url: URL) {
        // Image will always cached as PNG format to preserve alpha channel for round rect.
        _ = kf.setImage(with: url, options: optionsInfo)
    }
}