.. role:: ts-api-decorator

##############
TextureOptions
##############

.. container:: ts-api-section

   .. js:class:: TextureOptions

      Parameters that describe a texture and control how it is applied.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~TextureOptions.imageId`
   * :js:attr:`~TextureOptions.interpolation`
   * :js:attr:`~TextureOptions.matrix`
   * :js:attr:`~TextureOptions.mipMapping`
   * :js:attr:`~TextureOptions.modifiers`
   * :js:attr:`~TextureOptions.parameterization`
   * :js:attr:`~TextureOptions.tiling`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: TextureOptions.imageId

      :type: ImageId :ts-api-decorator:`optional`

      The image used by this texture.



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.interpolation

      :type: boolean :ts-api-decorator:`optional`

      Enables or disables interpolation of texel colors (also known as linear filtering).
      (Default: ``true``)

      If disabled, the texture image will appear pixelated when enlarged.



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.matrix

      :type: Matrix :ts-api-decorator:`optional`

      A matrix to be applied to the texture's UV coordinates. If not specified,
      the identity matrix will be used.



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.mipMapping

      :type: boolean :ts-api-decorator:`optional`

      Enables or disables mipmapping. (Default: ``true``)

      Enable mipmapping to improve image quality at the expense of slightly more memory usage.
      Depending on the platform, mipmapping may take effect only for textures with dimensions
      that are powers of two.

      If disabled, textures may appear noisy when reduced in size.



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.modifiers

      :type: number :ts-api-decorator:`optional`

      Flags that control how the texture is applied. This is the result of OR-ing together
      one or more [[TextureModifier]]s. (Default: ``0``)



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.parameterization

      :type: TextureParameterization :ts-api-decorator:`optional`

      Indicates how texture coordinates are specified or generated.
      (Defalut: [[TextureParameterization.UV]])

      This controls where a given pixel of the texture appears on the object to which it is applied.



.. container:: ts-api-section

   .. js:attribute:: TextureOptions.tiling

      :type: TextureTiling :ts-api-decorator:`optional`

      Controls how UV coordinates are interpreted outside the [0.0, 1.0] range.
      (Default: [[TextureTiling.Repeat]])



