Package org.lwjgl.openxr

Class KHRVulkanEnable2

java.lang.Object

org.lwjgl.openxr.KHRVulkanEnable2

public class KHRVulkanEnable2
extends Object

The XR_KHR_vulkan_enable2 extension.

This extension enables the use of the Vulkan graphics API in an OpenXR runtime. Without this extension, the OpenXR runtime may not be able to use any Vulkan swapchain images.

This extension provides the mechanisms necessary for an application to generate a valid XrGraphicsBindingVulkan2KHR structure in order to create a Vulkan-based XrSession.

This extension also provides mechanisms for the application to interact with images acquired by calling EnumerateSwapchainImages.

In order to expose the structures, types, and functions of this extension, you must define USE_GRAPHICS_API_VULKAN before including the OpenXR platform header openxr_platform.h, in all portions of your library or application that include it.

Note

This extension is intended as an alternative to XR_KHR_vulkan_enable, and does not depend on it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_KHR_VULKAN_ENABLE2_EXTENSION_NAME	The extension name.
static final int	XR_KHR_vulkan_enable2_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_GRAPHICS_BINDING_VULKAN2_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR	Extends XrStructureType.
static final int	XR_TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR	Extends XrStructureType.
static final int	XR_TYPE_VULKAN_DEVICE_CREATE_INFO_KHR	Extends XrStructureType.
static final int	XR_TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR	Extends XrStructureType.
static final int	XR_TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateVulkanDeviceKHR(org.lwjgl.openxr.XrInstance instance, long createInfo, long vulkanDevice, long vulkanResult)	Unsafe version of: CreateVulkanDeviceKHR
static int	nxrCreateVulkanInstanceKHR(org.lwjgl.openxr.XrInstance instance, long createInfo, long vulkanInstance, long vulkanResult)	Unsafe version of: CreateVulkanInstanceKHR
static int	nxrGetVulkanGraphicsDevice2KHR(org.lwjgl.openxr.XrInstance instance, long getInfo, long vulkanPhysicalDevice)	Unsafe version of: GetVulkanGraphicsDevice2KHR
static int	nxrGetVulkanGraphicsRequirements2KHR(org.lwjgl.openxr.XrInstance instance, long systemId, long graphicsRequirements)	Unsafe version of: GetVulkanGraphicsRequirements2KHR
static int	xrCreateVulkanDeviceKHR(org.lwjgl.openxr.XrInstance instance, XrVulkanDeviceCreateInfoKHR createInfo, org.lwjgl.PointerBuffer vulkanDevice, IntBuffer vulkanResult)	Create an OpenXR compatible VkDevice.
static int	xrCreateVulkanInstanceKHR(org.lwjgl.openxr.XrInstance instance, XrVulkanInstanceCreateInfoKHR createInfo, org.lwjgl.PointerBuffer vulkanInstance, IntBuffer vulkanResult)	Create an OpenXR compatible VkInstance.
static int	xrGetVulkanGraphicsDevice2KHR(org.lwjgl.openxr.XrInstance instance, XrVulkanGraphicsDeviceGetInfoKHR getInfo, org.lwjgl.PointerBuffer vulkanPhysicalDevice)	Retrieve the Vulkan physical device associated with an OpenXR instance and system.
static int	xrGetVulkanGraphicsRequirements2KHR(org.lwjgl.openxr.XrInstance instance, long systemId, XrGraphicsRequirementsVulkanKHR graphicsRequirements)	See GetVulkanGraphicsRequirementsKHR.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_KHR_vulkan_enable2_SPEC_VERSION

public static final int XR_KHR_vulkan_enable2_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_KHR_VULKAN_ENABLE2_EXTENSION_NAME

public static final String XR_KHR_VULKAN_ENABLE2_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR

public static final int XR_TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

XR_TYPE_VULKAN_DEVICE_CREATE_INFO_KHR

public static final int XR_TYPE_VULKAN_DEVICE_CREATE_INFO_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

XR_TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR

public static final int XR_TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_VULKAN2_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_VULKAN2_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

XR_TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR

public static final int XR_TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

public static final int XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

Extends XrStructureType.

Enum values:

• TYPE_VULKAN_INSTANCE_CREATE_INFO_KHR
• TYPE_VULKAN_DEVICE_CREATE_INFO_KHR
• TYPE_VULKAN_GRAPHICS_DEVICE_GET_INFO_KHR
• TYPE_GRAPHICS_BINDING_VULKAN2_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN2_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN2_KHR

See Also:

• Constant Field Values

Method Details

nxrCreateVulkanInstanceKHR

public static int nxrCreateVulkanInstanceKHR(org.lwjgl.openxr.XrInstance instance,
 long createInfo,
 long vulkanInstance,
 long vulkanResult)

Unsafe version of: CreateVulkanInstanceKHR

xrCreateVulkanInstanceKHR

public static int xrCreateVulkanInstanceKHR(org.lwjgl.openxr.XrInstance instance,
 XrVulkanInstanceCreateInfoKHR createInfo,
 org.lwjgl.PointerBuffer vulkanInstance,
 IntBuffer vulkanResult)

