SceneTexture Class

Modifiers: final

The SceneTexture class represents a texture resource. SceneTextures are used to construct SceneMaterials and can be used as inputs for shaders also in the construction of SceneMaterials.

Example ways to create a SceneTexture:

SceneTexture(getDrawable(R.drawable.myDrawable)) // Creating a SceneTexture from drawable in resources
SceneTexture(Color.valueOf(Color.BLACK)) // Creating a plain black SceneTexture

SceneTextures are also generated as part of the Panel rendering process and are used to render Panels by populating their SceneMaterial. This is not necessary for Layer panels, but can be enabled with PanelConfigOptions "forceSceneTexture" parameter.

SceneTexture ( width , height , numberOfMips , samplerConfig , color )	Signature constructor(width: Int, height: Int, numberOfMips: Int, samplerConfig: SamplerConfig = SamplerConfig(), color: Color?) Parameters `width: Int` `height: Int` `numberOfMips: Int` `samplerConfig: SamplerConfig` `color: Color?` Returns `SceneTexture`
SceneTexture ( image , samplerConfig )	Signature constructor(image: Image, samplerConfig: SamplerConfig = SamplerConfig()) Parameters `image: Image` `samplerConfig: SamplerConfig` Returns `SceneTexture`
SceneTexture ( bitmap , samplerConfig )	Signature constructor(bitmap: Bitmap, samplerConfig: SamplerConfig = SamplerConfig()) Parameters `bitmap: Bitmap` `samplerConfig: SamplerConfig` Returns `SceneTexture`
SceneTexture ( drawable )	Signature constructor(drawable: Drawable?) Parameters `drawable: Drawable?` Returns `SceneTexture`
SceneTexture ( color , samplerConfig )	Signature constructor(color: Color, samplerConfig: SamplerConfig = SamplerConfig()) Parameters `color: Color` `samplerConfig: SamplerConfig` Returns `SceneTexture`

clear ( r , g , b , a )	Clears the texture with a solid color specified by RGBA float values. Signature fun clear(r: Float, g: Float, b: Float, a: Float) Parameters `r: Float` Red component (0.0 to 1.0) `g: Float` Green component (0.0 to 1.0) `b: Float` Blue component (0.0 to 1.0) `a: Float` Alpha component (0.0 to 1.0)
destroy ()	Signature fun destroy()
nativeHandle ()	Signature fun nativeHandle(): Long Returns `Long`
readAverageColor ( outColor , sampleMipLevel , jitterX , jitterY )	Reads the average color from this texture's mipmap chain. The color is sampled from a specified mip level (defaulting to the highest/smallest level which represents the averaged color of the entire texture). The jitter parameters allow sampling at different positions within the mip level across frames for temporal quality. This operation is asynchronous with one-frame latency: the returned color is from the previous frame's readback. On the first call, returns white (1, 1, 1). Signature fun readAverageColor(outColor: FloatArray, sampleMipLevel: Int = -1, jitterX: Float = 0.5f, jitterY: Float = 0.5f): Boolean Parameters `outColor: FloatArray` Float array of at least 3 elements to receive linear RGB values `sampleMipLevel: Int` Mip level to sample from (-1 = highest/smallest available) `jitterX: Float` Normalized X offset 0,1 for jitter sampling within the mip `jitterY: Float` Normalized Y offset 0,1 for jitter sampling within the mip Returns `Boolean` true if the readback was successful
update ( buffer , width , height , strideInBytes )	Updates the texture with new data. Signature fun update(buffer: ByteBuffer, width: Int, height: Int, strideInBytes: Int) Parameters `buffer: ByteBuffer` ByteBuffer containing the pixel data `width: Int` Width of the image data in pixels `height: Int` Height of the image data in pixels `strideInBytes: Int` Number of bytes per row in the buffer

