SurfaceHolder.java

/*
 * Copyright 2019 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 androidx.camera.core;

import android.graphics.SurfaceTexture;
import android.view.Surface;

/**
 * A class that holds a {@link SurfaceTexture}.
 *
 * TODO(b/117519540): maybe merge it into DeferrableSurface.
 */
interface SurfaceHolder {

    /**
     * Release the Surface future.
     *
     * <p>Once this has been called the {@link Surface} obtained should no longer be used.
     */
    void release();
}