/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.systemui.surfaceeffects

import android.graphics.RenderEffect

/**
 * A callback with a [RenderEffect] object that contains shader info, which is triggered every frame
 * while animation is playing. Note that the [RenderEffect] instance is different each time to
 * update shader uniforms.
 *
 * The usage of this callback is as follows:
 * <pre>{@code
 *     private val xEffectDrawingCallback = RenderEffectDrawCallback() {
 *         val myOtherRenderEffect = createOtherRenderEffect()
 *         val chainEffect = RenderEffect.createChainEffect(renderEffect, myOtherRenderEffect)
 *         myView.setRenderEffect(chainEffect)
 *     }
 *
 *     private val xEffect = XEffect(config, xEffectDrawingCallback)
 * }</pre>
 */
interface RenderEffectDrawCallback {
    fun onDraw(renderEffect: RenderEffect)
}