Create an OpenXR compatible VkInstance.

C Specification

 XrResult xrCreateVulkanInstanceKHR(
     XrInstance                                  instance,
     const XrVulkanInstanceCreateInfoKHR*        createInfo,
     VkInstance*                                 vulkanInstance,
     VkResult*                                   vulkanResult);

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable2 extension must be enabled prior to calling CreateVulkanInstanceKHR
• instance must be a valid XrInstance handle
• createInfo must be a pointer to a valid XrVulkanInstanceCreateInfoKHR structure
• vulkanInstance must be a pointer to a VkInstance value
• vulkanResult must be a pointer to a VkResult value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_SYSTEM_INVALID

See Also

XrVulkanInstanceCreateInfoKHR, CreateVulkanDeviceKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

createInfo - extensible input struct of type XrVulkanInstanceCreateInfoKHR

vulkanInstance - points to a VkInstance handle to populate with the new Vulkan instance.

vulkanResult - points to a VkResult to populate with the result of the vkCreateInstance operation as returned by XrVulkanInstanceCreateInfoKHR::pfnGetInstanceProcAddr.

nxrCreateVulkanDeviceKHR

public static int nxrCreateVulkanDeviceKHR(org.lwjgl.openxr.XrInstance instance,
 long createInfo,
 long vulkanDevice,
 long vulkanResult)

Unsafe version of: CreateVulkanDeviceKHR

xrCreateVulkanDeviceKHR

public static int xrCreateVulkanDeviceKHR(org.lwjgl.openxr.XrInstance instance,
 XrVulkanDeviceCreateInfoKHR createInfo,
 org.lwjgl.PointerBuffer vulkanDevice,
 IntBuffer vulkanResult)

Create an OpenXR compatible VkDevice.

C Specification

 XrResult xrCreateVulkanDeviceKHR(
     XrInstance                                  instance,
     const XrVulkanDeviceCreateInfoKHR*          createInfo,
     VkDevice*                                   vulkanDevice,
     VkResult*                                   vulkanResult);

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable2 extension must be enabled prior to calling CreateVulkanDeviceKHR
• instance must be a valid XrInstance handle
• createInfo must be a pointer to a valid XrVulkanDeviceCreateInfoKHR structure
• vulkanDevice must be a pointer to a VkDevice value
• vulkanResult must be a pointer to a VkResult value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_SYSTEM_INVALID

See Also

XrVulkanDeviceCreateInfoKHR, CreateVulkanInstanceKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

createInfo - extensible input struct of type XrCreateVulkanDeviceCreateInfoKHR

vulkanDevice - points to a VkDevice handle to populate with the new Vulkan device.

vulkanResult - points to a VkResult to populate with the result of the vkCreateDevice operation as returned by XrVulkanInstanceCreateInfoKHR::pfnGetInstanceProcAddr.

nxrGetVulkanGraphicsDevice2KHR

public static int nxrGetVulkanGraphicsDevice2KHR(org.lwjgl.openxr.XrInstance instance,
 long getInfo,
 long vulkanPhysicalDevice)

Unsafe version of: GetVulkanGraphicsDevice2KHR

xrGetVulkanGraphicsDevice2KHR

public static int xrGetVulkanGraphicsDevice2KHR(org.lwjgl.openxr.XrInstance instance,
 XrVulkanGraphicsDeviceGetInfoKHR getInfo,
 org.lwjgl.PointerBuffer vulkanPhysicalDevice)

Retrieve the Vulkan physical device associated with an OpenXR instance and system.

C Specification

 XrResult xrGetVulkanGraphicsDevice2KHR(
     XrInstance                                  instance,
     const XrVulkanGraphicsDeviceGetInfoKHR*     getInfo,
     VkPhysicalDevice*                           vulkanPhysicalDevice);

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable2 extension must be enabled prior to calling GetVulkanGraphicsDevice2KHR
• instance must be a valid XrInstance handle
• getInfo must be a pointer to a valid XrVulkanGraphicsDeviceGetInfoKHR structure
• vulkanPhysicalDevice must be a pointer to a VkPhysicalDevice value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SYSTEM_INVALID

See Also

XrVulkanGraphicsDeviceGetInfoKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

getInfo - extensible input struct of type XrVulkanGraphicsDeviceGetInfoKHR

vulkanPhysicalDevice - a pointer to a VkPhysicalDevice handle to populate.

nxrGetVulkanGraphicsRequirements2KHR

public static int nxrGetVulkanGraphicsRequirements2KHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 long graphicsRequirements)

Unsafe version of: GetVulkanGraphicsRequirements2KHR

xrGetVulkanGraphicsRequirements2KHR

public static int xrGetVulkanGraphicsRequirements2KHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 XrGraphicsRequirementsVulkanKHR graphicsRequirements)

See GetVulkanGraphicsRequirementsKHR.

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

systemId - an XrSystemId handle for the system which will be used to create a session.

graphicsRequirements - the XrGraphicsRequirementsVulkanKHR output structure.