low-alloc-math/com.sztorm.lowallocmath/Flags8

Flags8

@JvmInline
value class Flags8(val byteValue: Byte) : Collection<Boolean>

Represents a collection of eight bit flags.

On the JVM, non-nullable values of this type are represented as values of the primitive type byte.

Constructors

Link copied to clipboard
constructor(byteValue: Byte)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
infix inline fun adding(flags: Flags8): Flags8

Returns a copy of this flags instance with the specified flags added.

Link copied to clipboard
open inline operator override fun contains(element: Boolean): Boolean

Returns a value indicating whether the element is contained in this collection.

Link copied to clipboard
open override fun containsAll(elements: Collection<Boolean>): Boolean

Returns a value indicating whether all specified elements are contained in this collection.

Link copied to clipboard
inline operator fun get(index: Int): Boolean

Returns a value indicating whether the bit at index is set to 1.

Link copied to clipboard
inline fun hasAll(flags: Flags8): Boolean

Returns a value indicating whether this flags instance has all the specified flags.

Link copied to clipboard
inline fun hasAny(flags: Flags8): Boolean

Returns a value indicating whether this flags instance has any of the specified flags.

Link copied to clipboard
open inline override fun isEmpty(): Boolean

Returns a value indicating whether this collection is empty, which is always false.

Link copied to clipboard
open operator override fun iterator(): BooleanIterator

Returns an iterator of this collection.

Link copied to clipboard
infix inline fun removing(flags: Flags8): Flags8

Returns a copy of this flags instance with the specified flags removed.

Link copied to clipboard
inline fun setting(flags: Flags8, to: Boolean): Flags8

Returns a copy of this flags instance with the specified flags set to the particular value.

Link copied to clipboard
@JvmName(name = "sumOfVector2F")
fun Iterable<Vector2F>.sum(): Vector2F
@JvmName(name = "sumOfVector2I")
fun Iterable<Vector2I>.sum(): Vector2I

Returns the sum of all elements in the collection.

Link copied to clipboard
@JvmName(name = "sumOfVector2F")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Vector2F): Vector2F
@JvmName(name = "sumOfVector2I")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Vector2I): Vector2I

Returns the sum of all values produced by selector function applied to each element in the collection.

Link copied to clipboard
infix inline fun toggling(flags: Flags8): Flags8

Returns a copy of this flags instance with the specified flags toggled.

Link copied to clipboard
open override fun toString(): String

Returns a String representation of this flags collection in "Flags8(00000000)" format.

Properties

Link copied to clipboard
val byteValue: Byte

Returns 8-bit signed integer representation of this type.

Link copied to clipboard
val lastIndex: Int

Returns the last valid index for this collection.

Link copied to clipboard
open override val size: Int

Returns the number of flags, which is always 8.

Link copied to clipboard
val uByteValue: UByte

Returns 8-bit unsigned integer representation of this type.