:right-sidebar: True

DmabufFormats
===================================================================

.. currentmodule:: gi.repository.Gdk


.. versionadded:: 4.14




.. class:: DmabufFormats(*args, **kwargs)
   :no-contents-entry:






The ``GdkDmabufFormats`` struct provides information about
supported DMA buffer formats.

You can query whether a given format is supported with
:obj:`~gi.repository.Gdk.DmabufFormats.contains` and you can iterate
over the list of all supported formats with
:obj:`~gi.repository.Gdk.DmabufFormats.get_n_formats` and
:obj:`~gi.repository.Gdk.DmabufFormats.get_format`\.

The list of supported formats is sorted by preference,
with the best formats coming first.

The list may contains (format, modifier) pairs where the modifier
is ``DMA_FORMAT_MOD_INVALID``\, indicating that ***implicit modifiers***
may be used with this format.

See :obj:`~gi.repository.Gdk.DmabufTextureBuilder` for more information
about DMA buffers.

Note that DMA buffers only exist on Linux.




Methods
-------

.. rst-class:: interim-class

.. class:: DmabufFormats
   :no-index:


   .. method:: contains(fourcc: int, modifier: int) -> bool

      Returns whether a given format is contained in ``formats``\.


      .. versionadded:: 4.14





      :param fourcc: a format code

      :param modifier: a format modifier




   .. method:: equal(formats2: ~gi.repository.Gdk.DmabufFormats | None = None) -> bool

      Returns whether ``formats1`` and ``formats2`` contain the
      same dmabuf formats, in the same order.


      .. versionadded:: 4.14





      :param formats2: another ``GdkDmabufFormats``




   .. method:: get_format(idx: int) -> ~typing.Tuple[int, int]

      Gets the fourcc code and modifier for a format
      that is contained in ``formats``\.


      .. versionadded:: 4.14





      :param idx: the index of the format to return




   .. method:: get_n_formats() -> int

      Returns the number of formats that the ``formats`` object
      contains.

      Note that DMA buffers are a Linux concept, so on other
      platforms, :obj:`~gi.repository.Gdk.DmabufFormats.get_n_formats` will
      always return zero.


      .. versionadded:: 4.14