polyui/org.polyfrost.polyui.renderer.data/Font

Font

class Font @JvmOverloads constructor(val resourcePath: String, val letterSpacing: Float = 0.0f, val lineSpacing: Float = 1.2f, val family: FontFamily? = null, val italic: Boolean = resourcePath.contains("italic", ignoreCase = true), val weight: Font.Weight = Weight.entries.getByName(resourcePath.findLastAnyOf(Weight.entries.names(), ignoreCase = true)?.second) ?: Weight.Regular) : Resource

Font

A font used by the rendering implementation. As with other PolyUI resources, the actual loading, management, etc. of the font is NOT managed in this class in any way. This class just contains metadata for usage with PolyUI.

Parameters

resourcePath

The resource of the font, can be a URL (see here, you should use this or an equivalent method)

letterSpacing

The letter spacing of the font, in pixels (e.g. 1 pixel = 1 empty pixel between each letter).

lineSpacing

The line spacing of the font, in proportion to the font size (e.g. 2 means 1 empty line between each line, 1.5 = half a line between...)

family

a reference to the family that encloses this font. Only set if this font was retrieved from a method like FontFamily.get or similar.

Constructors

Font

@JvmOverloads

constructor(resourcePath: String, letterSpacing: Float = 0.0f, lineSpacing: Float = 1.2f, family: FontFamily? = null, italic: Boolean = resourcePath.contains("italic", ignoreCase = true), weight: Font.Weight = Weight.entries.getByName(resourcePath.findLastAnyOf(Weight.entries.names(), ignoreCase = true)?.second) ?: Weight.Regular)

Types

Companion

object Companion

Weight

enum Weight : Enum<Font.Weight>

Enum representing weights available to a font in PolyUI.

Properties

family

val family: FontFamily? = null

val italic: Boolean

val letterSpacing: Float = 0.0f

lineSpacing

@Transient

val lineSpacing: Float = 1.2f

loadSync

@Transient

@get:JvmName(name = "shouldLoadSync")

val loadSync: Boolean

true if this resource should be loaded synchronously, false otherwise. (optional operation)

name

val name: String

resourcePath

val resourcePath: String

weight

@Transient

val weight: Font.Weight

Functions

bytes

open fun bytes(): ByteArray

Return this resource's contents as an array of bytes.

equals

open operator override fun equals(other: Any?): Boolean

getAtStyle

fun getAtStyle(weight: Font.Weight, italic: Boolean): Font

hashCode

open override fun hashCode(): Int

load

inline fun load(errorHandler: (Throwable) -> ByteArray = { throw it }): ByteArray

load the given resource synchronously into a new byte array. you may then perform any operations on the result.

inline fun <T> load(errorHandler: (Throwable) -> T & Any = { throw it }, mapper: (ByteArray) -> T & Any): T

load the given resource synchronously, mapping to definitely non-nullable type T. you may then perform any operations on the result.

loadAsync

fun loadAsync(errorHandler: (Throwable) -> Unit = { throw it }, consumer: (ByteArray) -> Unit)

load the given resource asynchronously into a new byte array, calling the consumer with the result on the worker thread.

fun <T> loadAsync(errorHandler: (Throwable) -> Unit = { throw it }, mapper: (ByteArray) -> T & Any, consumer: (T & Any) -> Unit)

load the given resource asynchronously, mapping to definitely non-nullable type T, calling the consumer with the result on the worker thread.

stream

open fun stream(): InputStream

return the stream of this resource. it is the caller's responsibility to close the stream.

toString

open override fun toString(): String