Home | History | Annotate | Download | only in annotation
      1 /*
      2  * Copyright (C) 2016 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 package android.annotation;
     17 
     18 import java.lang.annotation.Retention;
     19 import java.lang.annotation.Target;
     20 
     21 import static java.lang.annotation.ElementType.FIELD;
     22 import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
     23 import static java.lang.annotation.ElementType.METHOD;
     24 import static java.lang.annotation.ElementType.PARAMETER;
     25 import static java.lang.annotation.RetentionPolicy.SOURCE;
     26 
     27 /**
     28  * <p>Denotes that the annotated element represents a half-precision floating point
     29  * value. Such values are stored in short data types and can be manipulated with
     30  * the {@link android.util.Half} class. If applied to an array of short, every
     31  * element in the array represents a half-precision float.</p>
     32  *
     33  * <p>Example:</p>
     34  *
     35  * <pre>{@code
     36  * public abstract void setPosition(@HalfFloat short x, @HalfFloat short y, @HalfFloat short z);
     37  * }</pre>
     38  *
     39  * @see android.util.Half
     40  * @see android.util.Half#toHalf(float)
     41  * @see android.util.Half#toFloat(short)
     42  *
     43  * @hide
     44  */
     45 @Retention(SOURCE)
     46 @Target({PARAMETER, METHOD, LOCAL_VARIABLE, FIELD})
     47 public @interface HalfFloat {
     48 }
     49