1 /*
2  * Copyright 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.camera.core;
18 
19 import static java.lang.annotation.RetentionPolicy.CLASS;
20 
21 import android.media.Image;
22 
23 import androidx.annotation.RequiresOptIn;
24 
25 import java.lang.annotation.Retention;
26 
27 /**
28  * Denotes that the annotated method uses the experimental {@link ImageProxy#getImage()} method.
29  *
30  * <p> The getImage() method makes the assumptions that each {@link ImageProxy} is the sole owner
31  * of the underlying {@link android.media.Image} which might not be the case. In the case where
32  * the Image is shared by multiple ImageProxy, if the Image is closed then it will invalidate
33  * multiple ImageProxy without a way to clearly indicate this has occurred.
34  *
35  * <p> When using this method it would be recommended to not close the Image via
36  * {@link Image#close()}. Instead when the Image needs to be closed, {@link ImageProxy#close()}
37  * should be called on the ImageProxy from which the Image was retrieved.
38  */
39 @Retention(CLASS)
40 @RequiresOptIn
41 public @interface ExperimentalGetImage {
42 }
43