.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: ImageOptions

   Parameters that describe an image to be used as a texture map.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~ImageOptions.data`
   * :js:data:`~ImageOptions.format`
   * :js:data:`~ImageOptions.height`
   * :js:data:`~ImageOptions.width`
   
   




Properties
==========

.. js:data:: ImageOptions.data

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | data: *Uint8Array*
   
   The raw image data
   



.. js:data:: ImageOptions.format

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | format: :js:data:`~ImageFormat`
   
   The format of the ``data`` property
   



.. js:data:: ImageOptions.height

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | height: *number*
   
   For uncompressed formats, the height of the image data in pixels. Ignored for compressed formats.
   



.. js:data:: ImageOptions.width

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | width: *number*
   
   For uncompressed formats, the width of the image data in pixels. Ignored for compressed formats.
   





