Package org.gnome.gdk

Class DmabufFormats

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gdk.DmabufFormats

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class DmabufFormats
extends ProxyInstance

The GdkDmabufFormats struct provides information about supported DMA buffer formats.

You can query whether a given format is supported with contains(int, long) and you can iterate over the list of all supported formats with getNFormats() and getFormat(long, io.github.jwharm.javagi.base.Out<java.lang.Integer>, io.github.jwharm.javagi.base.Out<java.lang.Long>).

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.

Constructor Summary

Constructors

Constructor	Description
DmabufFormats(MemorySegment address)	Create a DmabufFormats proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
boolean	contains(int fourcc, long modifier)	Returns whether a given format is contained in this DmabufFormats.
boolean	equal(@Nullable DmabufFormats formats2)	Returns whether this DmabufFormats and formats2 contain the same dmabuf formats, in the same order.
void	getFormat(long idx, Out<Integer> fourcc, Out<Long> modifier)	Gets the fourcc code and modifier for a format that is contained in this DmabufFormats.
long	getNFormats()	Returns the number of formats that the this DmabufFormats object contains.
static Type	getType()	Get the GType of the DmabufFormats class
DmabufFormats	ref()	Increases the reference count of this DmabufFormats.
void	unref()	Decreases the reference count of this DmabufFormats.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DmabufFormats

public DmabufFormats(MemorySegment address)

Create a DmabufFormats proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the DmabufFormats class

Returns:

the GType

contains

public boolean contains(int fourcc,
 long modifier)

Returns whether a given format is contained in this DmabufFormats.

Parameters:

fourcc - a format code

modifier - a format modifier

Returns:

TRUE if the format specified by the arguments is part of this DmabufFormats

equal

public boolean equal(@Nullable
 @Nullable DmabufFormats formats2)

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

Parameters:

formats2 - another GdkDmabufFormats

Returns:

TRUE if this DmabufFormats and formats2 are equal

getFormat

public void getFormat(long idx,
 Out<Integer> fourcc,
 Out<Long> modifier)

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

Parameters:

idx - the index of the format to return

fourcc - return location for the format code

modifier - return location for the format modifier

getNFormats

public long getNFormats()

Returns the number of formats that the this DmabufFormats object contains.

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

Returns:

the number of formats

ref

public DmabufFormats ref()

Increases the reference count of this DmabufFormats.

Returns:

the passed-in object

unref

public void unref()

Decreases the reference count of this DmabufFormats.

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