data class MaterialKey(var doubleSided: Boolean = false, var unlit: Boolean = false, var hasVertexColors: Boolean = false, var hasBaseColorTexture: Boolean = false, var hasNormalTexture: Boolean = false, var hasOcclusionTexture: Boolean = false, var hasEmissiveTexture: Boolean = false, var useSpecularGlossiness: Boolean = false, var alphaMode: AlphaMode = AlphaMode.OPAQUE, var enableDiagnostics: Boolean = false, var hasMetallicRoughnessTexture: Boolean = false, var metallicRoughnessUV: Int = 0, var baseColorUV: Int = 0, var hasClearCoatTexture: Boolean = false, var clearCoatUV: Int = 0, var hasClearCoatRoughnessTexture: Boolean = false, var clearCoatRoughnessUV: Int = 0, var hasClearCoatNormalTexture: Boolean = false, var clearCoatNormalUV: Int = 0, var hasClearCoat: Boolean = false, var hasTransmission: Boolean = false, var hasTextureTransforms: Boolean = false, var emissiveUV: Int = 0, var aoUV: Int = 0, var normalUV: Int = 0, var hasTransmissionTexture: Boolean = false, var transmissionUV: Int = 0, var hasSheenColorTexture: Boolean = false, var sheenColorUV: Int = 0, var hasSheenRoughnessTexture: Boolean = false, var sheenRoughnessUV: Int = 0, var hasVolumeThicknessTexture: Boolean = false, var volumeThicknessUV: Int = 0, var hasSheen: Boolean = false, var hasIOR: Boolean = false, var hasVolume: Boolean = false, var hasDispersion: Boolean = false, var hasSpecular: Boolean = false, var hasSpecularTexture: Boolean = false, var hasSpecularColorTexture: Boolean = false, var specularTextureUV: Int = 0, var specularColorTextureUV: Int = 0)

MaterialKey encodes glTF material properties for material selection and creation.

MaterialProvider

class MaterialProvider(nativeHandle: NativePointer) : AutoCloseable

MaterialProvider supplies materials to glTF assets during loading: the ubershader provider picks from a pre-compiled set of materials, see createUbershaderProvider.

ResourceConfiguration

class ResourceConfiguration(var engine: Engine, var normalizeSkinningWeights: Boolean = false)

Construction parameters for a ResourceLoader.

ResourceLoader

class ResourceLoader(config: ResourceConfiguration) : AutoCloseable

ResourceLoader loads external resources referenced by glTF assets.

TextureProvider

class TextureProvider(nativeHandle: NativePointer) : AutoCloseable

Decodes the textures ResourceLoader hands it for the MIME types it's registered under with ResourceLoader.addTextureProvider. Destroy it after the loaders using it.

UvMap

typealias UvMap = Array<UvSet>

Maps each glTF texcoord set (the index) to a Filament UvSet; UV_MAP_SIZE entries.

UvSet

enum UvSet : Enum<UvSet>

One of Filament's UV sets a glTF texcoord set maps to.

Properties

UV_MAP_SIZE

const val UV_MAP_SIZE: Int = 8

Entries in a UvMap.

Functions

constrainMaterial

fun constrainMaterial(key: MaterialKey, uvmap: UvMap)

Trims key's requested features down to what the providers support, and fills uvmap with the resulting glTF-texcoord → Filament-UV-set mapping. Called by providers before material creation.

createKtx2Provider

fun createKtx2Provider(engine: Engine): TextureProvider

A provider transcoding KTX2 (Basis Universal); register it for image/ktx2.

createStbProvider

fun createStbProvider(engine: Engine): TextureProvider

A provider decoding PNG and JPEG with stb_image; register it for image/png and image/jpeg.

createUbershaderProvider

fun createUbershaderProvider(engine: Engine): MaterialProvider

A provider over gltfio's default pre-compiled ubershader materials.

createWebpProvider

fun createWebpProvider(engine: Engine): TextureProvider?

A provider decoding WebP, or null where this build has no WebP support (isWebpSupported); register it for image/webp.

getNumUvSets

fun getNumUvSets(uvmap: UvMap): Int

The number of Filament UV sets uvmap uses.

isWebpSupported

fun isWebpSupported(): Boolean

Whether this build of gltfio can decode WebP textures.