Stay organized with collections
Save and categorize content based on your preferences.
open class Texture
Texture represents a texture that can be used with materials.
Summary
Public companion functions |
suspend Texture |
Public factory for a Texture, asynchronously loading a preprocessed texture from a Path relative to the application's assets/ folder.
|
Public companion functions
@MainThread
suspend fun create(session: Session, path: Path, sampler: TextureSampler): Texture
Public factory for a Texture, asynchronously loading a preprocessed texture from a Path relative to the application's assets/ folder.
This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads
Currently, only URLs and relative paths from the android_assets/ directory are supported.
| Parameters |
session: Session |
The Session to use for loading the Texture.
|
path: Path |
The Path of the .png texture file to be loaded, relative to the application's assets/ folder.
|
sampler: TextureSampler |
A TextureSampler descriptor which describes how the texture will be filtered
|
Public functions
@MainThread
open fun dispose(): Unit
Disposes the given Texture.
This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads
Currently, a glTF model (which this texture will be used with) can't be disposed. This means that calling dispose on the texture will lead to a crash if the call is made out of order, that is, if the texture is disposed before the glTF model that uses it.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-13 UTC."],[],[],null,["# Texture\n=======\n\nArtifact: [androidx.xr.scenecore:scenecore](/jetpack/androidx/releases/xr-scenecore) \n[View Source](https://cs.android.com/search?q=file:androidx/xr/scenecore/Texture.kt+class:androidx.xr.scenecore.Texture) \nAdded in [1.0.0-alpha06](/jetpack/androidx/releases/xr-scenecore#1.0.0-alpha06)\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/androidx/xr/scenecore/Texture \"View this page in Java\")\n\n\n```\nopen class Texture\n```\n\n\u003cbr /\u003e\n\nKnown direct subclasses \n[CubeMapTexture](/reference/kotlin/androidx/xr/scenecore/CubeMapTexture) \n\n|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| [CubeMapTexture](/reference/kotlin/androidx/xr/scenecore/CubeMapTexture) | [CubeMapTexture](/reference/kotlin/androidx/xr/scenecore/CubeMapTexture) represents a cube map texture that can be used with materials. |\n\n*** ** * ** ***\n\n[Texture](/reference/kotlin/androidx/xr/scenecore/Texture) represents a texture that can be used with materials.\n\nSummary\n-------\n\n| ### Public companion functions |\n|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `suspend `[Texture](/reference/kotlin/androidx/xr/scenecore/Texture) | `@`[MainThread](/reference/kotlin/androidx/annotation/MainThread) [create](/reference/kotlin/androidx/xr/scenecore/Texture#create(androidx.xr.runtime.Session,java.nio.file.Path,androidx.xr.scenecore.TextureSampler))`(session: `[Session](/reference/kotlin/androidx/xr/runtime/Session)`, path: `[Path](https://developer.android.com/reference/java/nio/file/Path.html)`, sampler: `[TextureSampler](/reference/kotlin/androidx/xr/scenecore/TextureSampler)`)` Public factory for a Texture, asynchronously loading a preprocessed texture from a [Path](https://developer.android.com/reference/java/nio/file/Path.html) relative to the application's `assets/` folder. |\n\n| ### Public functions |\n|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `open `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | `@`[MainThread](/reference/kotlin/androidx/annotation/MainThread) [dispose](/reference/kotlin/androidx/xr/scenecore/Texture#dispose())`()` Disposes the given [Texture](/reference/kotlin/androidx/xr/scenecore/Texture). |\n\nPublic companion functions\n--------------------------\n\n### create\n\n```\n@MainThread\nsuspend fun create(session: Session, path: Path, sampler: TextureSampler): Texture\n```\n\nPublic factory for a Texture, asynchronously loading a preprocessed texture from a [Path](https://developer.android.com/reference/java/nio/file/Path.html) relative to the application's `assets/` folder.\n\nThis method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads\n\nCurrently, only URLs and relative paths from the android_assets/ directory are supported. \n\n| Parameters |\n|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `session: `[Session](/reference/kotlin/androidx/xr/runtime/Session) | The [Session](/reference/kotlin/androidx/xr/runtime/Session) to use for loading the [Texture](/reference/kotlin/androidx/xr/scenecore/Texture). |\n| `path: `[Path](https://developer.android.com/reference/java/nio/file/Path.html) | The Path of the `.png` texture file to be loaded, relative to the application's `assets/` folder. |\n| `sampler: `[TextureSampler](/reference/kotlin/androidx/xr/scenecore/TextureSampler) | A [TextureSampler](/reference/kotlin/androidx/xr/scenecore/TextureSampler) descriptor which describes how the texture will be filtered |\n\n| Returns |\n|------------------------------------------------------------|-------------------------------------------------------------------------------|\n| [Texture](/reference/kotlin/androidx/xr/scenecore/Texture) | a [Texture](/reference/kotlin/androidx/xr/scenecore/Texture) upon completion. |\n\n| Throws |\n|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [kotlin.IllegalArgumentException](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html) | if [Path.isAbsolute](https://developer.android.com/reference/java/nio/file/Path.html#isAbsolute()) is true, as this method requires a relative path, or if the path does not specify a `.zip` file. |\n\nPublic functions\n----------------\n\n### dispose\n\nAdded in [1.0.0-alpha06](/jetpack/androidx/releases/xr-scenecore#1.0.0-alpha06) \n\n```\n@MainThread\nopen fun dispose(): Unit\n```\n\nDisposes the given [Texture](/reference/kotlin/androidx/xr/scenecore/Texture).\n\nThis method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads\n\nCurrently, a glTF model (which this texture will be used with) can't be disposed. This means that calling dispose on the texture will lead to a crash if the call is made out of order, that is, if the texture is disposed before the glTF model that uses it."]]
