Package org.lwjgl.vulkan

Class VkFenceGetFdInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkFenceGetFdInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure describing a POSIX FD fence export operation.
    Description

    The properties of the file descriptor returned depend on the value of handleType. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

    Valid Usage
    • handleType must have been included in VkExportFenceCreateInfo::handleTypes when fence’s current payload was created
    • If handleType refers to a handle type with copy payload transference semantics, fence must be signaled, or have an associated fence signal operation pending execution
    • fence must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in VkExternalFenceProperties::exportFromImportedHandleTypes for handleType
    • handleType must be defined as a POSIX file descriptor handle
    Valid Usage (Implicit)
    See Also

    GetFenceFdKHR

    Layout

    
 struct VkFenceGetFdInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkFence fence();
     VkExternalFenceHandleTypeFlagBits handleType();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, FENCE, HANDLETYPE

        The struct member offsets.

    • Constructor Detail

      • VkFenceGetFdInfoKHR

        public VkFenceGetFdInfoKHR​(java.nio.ByteBuffer container)
        Creates a VkFenceGetFdInfoKHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • sType

        public int sType()
        the type of this structure.

      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.

      • fence

        public long fence()
        the fence from which state will be exported.

      • handleType

        public int handleType()
        a VkExternalFenceHandleTypeFlagBits value specifying the type of handle requested.

      • set

        public VkFenceGetFdInfoKHR set​(int sType,
                               long pNext,
                               long fence,
                               int handleType)
        Initializes this struct with the specified values.

      • malloc

        public static VkFenceGetFdInfoKHR malloc()
        Returns a new VkFenceGetFdInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkFenceGetFdInfoKHR calloc()
        Returns a new VkFenceGetFdInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkFenceGetFdInfoKHR create()
        Returns a new VkFenceGetFdInfoKHR instance allocated with BufferUtils.

      • create

        public static VkFenceGetFdInfoKHR create​(long address)
        Returns a new VkFenceGetFdInfoKHR instance for the specified memory address.

      • createSafe

        @Nullable
public static VkFenceGetFdInfoKHR createSafe​(long address)
        Like create, but returns null if address is NULL.

      • mallocStack

        @Deprecated
public static VkFenceGetFdInfoKHR mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static VkFenceGetFdInfoKHR callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • malloc

        public static VkFenceGetFdInfoKHR malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkFenceGetFdInfoKHR instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkFenceGetFdInfoKHR calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkFenceGetFdInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • malloc

        public static VkFenceGetFdInfoKHR.Buffer malloc​(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
        Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

        public static VkFenceGetFdInfoKHR.Buffer calloc​(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
        Returns a new VkFenceGetFdInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().

      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().

      • nfence

        public static long nfence​(long struct)
        Unsafe version of fence().

      • nhandleType

        public static int nhandleType​(long struct)
        Unsafe version of handleType().

      • nsType

        public static void nsType​(long struct,
                          int value)
        Unsafe version of sType.

      • npNext

        public static void npNext​(long struct,
                          long value)
        Unsafe version of pNext.

      • nfence

        public static void nfence​(long struct,
                          long value)
        Unsafe version of fence.

      • nhandleType

        public static void nhandleType​(long struct,
                               int value)
        Unsafe version of handleType.