.. role:: ts-api-decorator

.. _ImageFormat:

###########
ImageFormat
###########

.. container:: ts-api-section

   Formats accepted when specifying texture images.



.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`ImageFormat.Gray8`
   * :ref:`ImageFormat.GrayAlpha16`
   * :ref:`ImageFormat.Jpeg`
   * :ref:`ImageFormat.Png`
   * :ref:`ImageFormat.Rgb24`
   * :ref:`ImageFormat.Rgba32`





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

Enumeration Members
===================

.. rst-class:: ts-api-section

.. _ImageFormat.Gray8:

Gray8
-----

Uncompressed grayscale, 1 byte per pixel

.. rst-class:: ts-api-section

.. _ImageFormat.GrayAlpha16:

GrayAlpha16
-----------

Uncompressed grayscale with alpha, 16 bits per pixel (1 byte per channel)

.. rst-class:: ts-api-section

.. _ImageFormat.Jpeg:

Jpeg
----

JPEG data

.. rst-class:: ts-api-section

.. _ImageFormat.Png:

Png
---

PNG data.

Note: Currently, applying PNGs inserted through the viewer API as textures
      will cause objects to which they are applied to be treated as transparent,
      which may cause undesirable behavior. This can be avoided by setting
      [[TextureModifier.Decal]] in [[TextureOptions]] when applying the texture.
      [[TextureModifier.Decal]] is not currently supported for PBR based materials.

.. rst-class:: ts-api-section

.. _ImageFormat.Rgb24:

Rgb24
-----

Uncompressed, interleaved RGB, 24 bits per pixel (1 byte per channel)

.. rst-class:: ts-api-section

.. _ImageFormat.Rgba32:

Rgba32
------

Uncompressed, interleaved RGBA, 32 bits per pixel (1 byte per channel)