calculateMips ( w , h )	Calculates the number of mipmap levels for a texture of the given dimensions. Mipmaps are smaller versions of a texture used for rendering at different distances, which improves rendering quality and performance. Signature fun calculateMips(w: Int, h: Int): Int Parameters `w: Int` Width of the texture in pixels `h: Int` Height of the texture in pixels Returns `Int` The number of mipmap levels
createFromPlatformImage ( w , h , mips , platformImage , samplerConfig ) DeprecatedUse SceneTexture constructor and SceneTexture.update instead.	Signature fun createFromPlatformImage(w: Int, h: Int, mips: Int, platformImage: Long, samplerConfig: SamplerConfig = SamplerConfig()): SceneTexture Parameters `w: Int` `h: Int` `mips: Int` `platformImage: Long` `samplerConfig: SamplerConfig` Returns `SceneTexture`
fromBitmapWithScaling ( originalBitmap , targetWidth , targetHeight , scale , samplerConfig )	Helper to create a SceneTexture from a bitmap with optional scaling. Signature fun fromBitmapWithScaling(originalBitmap: Bitmap, targetWidth: Int?, targetHeight: Int?, scale: Float?, samplerConfig: SamplerConfig): SceneTexture Parameters `originalBitmap: Bitmap` `targetWidth: Int?` `targetHeight: Int?` `scale: Float?` `samplerConfig: SamplerConfig` Returns `SceneTexture`
fromResource ( context , resourceId , targetWidth , targetHeight , scale , samplerConfig )	Creates a SceneTexture from an Android drawable resource, automatically converting it to a bitmap and optionally scaling it. This is a convenience method that handles the common pattern of loading a drawable resource, decoding it to a bitmap, optionally scaling it, and creating a texture. Size behavior: If the resource is a bitmap drawable: uses the original bitmap dimensions by default If the resource is a vector/shape drawable with intrinsic dimensions: uses those dimensions If the resource has no intrinsic dimensions (e.g., some shape drawables): uses 256x256 If `targetWidth` and `targetHeight` are specified: uses those dimensions If `scale` is specified: scales from the base size (original or default) Supported resource types: Bitmap drawables (PNG, JPG, WebP, etc.) Vector drawables (XML vector graphics) Shape drawables (XML shapes like oval, rectangle, etc.) Nine-patch drawables Layer-list and other compound drawables Example usage: // Use original bitmap size or intrinsic drawable size val texture = SceneTexture.fromResource(context, R.drawable.my_bitmap) // Scale to 50% of original size val halfSize = SceneTexture.fromResource(context, R.drawable.my_bitmap, scale = 0.5f) // Force specific dimensions (good for vector/shape drawables) val fixedSize = SceneTexture.fromResource(context, R.drawable.my_shape, 512, 512) Signature fun fromResource(context: Context, resourceId: Int, targetWidth: Int? = null, targetHeight: Int? = null, scale: Float? = null, samplerConfig: SamplerConfig = SamplerConfig()): SceneTexture Parameters `context: Context` Android context used to access resources `resourceId: Int` The drawable resource ID (e.g., R.drawable.my_image) `targetWidth: Int?` Optional target width in pixels. If null, uses intrinsic/original size or default. `targetHeight: Int?` Optional target height in pixels. If null, uses intrinsic/original size or default. `scale: Float?` Optional scale factor applied to the base size (1.0 = no scaling). Ignored if targetWidth/targetHeight are specified. `samplerConfig: SamplerConfig` Optional sampler configuration for texture filtering and addressing Returns `SceneTexture` A new SceneTexture containing the resource image Throws `IllegalArgumentException` if the resource cannot be loaded
loadFile ( assetPath , samplerConfig )	Loads a SceneTexture from an Android asset file path. This method loads the image file natively using stb_image via the Android asset manager, supporting PNG, JPG, BMP, TGA, GIF, and other formats. The image is decoded directly to RGBA pixels without going through Android's Bitmap pipeline, avoiding premultiplied alpha issues. Example usage: val texture = SceneTexture.loadFile("textures/particle_glow.png") Signature fun loadFile(assetPath: String, samplerConfig: SamplerConfig = SamplerConfig()): SceneTexture? Parameters `assetPath: String` Path to the file within the assets directory (e.g., "textures/particle_glow.png") `samplerConfig: SamplerConfig` Optional sampler configuration for texture filtering and addressing Returns `SceneTexture?` A new SceneTexture, or null if the file could not be loaded or decoded

SceneTexture Class

Signature

Constructors

Properties

Methods

Companion Object

Properties

Methods