GI.Gdk.Structs.DmabufFormats

The GdkDmabufFormats struct provides information about supported DMA buffer formats.

You can query whether a given format is supported with dmabufFormatsContains and you can iterate over the list of all supported formats with dmabufFormatsGetNFormats and dmabufFormatsGetFormat.

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.

Since: 4.14

Exported types

newtype DmabufFormats

Memory-managed wrapper type.

Constructors

DmabufFormats (ManagedPtr DmabufFormats)

Instances

Eq DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

Methods

(==) :: DmabufFormats -> DmabufFormats -> Bool

(/=) :: DmabufFormats -> DmabufFormats -> Bool

GBoxed DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

ManagedPtrNewtype DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

Methods

toManagedPtr :: DmabufFormats -> ManagedPtr DmabufFormats

TypedObject DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

Methods

glibType :: IO GType

HasParentTypes DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

IsGValue (Maybe DmabufFormats)

Convert DmabufFormats to and from GValue. See toGValue and fromGValue.

Defined in GI.Gdk.Structs.DmabufFormats

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe DmabufFormats -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe DmabufFormats)

type ParentTypes DmabufFormats

Defined in GI.Gdk.Structs.DmabufFormats

type ParentTypes DmabufFormats = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

contains, equal, ref, unref.

Getters

getFormat, getNFormats.

Setters

None.

contains

dmabufFormatsContains

Arguments

:: (HasCallStack, MonadIO m)

=> DmabufFormats

formats: a GdkDmabufFormats

-> Word32

fourcc: a format code

-> Word64

modifier: a format modifier

-> m Bool

Returns: TRUE if the format specified by the arguments is part of formats

Returns whether a given format is contained in formats.

Since: 4.14

equal

dmabufFormatsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe DmabufFormats

formats1: a GdkDmabufFormats

-> Maybe DmabufFormats

formats2: another GdkDmabufFormats

-> m Bool

Returns: TRUE if formats1 and formats2 are equal

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

Since: 4.14

getFormat

dmabufFormatsGetFormat

Arguments

:: (HasCallStack, MonadIO m)

=> DmabufFormats

formats: a GdkDmabufFormats

-> CSize

idx: the index of the format to return

-> m (Word32, Word64)

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

Since: 4.14

getNFormats

dmabufFormatsGetNFormats

Arguments

:: (HasCallStack, MonadIO m)

=> DmabufFormats

formats: a GdkDmabufFormats

-> m CSize

Returns: the number of formats

Returns the number of formats that the formats object contains.

Note that DMA buffers are a Linux concept, so on other platforms, dmabufFormatsGetNFormats will always return zero.

Since: 4.14

ref

dmabufFormatsRef

Arguments

:: (HasCallStack, MonadIO m)

=> DmabufFormats

formats: a GdkDmabufFormats

-> m DmabufFormats

Returns: the passed-in object

Increases the reference count of formats.

Since: 4.14

unref

dmabufFormatsUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DmabufFormats

formats: a GdkDmabufFormats

-> m ()

Decreases the reference count of formats.

When the reference count reaches zero, the object is freed.

Since: 4.14