Settings associated with a particular use of a Texture.

Different materials may reuse the same texture but with different texture coordinates, minFilter/magFilter, or wrapS/wrapT settings. The TextureInfo class contains settings derived from both the "TextureInfo" and "Sampler" properties in the glTF specification, consolidated here for simplicity.

TextureInfo properties cannot be directly created. For any material texture slot, such as baseColorTexture, there will be a corresponding method to obtain the TextureInfo for that slot. For example, see Material.getBaseColorTextureInfo.

References:

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.

  • getMagFilter(): TextureMagFilter
  • getMinFilter(): TextureMinFilter
  • 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.

  • getTexCoord(): number
  • getWrapS(): TextureWrapMode
  • getWrapT(): TextureWrapMode
  • 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.

  • setMagFilter(magFilter: TextureMagFilter): this
  • setMinFilter(minFilter: TextureMinFilter): this
  • 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.

  • setTexCoord(texCoord: number): this
  • setWrapS(wrapS: TextureWrapMode): this
  • setWrapT(wrapT: TextureWrapMode): this

Object literals

TextureMagFilter: object

Magnification filter. Values correspond to WebGL enums.

TextureMinFilter: object

Minification filter. Values correspond to WebGL enums.

TextureWrapMode: object

UV wrapping mode. Values correspond to WebGL enums.

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

Made by Don McCurdy TypeDoc documentation Copyright 2020 under MIT license