glTF-Transform
Options
Menu

TextureTransform

KHR_texture_transform adds offset, rotation, and scale to TextureInfo properties.

Affine UV transforms are useful for reducing the number of textures the GPU must load, improving performance when used in techniques like texture atlases. UV transforms cannot be animated at this time.

Properties:

Example

The TextureTransform class provides a single ExtensionProperty type, Transform, which may be attached to any TextureInfo instance. For example:

import { TextureTransform } from '@gltf-transform/extensions';

// Create an Extension attached to the Document.
const transformExtension = document.createExtension(TextureTransform)
    .setRequired(true);

// Create a reusable Transform.
const transform = transformExtension.createTransform()
    .setScale([100, 100]);

// Apply the Transform to a Material's baseColorTexture.
document.createMaterial()
    .setBaseColorTexture(myTexture)
    .getBaseColorTextureInfo()
    .setExtension('KHR_texture_transform', transform);

Hierarchy

  • Extension
    • TextureTransform

Properties

extensionName: "KHR_texture_transform" = ...
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): TextureTransform

  • 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): TextureTransform

  • 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