glTF-Transform
Options
Menu

MaterialsSheen

KHR_materials_sheen defines a velvet-like sheen layered on a glTF PBR material.

Illustration

Figure: A cushion, showing high material roughness and low sheen roughness. Soft highlights at edges of the material show backscattering from microfibers. Source: Khronos Group.

A sheen layer is a common technique used in Physically-Based Rendering to represent cloth and fabric materials.

Properties:

Example

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

import { MaterialsSheen, Sheen } from '@gltf-transform/extensions';

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

// Create a Sheen property.
const sheen = sheenExtension.createSheen()
    .setSheenColorFactor([1.0, 1.0, 1.0]);

// Attach the property to a Material.
material.setExtension('KHR_materials_sheen', sheen);

Hierarchy

  • Extension
    • MaterialsSheen

Properties

extensionName: "KHR_materials_sheen" = ...
prereadTypes: PropertyType[]

Before reading, extension should be called for these Property types. Most extensions don't need to implement this.

prewriteTypes: PropertyType[]

Before writing, extension should be called for these Property types. Most extensions don't need to implement this.

readDependencies: string[]

Dependency IDs needed by this extension, to be installed before I/O.

Methods

  • dispose(): void

  • Disables and removes the extension from the Document.

  • Installs dependencies required by the extension.

  • 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.

  • preread(_readerContext: ReaderContext, _propertyType: PropertyType): MaterialsSheen

  • Used by the PlatformIO utilities when reading a glTF asset. This method may optionally be implemented by an extension, and should then support any property type declared by the Extension's Extension.prereadTypes list. The Extension will be given a ReaderContext instance, and is expected to update either the context or its JSONDocument with resources known to the Extension. Most extensions don't need to implement this.

  • prewrite(_writerContext: WriterContext, _propertyType: PropertyType): MaterialsSheen

  • Used by the PlatformIO utilities when writing a glTF asset. This method may optionally be implemented by an extension, and should then support any property type declared by the Extension's Extension.prewriteTypes list. The Extension will be given a WriterContext instance, and is expected to update either the context or its JSONDocument with resources known to the Extension. Most extensions don't need to implement this.

  • 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.

  • register(): void

  • Performs first-time setup for the extension. Must be idempotent.

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

Made by Don McCurdy • TypeDoc documentation • Copyright 2021 under MIT license