filament-utils/io.github.erkko68.filament.utils/Half

Half

value class Half(val v: UShort) : Comparable<Half>

A 16-bit half-precision floating-point number conforming to IEEE 754-2008.

Layout: 1 sign bit, 5 exponent bits, 10 mantissa bits.

+-+------+------------+
|s|eeeee |mmmmmmmmmm  |
+-+------+------------+

Minimum (denormal) value: 2⁻²⁴ ≈ 5.96e-8
Minimum (normal) value: 2⁻¹⁴ ≈ 6.10e-5
Maximum value: (2 − 2⁻¹⁰) × 2¹⁵ = 65504
Integers in 0, 2048 are represented exactly.

Constructors

Half

constructor(v: UShort)

Types

Companion

object Companion

Properties

absoluteValue

val absoluteValue: Half

The absolute value of this Half.

exponent

val exponent: Int

The unbiased exponent in the range MIN_EXPONENT, MAX_EXPONENT.

sign

val sign: Half

Returns the sign of this value: NaN if this is NaN, +0 if zero, +1.0 or −1.0 otherwise.

significand

val significand: Int

The mantissa (significand) bits, in the range 0, 1023.

ulp

val ulp: Half

The unit in the last place (ULP) of this value.

val v: UShort

the raw 16-bit representation

Functions

compareTo

open operator override fun compareTo(other: Half): Int

dec

operator fun dec(): Half

div

operator fun div(other: Half): Half

div

inline operator fun Half.div(v: Half3): Half3

inline operator fun Half.div(v: Half4): Half4

inc

operator fun inc(): Half

isFinite

fun isFinite(): Boolean

Returns true if this value is finite (not NaN, not infinite).

isInfinite

fun isInfinite(): Boolean

Returns true if this value is positive or negative infinity.

isNaN

fun isNaN(): Boolean

Returns true if this value is NaN.

isNormalized

fun isNormalized(): Boolean

Returns true if this value is a normalized (non-denormal, non-zero, finite) number.

isZero

fun isZero(): Boolean

Returns true if this value is positive or negative zero.

minus

operator fun minus(other: Half): Half

minus

inline operator fun Half.minus(v: Half3): Half3

inline operator fun Half.minus(v: Half4): Half4

nextDown

fun nextDown(): Half

Returns the largest Half value that is less than this value.

nextTowards

fun nextTowards(to: Half): Half

Returns the adjacent Half value in the direction of to.

nextUp

fun nextUp(): Half

Returns the smallest Half value that is greater than this value.

plus

operator fun plus(other: Half): Half

plus

inline operator fun Half.plus(v: Half3): Half3

inline operator fun Half.plus(v: Half4): Half4

roundToInt

fun roundToInt(): Int

roundToLong

fun roundToLong(): Long

times

operator fun times(other: Half): Half

times

inline operator fun Half.times(v: Half3): Half3

inline operator fun Half.times(v: Half4): Half4

toBits

fun toBits(): Int

Returns the raw 16-bit representation as an Int.

toByte

fun toByte(): Byte

Converts this Half to a Byte by truncation via Float.

toDouble

fun toDouble(): Double

Converts this Half to a Double.

toFloat

fun toFloat(): Float

Converts this Half to a Float.

toHexString

fun toHexString(): String

toInt

fun toInt(): Int

Converts this Half to an Int by truncation via Float.

toLong

fun toLong(): Long

Converts this Half to a Long by truncation via Float.

toShort

fun toShort(): Short

Converts this Half to a Short by truncation via Float.

toString

open override fun toString(): String

unaryMinus

operator fun unaryMinus(): Half

unaryPlus

operator fun unaryPlus(): Half

withSign

fun withSign(sign: Half): Half

Returns this value with the sign of sign.