.. role:: ts-api-decorator

############
ImageOptions
############

.. container:: ts-api-section

   .. js:class:: ImageOptions

      Parameters that describe an image to be used as a texture map.



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~ImageOptions.data`
   * :js:attr:`~ImageOptions.format`
   * :js:attr:`~ImageOptions.height`
   * :js:attr:`~ImageOptions.width`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ImageOptions.data

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

      The raw image data



.. container:: ts-api-section

   .. js:attribute:: ImageOptions.format

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

      The format of the ``data`` property



.. container:: ts-api-section

   .. js:attribute:: ImageOptions.height

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

      For uncompressed formats, the height of the image data in pixels.
      Ignored for compressed formats.



.. container:: ts-api-section

   .. js:attribute:: ImageOptions.width

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

      For uncompressed formats, the width of the image data in pixels.
      Ignored for compressed formats.



