core/com.pico.spatial.core.ecs.resource/AssetBundle

AssetBundle

class AssetBundle : Closeable

An AssetBundle is a packaged collection of resources.

Notes:

An AssetBundle is generated by packaging resources using the Spatial Editor. It helps compress and manage resources efficiently.
A Model corresponds to a scene description file (typically a Scene in the Spatial Editor), usually saved in the project as a USD file.
The model input path examples:

Scenes/Scene.usda -> Scene name: Scene (default case)
Scenes/Sub/Scene.usda -> Scene name: Sub/Scene
Scenes/Sub/Sub/Scene.usda -> Scene name: Sub/Sub/Scene

Example Usage

// Load an AssetBundle (located under the app assets directory)
val assetBundle = AssetBundle.load("asset://AssetBundles/MyAssetBundle.bundle")

// Load a model from the AssetBundle
val model = assetBundle.loadModel("Sub/Sub/Scene")

// Load a material from the AssetBundle

val material = assetBundle.loadMaterial("Sub/Sub/Scene/MyMaterial/NewMaterial")

// Release model and material resources
assetBundle.releaseModel("Sub/Sub/Scene")
assetBundle.releaseResource("Sub/Sub/Scene/MyMaterial/NewMaterial")

// Close the AssetBundle when no longer needed
assetBundle.close()

Types

object Companion

The companion of AssetBundle.

Properties

@get:JvmName(name = "isValid")

val valid: Boolean

The AssetBundle is valid.

Functions

open override fun close()

Closes an AssetBundle and releases the resources occupied by it.

loadAudioGroupResource

fun loadAudioGroupResource(path: String): AudioGroupResource

Loads an audio group resource from the specified path.

loadAudioGroupResourceSuspend

suspend fun loadAudioGroupResourceSuspend(path: String): AudioGroupResource

Asynchronously loads an audio group resource from the specified path.

loadAudioMixerGroupResource

fun loadAudioMixerGroupResource(path: String): AudioMixerGroupResource

Loads an audio mixer group resource from the specified path.

loadAudioMixerGroupResourceSuspend

suspend fun loadAudioMixerGroupResourceSuspend(path: String): AudioMixerGroupResource

Asynchronously loads an audio mixer group resource from the specified path.

loadAudioResource

fun loadAudioResource(path: String): AudioResource

Loads an audio resource from a relative path.

loadAudioResourceSuspend

suspend fun loadAudioResourceSuspend(path: String): AudioResource

Asynchronously loads an audio resource from a relative path.

fun loadMaterial(path: String): Material

Loads a material from the specified path.

loadMeshResource

fun loadMeshResource(path: String): MeshResource

Loads a mesh resource from the specified path.

fun loadModel(name: String): Entity

Loads a model by its name.

loadModelSuspend

suspend fun loadModelSuspend(name: String): Entity

Asynchronously loads a model by its name. This is a suspend function.

loadTextureResource

fun loadTextureResource(path: String): TextureResource

Loads a texture resource from the specified path.

fun preloadModel(name: String)

Preloads the specified model into memory.

fun releaseModel(name: String)

Releases a previously loaded model by its name.

releaseResource

fun releaseResource(path: String)

Releases a previously loaded resource at the specified path.