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

MaterialKey

actual class MaterialKey

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.

See also

MaterialProvider

expect class MaterialKey

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.

See also

MaterialProvider

actual class MaterialKey

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.

See also

MaterialProvider

actual class MaterialKey

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.

See also

MaterialProvider

actual class MaterialKey

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.

See also

MaterialProvider

Constructors

actual constructor()

Create a new MaterialKey with default values.

expect constructor()

Create a new MaterialKey with default values.

actual constructor()

actual constructor()

actual constructor()

Create a new MaterialKey with default values.

Properties

actual var alphaMode: Int

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

expect var alphaMode: Int

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

actual var alphaMode: Int

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

actual var alphaMode: Int

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

actual var alphaMode: Int

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

actual var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

expect var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

actual var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

actual var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

actual var aoUV: Int

glTF texcoord set index for the ambient-occlusion texture.

actual var baseColorUV: Int

glTF texcoord set index for the base color texture.

expect var baseColorUV: Int

glTF texcoord set index for the base color texture.

actual var baseColorUV: Int

glTF texcoord set index for the base color texture.

actual var baseColorUV: Int

glTF texcoord set index for the base color texture.

actual var baseColorUV: Int

glTF texcoord set index for the base color texture.

clearCoatNormalUV

actual var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

expect var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

actual var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

actual var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

actual var clearCoatNormalUV: Int

glTF texcoord set index for the clearcoat normal map.

clearCoatRoughnessUV

actual var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

expect var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

actual var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

actual var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

actual var clearCoatRoughnessUV: Int

glTF texcoord set index for the clearcoat roughness texture.

actual var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

expect var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

actual var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

actual var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

actual var clearCoatUV: Int

glTF texcoord set index for the clearcoat texture.

actual var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

expect var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

actual var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

actual var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

actual var doubleSided: Boolean

Renders both faces of each triangle (glTF doubleSided).

actual var emissiveUV: Int

glTF texcoord set index for the emissive texture.

expect var emissiveUV: Int

glTF texcoord set index for the emissive texture.

actual var emissiveUV: Int

glTF texcoord set index for the emissive texture.

actual var emissiveUV: Int

glTF texcoord set index for the emissive texture.

actual var emissiveUV: Int

glTF texcoord set index for the emissive texture.

enableDiagnostics

actual var enableDiagnostics: Boolean

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

expect var enableDiagnostics: Boolean

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

actual var enableDiagnostics: Boolean

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

actual var enableDiagnostics: Boolean

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

actual var enableDiagnostics: Boolean

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

hasBaseColorTexture

actual var hasBaseColorTexture: Boolean

A base color texture is bound.

expect var hasBaseColorTexture: Boolean

A base color texture is bound.

actual var hasBaseColorTexture: Boolean

A base color texture is bound.

actual var hasBaseColorTexture: Boolean

A base color texture is bound.

actual var hasBaseColorTexture: Boolean

A base color texture is bound.

actual var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

expect var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

actual var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

actual var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

actual var hasClearCoat: Boolean

The clearcoat layer is enabled (KHR_materials_clearcoat).

hasClearCoatNormalTexture

actual var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

expect var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

actual var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

actual var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

actual var hasClearCoatNormalTexture: Boolean

A clearcoat normal map is bound.

hasClearCoatRoughnessTexture

actual var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

expect var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

actual var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

actual var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

actual var hasClearCoatRoughnessTexture: Boolean

A clearcoat roughness texture is bound.

hasClearCoatTexture

actual var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

expect var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

actual var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

actual var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

actual var hasClearCoatTexture: Boolean

A clearcoat intensity texture is bound.

hasEmissiveTexture

actual var hasEmissiveTexture: Boolean

An emissive texture is bound.

expect var hasEmissiveTexture: Boolean

An emissive texture is bound.

actual var hasEmissiveTexture: Boolean

An emissive texture is bound.

actual var hasEmissiveTexture: Boolean

An emissive texture is bound.

actual var hasEmissiveTexture: Boolean

An emissive texture is bound.

actual var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

expect var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

actual var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

actual var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

actual var hasIOR: Boolean

A custom index of refraction is set (KHR_materials_ior).

hasMetallicRoughnessTexture

actual var hasMetallicRoughnessTexture: Boolean

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

expect var hasMetallicRoughnessTexture: Boolean

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

actual var hasMetallicRoughnessTexture: Boolean

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

actual var hasMetallicRoughnessTexture: Boolean

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

