Configure Adjustments

View on GitHub

PhotoEditor SDK supports several configuration options for the AdjustToolController allowing flexible adaptation to different needs and use cases. For a detailed explanation of how to configure different editor views, refer to this guide.

`showResetButton`#

By default, users are able to reset all the applied adjust operations. In our example, we hide the reset button.

`allowedAdjustTools`#

The set of available adjust tools can be configured by assigning an array to the allowedAdjustTools property. In our example, we only want to provide adjustments for brightness, contrast and saturation.


import PhotoEditorSDK
import UIKit

class PhotoAdjustmentsConfigurationSwift: Example, PhotoEditViewControllerDelegate {
  override func invokeExample() {
    // Create a `Photo` from a URL to an image in the app bundle.
    let photo = Photo(url: Bundle.main.url(forResource: "LA", withExtension: "jpg")!)

    // Create a `Configuration` object.
    let configuration = Configuration { builder in
      builder.configureAdjustToolController { options in
        // By default the editor always shows the reset button.
        // For this example, the reset button should not be shown.
        options.showResetButton = false

        // By default the editor shows all avaliable adjust tools.
        // For this example, the editor should only show a small selection
        // of them.
        options.allowedAdjustTools = [.brightness, .contrast, .saturation]
      }
    }

    // Create and present the photo editor. Make this class the delegate of it to handle export and cancelation.
    let photoEditViewController = PhotoEditViewController(photoAsset: photo, configuration: configuration)
    photoEditViewController.delegate = self
    photoEditViewController.modalPresentationStyle = .fullScreen
    presentingViewController?.present(photoEditViewController, animated: true, completion: nil)
  }

  // MARK: - PhotoEditViewControllerDelegate

  func photoEditViewControllerShouldStart(_ photoEditViewController: PhotoEditViewController, task: PhotoEditorTask) -> Bool {
    // Implementing this method is optional. You can perform additional validation and interrupt the process by returning `false`.
    true
  }

  func photoEditViewControllerDidFinish(_ photoEditViewController: PhotoEditViewController, result: PhotoEditorResult) {
    // The image has been exported successfully and is passed as an `Data` object in the `result.output.data`.
    // To create an `UIImage` from the output, use `UIImage(data:)`.
    // See other examples about how to save the resulting image.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }

  func photoEditViewControllerDidFail(_ photoEditViewController: PhotoEditViewController, error: PhotoEditorError) {
    // There was an error generating the photo.
    print(error.localizedDescription)
    // Dismissing the editor.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }

  func photoEditViewControllerDidCancel(_ photoEditViewController: PhotoEditViewController) {
    // The user tapped on the cancel button within the editor. Dismissing the editor.
    presentingViewController?.dismiss(animated: true, completion: nil)
  }
}

Configure Adjustments

showResetButton#

allowedAdjustTools#

`showResetButton`#

`allowedAdjustTools`#