Configure Overlays

View on GitHub

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

`initialOverlayIntensity`#

The default intensity of filters is set to 100% (1.0). In this example, we only want to have 50% (0.5) intensity. Since showOverlayIntensitySlider is set to false, the filters will always be applied with a fixed intensity of 50%.

`showOverlayIntensitySlider`#

By default, the editor will show the slider to change the intensity of the selected filter. In our example, the slider should not be shown since we only want a specific intensity to be applied.


import PhotoEditorSDK
import UIKit

class PhotoOverlaysConfigurationSwift: 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
      // Configure the `OverlayToolController` which lets the user
      // place overlays on top of the image.
      builder.configureOverlayToolController { options in
        // By default the editor has an initial overlay intensity of
        // 100% (1). For this example it only uses 50% (0.5).
        options.initialOverlayIntensity = 0.5

        // By default the editor shows a slider to let the user change
        // the intensity of an overlay. For this example this is disabled.
        // Thereby the overlays will always have an intensity of 50% (0.5)
        // since we applied this with the `initialOverlayIntensity`.
        options.showOverlayIntensitySlider = false
      }
    }

    // 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 Overlays

initialOverlayIntensity#

showOverlayIntensitySlider#

`initialOverlayIntensity`#

`showOverlayIntensitySlider`#