actual var hasMetallicRoughnessTexture: Boolean

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

hasNormalTexture

actual var hasNormalTexture: Boolean

A tangent-space normal map is bound.

expect var hasNormalTexture: Boolean

A tangent-space normal map is bound.

actual var hasNormalTexture: Boolean

A tangent-space normal map is bound.

actual var hasNormalTexture: Boolean

A tangent-space normal map is bound.

actual var hasNormalTexture: Boolean

A tangent-space normal map is bound.

hasOcclusionTexture

actual var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

expect var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

actual var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

actual var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

actual var hasOcclusionTexture: Boolean

An ambient-occlusion texture is bound.

actual var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

expect var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

actual var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

actual var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

actual var hasSheen: Boolean

The sheen layer is enabled (KHR_materials_sheen).

hasSheenColorTexture

actual var hasSheenColorTexture: Boolean

A sheen color texture is bound.

expect var hasSheenColorTexture: Boolean

A sheen color texture is bound.

actual var hasSheenColorTexture: Boolean

A sheen color texture is bound.

actual var hasSheenColorTexture: Boolean

A sheen color texture is bound.

actual var hasSheenColorTexture: Boolean

A sheen color texture is bound.

hasSheenRoughnessTexture

actual var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

expect var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

actual var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

actual var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

actual var hasSheenRoughnessTexture: Boolean

A sheen roughness texture is bound.

hasTextureTransforms

actual var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

expect var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

actual var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

actual var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

actual var hasTextureTransforms: Boolean

One or more textures use KHR_texture_transform.

hasTransmission

actual var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

expect var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

actual var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

actual var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

actual var hasTransmission: Boolean

Transmission is enabled (KHR_materials_transmission).

hasTransmissionTexture

actual var hasTransmissionTexture: Boolean

A transmission texture is bound.

expect var hasTransmissionTexture: Boolean

A transmission texture is bound.

actual var hasTransmissionTexture: Boolean

A transmission texture is bound.

actual var hasTransmissionTexture: Boolean

A transmission texture is bound.

actual var hasTransmissionTexture: Boolean

A transmission texture is bound.

hasVertexColors

actual var hasVertexColors: Boolean

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

expect var hasVertexColors: Boolean

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

actual var hasVertexColors: Boolean

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

actual var hasVertexColors: Boolean

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

actual var hasVertexColors: Boolean

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

hasVolumeThicknessTexture

actual var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

expect var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

actual var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

actual var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

actual var hasVolumeThicknessTexture: Boolean

A volume thickness texture is bound (KHR_materials_volume).

metallicRoughnessUV

actual var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

expect var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

actual var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

actual var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

actual var metallicRoughnessUV: Int

glTF texcoord set index for the metallic-roughness texture.

actual var normalUV: Int

glTF texcoord set index for the normal map.

expect var normalUV: Int

glTF texcoord set index for the normal map.

actual var normalUV: Int

glTF texcoord set index for the normal map.

actual var normalUV: Int

glTF texcoord set index for the normal map.

actual var normalUV: Int

glTF texcoord set index for the normal map.

actual var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

expect var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

actual var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

actual var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

actual var sheenColorUV: Int

glTF texcoord set index for the sheen color texture.

sheenRoughnessUV

actual var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

expect var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

actual var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

actual var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

actual var sheenRoughnessUV: Int

glTF texcoord set index for the sheen roughness texture.

actual var transmissionUV: Int

glTF texcoord set index for the transmission texture.

expect var transmissionUV: Int

glTF texcoord set index for the transmission texture.

actual var transmissionUV: Int

glTF texcoord set index for the transmission texture.

actual var transmissionUV: Int

glTF texcoord set index for the transmission texture.

actual var transmissionUV: Int

glTF texcoord set index for the transmission texture.

actual var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

expect var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

actual var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

actual var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

actual var unlit: Boolean

Uses the unlit shading model (KHR_materials_unlit).

useSpecularGlossiness

actual var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

expect var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

actual var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

actual var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

actual var useSpecularGlossiness: Boolean

Uses the legacy specular-glossiness workflow (KHR_materials_pbrSpecularGlossiness).

volumeThicknessUV

actual var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

expect var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

actual var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

actual var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

actual var volumeThicknessUV: Int

glTF texcoord set index for the volume thickness texture.

Functions

constrainMaterial

actual fun 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 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.

actual fun 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.

actual fun 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.

actual fun 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.