polyui/org.polyfrost.polyui.data/PolyImage

PolyImage

open class PolyImage @JvmOverloads constructor(val resourcePath: String, val type: PolyImage.Type = from(resourcePath)) : Resource

Image representation in PolyUI. The image is lazily-loaded from the resourcePath.

Parameters

resourcePath

the path to the resource

type

the image type. This is automatically inferred from the file extension normally, but you can manually select it.

Constructors

PolyImage

@JvmOverloads

constructor(resourcePath: String, type: PolyImage.Type = from(resourcePath))

Types

Companion

object Companion

MaterialStyle

enum MaterialStyle : Enum<PolyImage.MaterialStyle>

Styles for Google Material icons

Type

enum Type : Enum<PolyImage.Type>

Types for images in PolyUI.

Properties

loadSync

@Transient

@get:JvmName(name = "shouldLoadSync")

val loadSync: Boolean

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

resourcePath

val resourcePath: String

size

@get:JvmName(name = "getSize")

var size: Vec2

type

val type: PolyImage.Type

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

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.

onInit

fun onInit(func: () -> Unit)

Add a callback that will be executed once this resource is about to be initialized by a rendering implementation.

reportInit

@ApiStatus.Internal

fun reportInit()

Use this method to execute any callbacks that were added before the resource was initialized.

setLoadingClass

fun setLoadingClass(loadingClass: Class<*>)

Set the class that will be used to load this resource. This is useful if you want to load resources from a different classloader or package. Note that you can only set this once, and all subsequent calls will be ignored.

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