gltfio/io.github.erkko68.filament.gltfio/ResourceLoader

ResourceLoader

class ResourceLoader(config: ResourceConfiguration) : AutoCloseable

ResourceLoader loads external resources referenced by glTF assets.

ResourceLoader handles:

Loading textures from URIs
Uploading vertex/index buffer data
Computing tangent quaternions (via Mikktspace when needed)
Async resource loading for progressive rendering

Typical usage:

val stb = createStbProvider(engine)
val resourceLoader = ResourceLoader(ResourceConfiguration(engine))
resourceLoader.addTextureProvider("image/png", stb)
resourceLoader.addTextureProvider("image/jpeg", stb)
resourceLoader.loadResources(asset)  // Synchronously load all resources
resourceLoader.destroy()
stb.destroy()

Async usage:

resourceLoader.asyncBeginLoad(asset)
while (resourceLoader.asyncGetLoadProgress() < 1.0f) {
    resourceLoader.asyncUpdateLoad()  // Load in chunks
}

Constructors

ResourceLoader

constructor(config: ResourceConfiguration)

Properties

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

Functions

addResourceData

fun addResourceData(uri: String, buffer: ByteArray)

Feeds the binary content of an external resource into the loader's URI cache.

addTextureProvider

fun addTextureProvider(mimeType: String, provider: TextureProvider)

Registers provider to decode textures of mimeType (e.g. image/png). The loader doesn't own it: destroy it after the loader.

asyncBeginLoad

fun asyncBeginLoad(asset: FilamentAsset): Boolean

Starts an asynchronous resource load (texture decoding may use worker threads). Requires periodic calls to asyncUpdateLoad until asyncGetLoadProgress reaches 1.0.

asyncCancelLoad

fun asyncCancelLoad()

Cancels pending decoder jobs, frees all CPU-side texel data, and flushes the Engine. Only needed if asyncBeginLoad was used and cancellation is required before completion.

asyncGetLoadProgress

fun asyncGetLoadProgress(): Float

Gets the status of an asynchronous load as a percentage in [0, 1].

asyncUpdateLoad

fun asyncUpdateLoad()

Performs any pending main-thread work of an asynchronous load. Call periodically until asyncGetLoadProgress returns 1.0; harmless after that.

open override fun close()

Same as destroy; lets this be used with use { } and try-with-resources.

destroy

fun destroy()

Destroys this loader and frees its internal caches. Must happen on the same thread that calls Renderer.render(), because the loader listens to buffer callbacks to know when CPU-side data blobs can be freed.

evictResourceData

fun evictResourceData()

Frees memory by evicting the URI cache populated via addResourceData. Call only after a model is fully loaded or loading has been cancelled.

hasResourceData

fun hasResourceData(uri: String): Boolean

Checks whether the given resource URI has already been added via addResourceData.

loadResources

fun loadResources(asset: FilamentAsset): Boolean

Synchronously loads resources for asset from the URI cache and finalizes the asset: transforms vertex data if necessary, decodes images, and supplies tangent data.

setConfiguration

fun setConfiguration(config: ResourceConfiguration)

Replaces the configuration the loader was created with.

ResourceLoader

See also

Constructors

Properties

Functions