.. index:: 
  !DocumentImage.pixelFormat Property

.. _id3_document_document_image_pixel_format_class_member:

===============================================================================
DocumentImage.pixelFormat Property
===============================================================================

Module: :ref:`DocumentImage<id3_document_document_image_class>`

Type: :ref:`PixelFormat<id3_document_pixel_format_enum>`

Definition
----------

Pixel format.


.. tab-set::

  .. tab-item:: Python
    :sync: Python

    .. code:: Python

      pixel_format: PixelFormat


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Dart
    :sync: Dart

    .. code:: Dart

      PixelFormat get pixelFormat => getPixelFormat();


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: C#
    :sync: C#

    .. code:: C#

      public PixelFormat pixelFormat
      {
          get => GetpixelFormat();
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Java
    :sync: Java

    .. code:: Java

      public PixelFormat getPixelFormat() throws DocumentException


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: Swift
    :sync: Swift

    .. code:: Swift

      public var pixelFormat: PixelFormat
          get {
              return try! getPixelFormat()
          }
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

  .. tab-item:: C
    :sync: C

    .. code:: C

      int id3DocumentImage_GetPixelFormat (ID3_DOCUMENT_IMAGE hDocumentImage, id3DocumentPixelFormat * ePixelFormat)

    **Returns**
   
      .. line-block::

        ``int``
        An error code.
        See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.

