gltfio/io.github.erkko68.filament.gltfio/MaterialKey

MaterialKey

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)

MaterialKey encodes glTF material properties for material selection and creation.

MaterialKey holds a set of boolean flags and texture coordinates that describe the properties of a glTF material. MaterialProvider uses this to determine which material to create or select. Key properties include texture presence, shading model, alpha mode, and advanced features like clearcoat and transmission.

Constructors

MaterialKey

constructor(doubleSided: Boolean = false, unlit: Boolean = false, hasVertexColors: Boolean = false, hasBaseColorTexture: Boolean = false, hasNormalTexture: Boolean = false, hasOcclusionTexture: Boolean = false, hasEmissiveTexture: Boolean = false, useSpecularGlossiness: Boolean = false, alphaMode: AlphaMode = AlphaMode.OPAQUE, enableDiagnostics: Boolean = false, hasMetallicRoughnessTexture: Boolean = false, metallicRoughnessUV: Int = 0, baseColorUV: Int = 0, hasClearCoatTexture: Boolean = false, clearCoatUV: Int = 0, hasClearCoatRoughnessTexture: Boolean = false, clearCoatRoughnessUV: Int = 0, hasClearCoatNormalTexture: Boolean = false, clearCoatNormalUV: Int = 0, hasClearCoat: Boolean = false, hasTransmission: Boolean = false, hasTextureTransforms: Boolean = false, emissiveUV: Int = 0, aoUV: Int = 0, normalUV: Int = 0, hasTransmissionTexture: Boolean = false, transmissionUV: Int = 0, hasSheenColorTexture: Boolean = false, sheenColorUV: Int = 0, hasSheenRoughnessTexture: Boolean = false, sheenRoughnessUV: Int = 0, hasVolumeThicknessTexture: Boolean = false, volumeThicknessUV: Int = 0, hasSheen: Boolean = false, hasIOR: Boolean = false)

Properties

alphaMode

var alphaMode: AlphaMode

Alpha mode: 0 = OPAQUE, 1 = MASK (alpha cutoff), 2 = BLEND.

aoUV

var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

baseColorUV

var baseColorUV: Int

glTF texcoord set index for the base color texture.

clearCoatNormalUV

var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

clearCoatRoughnessUV

var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

clearCoatUV

var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

doubleSided

var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

emissiveUV

var emissiveUV: Int

glTF texcoord set index for the emissive texture.

enableDiagnostics

var enableDiagnostics: Boolean

Enables shader diagnostics (visualizes the material as a debug aid).

hasBaseColorTexture

var hasBaseColorTexture: Boolean

A base color texture is bound.

hasClearCoat

var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

hasClearCoatNormalTexture

var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

hasClearCoatRoughnessTexture

var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

hasClearCoatTexture

var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

hasEmissiveTexture

var hasEmissiveTexture: Boolean

An emissive texture is bound.

hasIOR

var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

hasMetallicRoughnessTexture

var hasMetallicRoughnessTexture: Boolean

A metallic-roughness texture is bound (specular-glossiness texture when useSpecularGlossiness).

hasNormalTexture

var hasNormalTexture: Boolean

A tangent-space normal map is bound.

hasOcclusionTexture

var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

hasSheen

var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

hasSheenColorTexture

var hasSheenColorTexture: Boolean

A sheen color texture is bound.

hasSheenRoughnessTexture

var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

hasTextureTransforms

var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

hasTransmission

var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

hasTransmissionTexture

var hasTransmissionTexture: Boolean

A transmission texture is bound.

hasVertexColors

var hasVertexColors: Boolean

The mesh provides per-vertex COLOR_0 data to be multiplied into base color.

hasVolumeThicknessTexture

var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

metallicRoughnessUV

var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

normalUV

var normalUV: Int

glTF texcoord set index for the normal map.

sheenColorUV

var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

sheenRoughnessUV

var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

transmissionUV

var transmissionUV: Int

glTF texcoord set index for the transmission texture.

unlit

var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

useSpecularGlossiness

var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

volumeThicknessUV

var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

Functions

constrainMaterial

actual fun MaterialKey.constrainMaterial(uvmap: IntArray)

Mutates this key to trim requested features down to what the provider supports, and fills uvmap with the resulting glTF-texcoord → Filament-UV-set mapping. Called by providers before material creation.

expect fun MaterialKey.constrainMaterial(uvmap: IntArray)

actual fun MaterialKey.constrainMaterial(uvmap: IntArray)

MaterialKey

See also

Constructors

Properties

Functions