Structures

Represents a basic and default CacheSerializer used in Kingfisher disk cache system. It could serialize and deserialize images in PNG, JPEG and GIF format. For image other than these formats, a normalized pngRepresentation will be used.

FormatIndicatedCacheSerializer lets you indicate an image format for serialized caches.

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

Example:

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

// A round corner image.
let imageProcessor = RoundCornerImageProcessor(
    cornerRadius: profileImageSize.width / 2, targetSize: profileImageSize)

let optionsInfo: KingfisherOptionsInfo = [
    .cacheSerializer(FormatIndicatedCacheSerializer.png), 
    .processor(imageProcessor)]

A URL pointing to a JPEG image.
let url = URL(string: "https://example.com/image.jpg")!

// Image will be always cached as PNG format to preserve alpha channel for round rectangle.
// So when you load it from cache again later, it will be still round cornered.
// Otherwise, the corner part would be filled by white color (since JPEG does not contain an alpha channel).
imageView.kf.setImage(with: url, options: optionsInfo)

Represents the caching operation result.

Wrapper for Kingfisher compatible types. This type provides an extension point for connivence methods in Kingfisher.

Undocumented

The default modifier. It does nothing and returns the image as is.

Represents an image data provider for loading from a local file URL on disk. Uses this type for adding a disk image to Kingfisher. Compared to loading it directly, you can get benefit of using Kingfisher’s extension methods, as well as applying ImageProcessors and storing the image to ImageCache of Kingfisher.

Represents an image data provider for loading image from a given Base64 encoded string.

Represents an image data provider for a raw data object.

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.

Represents the result of a Kingfisher retrieving image task.

The parsed options info used across Kingfisher methods. Each property in this type corresponds a case member in KingfisherOptionsInfoItem. When a KingfisherOptionsInfo sent to Kingfisher related methods, it will be parsed and converted to a KingfisherParsedOptionsInfo first, and pass through the internal methods.

A wrapper struct for a Transformer of CIImage filters. A Filter value could be used to create a CIImage processor.

Represents a set of image creating options used in Kingfisher.

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

Represents the rect corner setting when processing a round corner image.

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.

Note: The input image will be rendered with round corner pixels removed. If the image itself does not contain alpha channel (for example, a JPEG image), the processed image will contain an alpha channel in memory in order to show correctly. However, when cached into disk, the image format will be respected and the alpha channel will be removed. That means when you load the processed image from cache again, you will lose transparent corner. You could use FormatIndicatedCacheSerializer.png to force Kingfisher to serialize the image to PNG format in this case.

Processor for resizing images. If you need to resize a data represented image to a smaller size, use DownsamplingImageProcessor instead, which is more efficient and takes less memory.

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.

Processor for downsampling an image. Compared to ResizingImageProcessor, this processor does not render the images to resize. Instead, it downsample the input data directly to an image. It is a more efficient than ResizingImageProcessor.

Only CG-based images are supported. Animated images (like GIF) is not supported.

Undocumented

Represents a success result of an image downloading progress.

Represents a task of an image downloading process.

A wrapper for creating an ImageModifier easier. This type conforms to ImageModifier and wraps an image modify block. If the block throws an error, the original image will be used.

Modifier for setting the rendering mode of images.

Modifier for setting the flipsForRightToLeftLayoutDirection property of images.

Modifier for setting the alignmentRectInsets property of images.

A wrapper for creating an ImageDownloadRedirectHandler easier. This type conforms to ImageDownloadRedirectHandler and wraps an redirect request modify block.

A wrapper for creating an ImageDownloadRequestModifier easier. This type conforms to ImageDownloadRequestModifier and wraps an image modify block.