CroppingImageProcessor
public struct CroppingImageProcessor: ImageProcessor
Processor for cropping an image. Only CG-based images are supported. watchOS is not supported.
-
Identifier of the processor.
Note
See documentation ofImageProcessor
protocol for more.Declaration
Swift
public let identifier: String
-
Target size of output image should be.
Declaration
Swift
public let size: CGSize
-
Anchor point from which the output size should be calculate. The anchor point is consisted by two values between 0.0 and 1.0. It indicates a related point in current image. See
CroppingImageProcessor.init(size:anchor:)
for more.Declaration
Swift
public let anchor: CGPoint
-
Initialize a
CroppingImageProcessor
Note
The anchor point is consisted by two values between 0.0 and 1.0. It indicates a related point in current image, eg: (0.0, 0.0) for top-left corner, (0.5, 0.5) for center and (1.0, 1.0) for bottom-right corner. Thesize
property ofCroppingImageProcessor
will be used along withanchor
to calculate a target rectange in the size of image.The target size will be automatically calculated with a reasonable behavior. For example, when you have an image size of
CGSize(width: 100, height: 100)
, and a target size ofCGSize(width: 20, height: 20)
:- with a (0.0, 0.0) anchor (top-left), the crop rect will be
{0, 0, 20, 20}
; - with a (0.5, 0.5) anchor (center), it will be
{40, 40, 20, 20}
- while with a (1.0, 1.0) anchor (bottom-right), it will be
{80, 80, 20, 20}
Declaration
Swift
public init(size: CGSize, anchor: CGPoint = CGPoint(x: 0.5, y: 0.5))
Parameters
size
Target size of output image should be.
anchor
The anchor point from which the size should be calculated. Default is
CGPoint(x: 0.5, y: 0.5)
, which means the center of input image. - with a (0.0, 0.0) anchor (top-left), the crop rect will be
-
Process an input
ImageProcessItem
item to an image for this processor.Note
See documentation of
ImageProcessor
protocol for more.Declaration
Swift
public func process(item: ImageProcessItem, options: KingfisherOptionsInfo) -> Image?
Parameters
item
Input item which will be processed by
self
options
Options when processing the item.
Return Value
The processed image.