KHR_materials_unlit defines an unlit shading model for use in glTF 2.0 materials.

Illustration

Figure: Unlit materials are useful for flat shading, stylized effects, and for improving performance on mobile devices. Source: Model by Hayden VanEarden.

Unlit (also "Shadeless" or "Constant") materials provide a simple alternative to the Physically Based Rendering (PBR) shading models provided by the core specification. Unlit materials are often useful for cheaper rendering on performance-contrained devices, e.g. mobile phones. Additionally, unlit materials can be very useful in achieving stylized, non-photo-realistic effects like hand painted illustrative styles or baked toon shaders.

Properties:

Example

The MaterialsUnlit class provides a single ExtensionProperty type, Unlit, which may be attached to any Material instance. For example:

import { MaterialsUnlit, Unlit } from '@gltf-transform/extensions';

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

// Create an Unlit property.
const unlit = unlitExtension.createUnlit();

// Attach the property to a Material.
material.setExtension('KHR_materials_unlit', unlit);

Hierarchy

  • Extension
    • MaterialsUnlit

Properties

extensionName: "KHR_materials_unlit" = ...

Methods

  • 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