Package org.lwjgl.vulkan

Class KHRExternalFenceWin32

java.lang.Object
org.lwjgl.vulkan.KHRExternalFenceWin32
public class KHRExternalFenceWin32 extends Object
An application using external memory may wish to synchronize access to that memory using fences. This extension enables an application to export fence payload to and import fence payload from Windows handles.
Name String
VK_KHR_external_fence_win32
Extension Type
Device extension
Registered Extension Number
115
Revision
1
Extension and Version Dependencies
VK_KHR_external_fence
Contact
Other Extension Metadata
Last Modified Date
2017-05-08
IP Status
No known IP claims.
Contributors

  • Field Details

  • Method Details

    • nvkImportFenceWin32HandleKHR

      public static int nvkImportFenceWin32HandleKHR(org.lwjgl.vulkan.VkDevice device, long pImportFenceWin32HandleInfo)
      Unsafe version of: ImportFenceWin32HandleKHR

    • vkImportFenceWin32HandleKHR

      public static int vkImportFenceWin32HandleKHR(org.lwjgl.vulkan.VkDevice device, VkImportFenceWin32HandleInfoKHR pImportFenceWin32HandleInfo)
      Import a fence from a Windows HANDLE.
      C Specification

      To import a fence payload from a Windows handle, call:

      
 VkResult vkImportFenceWin32HandleKHR(
     VkDevice                                    device,
     const VkImportFenceWin32HandleInfoKHR*      pImportFenceWin32HandleInfo);
      Description

      Importing a fence payload from Windows handles does not transfer ownership of the handle to the Vulkan implementation. For handle types defined as NT handles, the application must release ownership using the CloseHandle system call when the handle is no longer needed.

      Applications can import the same fence payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance.

      Valid Usage
      • fence must not be associated with any queue command that has not yet completed execution on that queue
      Valid Usage (Implicit)
      Return Codes
      On success, this command returns
      On failure, this command returns
      See Also

      VkImportFenceWin32HandleInfoKHR

      Parameters:
      device - the logical device that created the fence.
      pImportFenceWin32HandleInfo - a pointer to a VkImportFenceWin32HandleInfoKHR structure specifying the fence and import parameters.

    • nvkGetFenceWin32HandleKHR

      public static int nvkGetFenceWin32HandleKHR(org.lwjgl.vulkan.VkDevice device, long pGetWin32HandleInfo, long pHandle)
      Unsafe version of: GetFenceWin32HandleKHR

    • vkGetFenceWin32HandleKHR

      public static int vkGetFenceWin32HandleKHR(org.lwjgl.vulkan.VkDevice device, VkFenceGetWin32HandleInfoKHR pGetWin32HandleInfo, org.lwjgl.PointerBuffer pHandle)
      Get a Windows HANDLE for a fence.
      C Specification

      To export a Windows handle representing the state of a fence, call:

      
 VkResult vkGetFenceWin32HandleKHR(
     VkDevice                                    device,
     const VkFenceGetWin32HandleInfoKHR*         pGetWin32HandleInfo,
     HANDLE*                                     pHandle);
      Description

      For handle types defined as NT handles, the handles returned by vkGetFenceWin32HandleKHR are owned by the application. To avoid leaking resources, the application must release ownership of them using the CloseHandle system call when they are no longer needed.

      Exporting a Windows handle from a fence may have side effects depending on the transference of the specified handle type, as described in Importing Fence Payloads.

      Valid Usage (Implicit)
      • device must be a valid VkDevice handle
      • pGetWin32HandleInfo must be a valid pointer to a valid VkFenceGetWin32HandleInfoKHR structure
      • pHandle must be a valid pointer to a HANDLE value
      Return Codes
      On success, this command returns
      On failure, this command returns
      See Also

      VkFenceGetWin32HandleInfoKHR

      Parameters:
      device - the logical device that created the fence being exported.
      pGetWin32HandleInfo - a pointer to a VkFenceGetWin32HandleInfoKHR structure containing parameters of the export operation.
      pHandle - will return the Windows handle representing the fence state.