DmabufFormats

Added in version 4.14.

class DmabufFormats(*args, **kwargs)

The GdkDmabufFormats struct provides information about supported DMA buffer formats.

You can query whether a given format is supported with contains and you can iterate over the list of all supported formats with get_n_formats and 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 DmabufTextureBuilder for more information about DMA buffers.

Note that DMA buffers only exist on Linux.

Methods

class DmabufFormats
contains(fourcc: int, modifier: int) bool

Returns whether a given format is contained in formats.

Added in version 4.14.

Parameters:
  • fourcc – a format code

  • modifier – a format modifier

equal(formats2: DmabufFormats | None = None) bool

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

Added in version 4.14.

Parameters:

formats2 – another GdkDmabufFormats

get_format(idx: int) tuple[int, int]

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

Added in version 4.14.

Parameters:

idx – the index of the format to return

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, get_n_formats will always return zero.

Added in version 4.14.