PhotoEditModel

public struct PhotoEditModel: Equatable, PhotoEditModelProtocol

A PhotoEditModel holds information about any modification that should be applied to an image.

  • The orientation of the image.

    Declaration

    Swift

    public var appliedOrientation: Orientation = .normal
  • Enable auto enhancement.

    Declaration

    Swift

    public var isAutoEnhancementEnabled: Bool = false
  • The brightness of the image.

    Declaration

    Swift

    public var brightness: Float = 0
  • The contrast of the image.

    Declaration

    Swift

    public var contrast: Float = 0
  • The shadow amount of the image.

    Declaration

    Swift

    public var shadows: Float = 0
  • The highlights amount of the image.

    Declaration

    Swift

    public var highlights: Float = 0
  • The exposure amount of the image.

    Declaration

    Swift

    public var exposure: Float = 0
  • The clarity amount of the image.

    Declaration

    Swift

    public var clarity: Float = 0
  • The identifier of the effect filter to apply to the image.

    Declaration

    Swift

    public var effectFilterIdentifier: String = NeutralModelValues.Filter.effectFilterIdentifier
  • The intensity of the effect filter.

    Declaration

    Swift

    public var effectFilterIntensity: Float = 1
  • The first normalized control point of the focus. This control point should use the coordinate system of Core Image, which means that (0, 0) is at the top left.

    Declaration

    Swift

    public var focusNormalizedControlPoint1: CGPoint = CGPoint(x: 0.5, y: 0.8)
  • The second normalized control point of the focus. This control point should use the coordinate system of Core Image, which means that (0, 0) is at the top left.

    Declaration

    Swift

    public var focusNormalizedControlPoint2: CGPoint = CGPoint(x: 0.5, y: 0.2)
  • The blur radius to use for focus. Default is 0.015. This value is relative to the shorter side of the image.

    Declaration

    Swift

    public var focusBlurRadius: Float = 0.015
  • The normalized fade width to use for focus. Default is 0.1.

    Declaration

    Swift

    public var focusNormalizedFadeWidth: Float = 0.1
  • The PESDKFocusType to apply to the image.

    Declaration

    Swift

    public var focusType: FocusType = .off
  • This property is true if the image has neither been cropped nor rotated.

    Declaration

    Swift

    public var isGeometryIdentity: Bool
  • The normalized crop rect of the image.

    Declaration

    Swift

    public var normalizedCropRect: CGRect = PhotoEditModel.identityNormalizedCropRect
  • An image that should be placed on top of the input image after all other effects have been applied.

    Declaration

    Swift

    public var spriteImage: CIImage?
  • The identifier of the effect filter to apply to the image.

    Declaration

    Swift

    public var overlayIdentifier: String = NeutralModelValues.Filter.effectFilterIdentifier
  • The blend mode that is use to apply the overlay image.

    Declaration

    Swift

    public var overlayBlendMode: BlendMode = .multiply
  • A value between 0 and 1, that determins the intensity that is used to render the overlay.

    Declaration

    Swift

    public var overlayIntensity: Float = 1
  • The saturation of the image.

    Declaration

    Swift

    public var saturation: Float = 0
  • The straighten angle of the image.

    Declaration

    Swift

    public var straightenAngle: Float = 0
  • The amount by which the image should be inset (this is used when a frame is applied to make the image fit inside the frame). The inset is specified as a value relative to the smaller side of the image.

    Declaration

    Swift

    public var imageInsets: UIEdgeInsets = .zero
  • The straighten angle adjusted for the applied orientation.

    Declaration

    Swift

    public var adjustedStraightenAngle: Float
  • The identity orientation of a photo edit model.

    Declaration

    Swift

    public static var identityOrientation: Orientation
  • The identity cropping area of a photo edit model.

    Declaration

    Swift

    public static var identityNormalizedCropRect: CGRect