Class VkFenceGetWin32HandleInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkFenceGetWin32HandleInfoKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure describing a Win32 handle fence export operation.
    Description

    The properties of the handle 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 the fence’s current payload was created.
    • If handleType is defined as an NT handle, GetFenceWin32HandleKHR must be called no more than once for each valid unique combination of fence and handleType.
    • 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.
    • 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.
    • handleType must be defined as an NT handle or a global share handle.
    Valid Usage (Implicit)
    See Also

    GetFenceWin32HandleKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • fence – the fence from which state will be exported.
    • handleType – the type of handle requested.

    Layout

    
     struct VkFenceGetWin32HandleInfoKHR {
         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

      • VkFenceGetWin32HandleInfoKHR

        public VkFenceGetWin32HandleInfoKHR​(java.nio.ByteBuffer container)
        Creates a VkFenceGetWin32HandleInfoKHR 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()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • fence

        public long fence()
        Returns the value of the fence field.
      • handleType

        public int handleType()
        Returns the value of the handleType field.
      • set

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

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

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

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

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

        public static VkFenceGetWin32HandleInfoKHR mallocStack()
        Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkFenceGetWin32HandleInfoKHR callocStack()
        Returns a new VkFenceGetWin32HandleInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

        public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack​(int capacity,
                                                                      org.lwjgl.system.MemoryStack stack)
        Returns a new VkFenceGetWin32HandleInfoKHR.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.