Texture, or images, referenced by Material properties.

Textures in glTF-Transform are a combination of glTF's texture and image properties, and should be unique within a document, such that no other texture contains the same getImage() data. Where duplicates may already exist, the dedup({textures: true}) transform can remove them. A Document with N texture properties will be exported to a glTF file with N image properties, and the minimum number of texture properties necessary for the materials that use it.

For properties associated with a particular use of a texture, see TextureInfo.

Reference:

Hierarchy

Properties

propertyType: string

Property type.

Methods

  • clone(): this
  • copy(other: this, resolve: PropertyResolver<Property>): this
  • Copies all data from another property to this one. Child properties are copied by reference, unless a 'resolve' function is given to override that.

  • detach(): this
  • Removes all inbound references to this object. At the end of the process the object is considered 'detached': it may hold references to child resources, but nothing holds references to it. A detached object may be re-attached.

  • dispose(): void
  • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

  • getExtension<Prop>(name: string): Prop
  • getExtras(): object
  • Returns a reference to the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • getImage(): ArrayBuffer
  • getMimeType(): string
  • getName(): string
  • Returns the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • getSize(): vec2
  • getURI(): string
  • isDisposed(): boolean
  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
        .listParents()
        .filter((p) => p instanceof Material)
  • setExtension<Prop>(name: string, extensionProperty: Prop): this
  • setExtras(extras: object): this
  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • setImage(image: ArrayBuffer): this
  • setMimeType(mimeType: string): this
  • Sets the MIME type for this texture ('image/jpeg' or 'image/png'). If the texture does not have a URI, a MIME type is required for correct export.

  • setName(name: string): this
  • Sets the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • setURI(uri: string): this
  • Sets the URI (e.g. 'path/to/file.png') for this texture. If the texture does not have a MIME type, a URI is required for correct export.

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

Made by Don McCurdy TypeDoc documentation Copyright 2020 under MIT license