Structures
The following structures are available globally.
-
Undocumented
-
Undocumented
-
Undocumented
See more
-
Wrapper for a
See moreTransformer
of CIImage filters.Declaration
Swift
public struct Filter
-
Download task.
See moreDeclaration
Swift
public struct RetrieveImageDownloadTask
-
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,
See moreDefaultImageProcessor
will do nothing on it and just return that image.Declaration
Swift
public struct DefaultImageProcessor: ImageProcessor
-
Undocumented
See more -
Processor for adding an blend mode to images. Only CG-based images are supported.
See moreDeclaration
Swift
public struct BlendImageProcessor: ImageProcessor
-
Processor for adding an compositing operation to images. Only CG-based images are supported in macOS.
See more -
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.
See moreDeclaration
Swift
public struct RoundCornerImageProcessor: ImageProcessor
-
Processor for resizing images. Only CG-based images are supported in macOS.
See moreDeclaration
Swift
public struct ResizingImageProcessor: ImageProcessor
-
Processor for adding blur effect to images.
See moreAccelerate.framework
is used underhood for a better performance. A simulated Gaussian blur with specified blur radius will be applied.Declaration
Swift
public struct BlurImageProcessor: ImageProcessor
-
Processor for adding an overlay to images. Only CG-based images are supported in macOS.
See moreDeclaration
Swift
public struct OverlayImageProcessor: ImageProcessor
-
Processor for tint images with color. Only CG-based images are supported.
See moreDeclaration
Swift
public struct TintImageProcessor: ImageProcessor
-
Processor for applying some color control to images. Only CG-based images are supported. watchOS is not supported.
See moreDeclaration
Swift
public struct ColorControlsProcessor: ImageProcessor
-
Processor for applying black and white effect to images. Only CG-based images are supported. watchOS is not supported.
See moreDeclaration
Swift
public struct BlackWhiteProcessor: ImageProcessor
-
Processor for cropping an image. Only CG-based images are supported. watchOS is not supported.
See moreDeclaration
Swift
public struct CroppingImageProcessor: ImageProcessor
-
Undocumented
-
See moreDefaultCacheSerializer
is a basicCacheSerializer
used in default cache of Kingfisher. It could serialize and deserialize PNG, JEPG and GIF images. For image other than these formats, a normalizedpngRepresentation
will be used.Declaration
Swift
public struct DefaultCacheSerializer: CacheSerializer
-
The default modifier. Does nothing and returns the image it was given
See moreDeclaration
Swift
public struct DefaultImageModifier: ImageModifier
-
A custom modifier. Can be initialized with a block to modify images in a custom way
See moreDeclaration
Swift
public struct AnyImageModifier: ImageModifier
-
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.
See moreDeclaration
Swift
public struct RenderingModeImageModifier: ImageModifier
-
Modifier for setting the
See moreflipsForRightToLeftLayoutDirection
property of images. Only UI-based images are supported; if a non-UI image is passed in, the modifier will do nothing.Declaration
Swift
public struct FlipsForRightToLeftLayoutDirectionImageModifier: ImageModifier
-
Modifier for setting the
See morealignmentRectInsets
property of images. Only UI-based images are supported; if a non-UI image is passed in, the modifier will do nothing.Declaration
Swift
public struct AlignmentRectInsetsImageModifier: ImageModifier
-
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:
See moreprivate 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) } }
Declaration
Swift
public struct FormatIndicatedCacheSerializer: CacheSerializer