Configure Overlays

PhotoEditor SDK supports several configuration options for the OverlayToolPanel allowing flexible adaptation to different needs and use cases.

Set initial overlay#

Here, we set an initial overlay that will be applied to the input photo. We find the OverlayAsset to apply by using the getAssetById() method on the AssetConfig which we obtain from the SettingsList.

Intensity and BlendMode#

For the sake of this example, we set the intensity to 0.4 and the blendMode to HARD_LIGHT.


class PhotoOverlayConfiguration(private val activity: AppCompatActivity) : Example(activity) {

    override fun invoke() {
        // In this example, we do not need access to the Uri(s) after the editor is closed
        // so we pass false in the constructor
        val settingsList = PhotoEditorSettingsList(false)
            // Set the source as the Uri of the image to be loaded
            .configure<LoadSettings> {
                it.source = activity.resourceUri(R.drawable.la)
            }

        settingsList.configure<OverlaySettings> {
            it.overlayAsset = checkNotNull(settingsList.config.getAssetById(OverlayAsset::class, "imgly_overlay_vintage"))
            it.intensity = 0.4f
            it.blendMode = BlendMode.HARD_LIGHT
        }

        // Start the photo editor using PhotoEditorBuilder
        // The result will be obtained in onActivityResult() corresponding to EDITOR_REQUEST_CODE
        PhotoEditorBuilder(activity)
            .setSettingsList(settingsList)
            .startActivityForResult(activity, EDITOR_REQUEST_CODE)

        // Release the SettingsList once done
        settingsList.release()
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {
        intent ?: return
        if (requestCode == EDITOR_REQUEST_CODE) {
            // Wrap the intent into an EditorSDKResult
            val result = EditorSDKResult(intent)
            when (result.resultStatus) {
                EditorSDKResult.Status.CANCELED -> showMessage("Editor cancelled")
                EditorSDKResult.Status.EXPORT_DONE -> showMessage("Result saved at ${result.resultUri}")
                else -> {
                }
            }
        }
    }
}