KHR_materials_ior defines index of refraction on a glTF PBR material.

The dielectric BRDF of the metallic-roughness material in glTF uses a fixed value of 1.5 for the index of refraction. This is a good fit for many plastics and glass, but not for other materials like water or asphalt, sapphire or diamond. KHR_materials_ior allows users to set the index of refraction to a certain value.

Properties:

Example

import { MaterialsIOR, IOR } from '@gltf-transform/extensions';

// Create an Extension attached to the Document.
const iorExtension = document.createExtension(MaterialsIOR);

// Create IOR property.
const ior = iorExtension.createIOR().setIOR(1.0);

// Assign to a Material.
material.setExtension('KHR_materials_ior', ior);

Hierarchy

  • Extension
    • MaterialsIOR

Properties

extensionName: "KHR_materials_ior" = ...
EXTENSION_NAME: "KHR_materials_ior" = ...

Methods

  • createIOR(): IOR
  • dispose(): void
  • Disables and removes the extension from the Document.

  • isRequired(): boolean
  • Indicates to the client whether it is OK to load the asset when this extension is not recognized. Optional extensions are generally preferred, if there is not a good reason to require a client to completely fail when an extension isn't known.

  • Indicates to the client whether it is OK to load the asset when this extension is not recognized. Optional extensions are generally preferred, if there is not a good reason to require a client to completely fail when an extension isn't known.

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2021 under MIT license