blob: cce804c476db6029b0f148cf447175be7fc2dc9e [file] [log] [blame]
/*
* Copyright (C) 2016 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.annotation
/**
* Denotes that the annotated element represents a half-precision floating point value. Such values
* are stored in short data types and can be manipulated with the `android.util.Half` class. If
* applied to an array of short, every element in the array represents a half-precision float.
*
* Example:
* ```
* public abstract void setPosition(@HalfFloat short x, @HalfFloat short y, @HalfFloat short z);
* ```
*/
@MustBeDocumented
@Retention(AnnotationRetention.SOURCE)
@Target(
AnnotationTarget.VALUE_PARAMETER,
AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY_GETTER,
AnnotationTarget.PROPERTY_SETTER,
AnnotationTarget.LOCAL_VARIABLE,
AnnotationTarget.FIELD
)
public annotation class HalfFloat