Package org.lwjgl.openxr

Class KHRVulkanEnable

java.lang.Object

org.lwjgl.openxr.KHRVulkanEnable

public class KHRVulkanEnable
extends Object

The XR_KHR_vulkan_enable 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 XrGraphicsBindingVulkanKHR structure in order to create a Vulkan-based XrSession. Note that during this process the application is responsible for creating all the required Vulkan objects.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_KHR_VULKAN_ENABLE_EXTENSION_NAME	The extension name.
static final int	XR_KHR_vulkan_enable_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_GRAPHICS_BINDING_VULKAN_KHR	Extends XrStructureType.
static final int	XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR	Extends XrStructureType.
static final int	XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetVulkanDeviceExtensionsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, int bufferCapacityInput, long bufferCountOutput, long buffer)	Unsafe version of: GetVulkanDeviceExtensionsKHR
static int	nxrGetVulkanGraphicsDeviceKHR(org.lwjgl.openxr.XrInstance instance, long systemId, org.lwjgl.vulkan.VkInstance vkInstance, long vkPhysicalDevice)	Unsafe version of: GetVulkanGraphicsDeviceKHR
static int	nxrGetVulkanGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, long graphicsRequirements)	Unsafe version of: GetVulkanGraphicsRequirementsKHR
static int	nxrGetVulkanInstanceExtensionsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, int bufferCapacityInput, long bufferCountOutput, long buffer)	Unsafe version of: GetVulkanInstanceExtensionsKHR
static int	xrGetVulkanDeviceExtensionsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, IntBuffer bufferCountOutput, @Nullable ByteBuffer buffer)	Get list of required Vulkan device extensions for an OpenXR instance and system.
static int	xrGetVulkanGraphicsDeviceKHR(org.lwjgl.openxr.XrInstance instance, long systemId, org.lwjgl.vulkan.VkInstance vkInstance, org.lwjgl.PointerBuffer vkPhysicalDevice)	Retrieve the Vulkan physical device associated with an OpenXR instance and system.
static int	xrGetVulkanGraphicsRequirementsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, XrGraphicsRequirementsVulkanKHR graphicsRequirements)	Retrieve the Vulkan version requirements for an instance and system.
static int	xrGetVulkanInstanceExtensionsKHR(org.lwjgl.openxr.XrInstance instance, long systemId, IntBuffer bufferCountOutput, @Nullable ByteBuffer buffer)	Get list of required Vulkan instance extensions for an OpenXR instance and system.

Methods inherited from class java.lang.Object

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

Field Details

XR_KHR_vulkan_enable_SPEC_VERSION

public static final int XR_KHR_vulkan_enable_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_KHR_VULKAN_ENABLE_EXTENSION_NAME

public static final String XR_KHR_VULKAN_ENABLE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_BINDING_VULKAN_KHR

public static final int XR_TYPE_GRAPHICS_BINDING_VULKAN_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_VULKAN_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR

See Also:

• Constant Field Values

XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR

public static final int XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_VULKAN_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR

See Also:

• Constant Field Values

XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR

public static final int XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR

Extends XrStructureType.

Enum values:

• TYPE_GRAPHICS_BINDING_VULKAN_KHR
• TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
• TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR

See Also:

• Constant Field Values

Method Details

nxrGetVulkanInstanceExtensionsKHR

public static int nxrGetVulkanInstanceExtensionsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 int bufferCapacityInput,
 long bufferCountOutput,
 long buffer)

Unsafe version of: GetVulkanInstanceExtensionsKHR

Parameters:

bufferCapacityInput - the capacity of the buffer, or 0 to indicate a request to retrieve the required capacity.

xrGetVulkanInstanceExtensionsKHR

public static int xrGetVulkanInstanceExtensionsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 IntBuffer bufferCountOutput,
 @Nullable ByteBuffer buffer)

Get list of required Vulkan instance extensions for an OpenXR instance and system.

C Specification

 XrResult xrGetVulkanInstanceExtensionsKHR(
     XrInstance                                  instance,
     XrSystemId                                  systemId,
     uint32_t                                    bufferCapacityInput,
     uint32_t*                                   bufferCountOutput,
     char*                                       buffer);

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to calling GetVulkanInstanceExtensionsKHR
• instance must be a valid XrInstance handle
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput char values

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_SIZE_INSUFFICIENT
• ERROR_SYSTEM_INVALID

See Also

GetVulkanDeviceExtensionsKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

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

bufferCountOutput - a pointer to the count of characters written (including terminating \0), or a pointer to the required capacity in the case that bufferCapacityInput is insufficient.

buffer - a pointer to an array of characters, but can be NULL if bufferCapacityInput is 0. The format of the output is a single space (ASCII 0x20) delimited string of extension names.

nxrGetVulkanDeviceExtensionsKHR

public static int nxrGetVulkanDeviceExtensionsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 int bufferCapacityInput,
 long bufferCountOutput,
 long buffer)

Unsafe version of: GetVulkanDeviceExtensionsKHR

Parameters:

bufferCapacityInput - the capacity of the buffer, or 0 to indicate a request to retrieve the required capacity.

xrGetVulkanDeviceExtensionsKHR

public static int xrGetVulkanDeviceExtensionsKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 IntBuffer bufferCountOutput,
 @Nullable ByteBuffer buffer)

Get list of required Vulkan device extensions for an OpenXR instance and system.

C Specification

 XrResult xrGetVulkanDeviceExtensionsKHR(
     XrInstance                                  instance,
     XrSystemId                                  systemId,
     uint32_t                                    bufferCapacityInput,
     uint32_t*                                   bufferCountOutput,
     char*                                       buffer);

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to calling GetVulkanDeviceExtensionsKHR
• instance must be a valid XrInstance handle
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput char values

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_SIZE_INSUFFICIENT
• ERROR_SYSTEM_INVALID

See Also

GetVulkanInstanceExtensionsKHR

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

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

bufferCountOutput - a pointer to the count of characters written (including terminating \0), or a pointer to the required capacity in the case that bufferCapacityInput is insufficient.

buffer - a pointer to an array of characters, but can be NULL if bufferCapacityInput is 0. The format of the output is a single space (ASCII 0x20) delimited string of extension names.

nxrGetVulkanGraphicsDeviceKHR

public static int nxrGetVulkanGraphicsDeviceKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 org.lwjgl.vulkan.VkInstance vkInstance,
 long vkPhysicalDevice)

Unsafe version of: GetVulkanGraphicsDeviceKHR

xrGetVulkanGraphicsDeviceKHR

public static int xrGetVulkanGraphicsDeviceKHR(org.lwjgl.openxr.XrInstance instance,
 long systemId,
 org.lwjgl.vulkan.VkInstance vkInstance,
 org.lwjgl.PointerBuffer vkPhysicalDevice)

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

C Specification

To identify what graphics device needs to be used for an instance and system, call:

 XrResult xrGetVulkanGraphicsDeviceKHR(
     XrInstance                                  instance,
     XrSystemId                                  systemId,
     VkInstance                                  vkInstance,
     VkPhysicalDevice*                           vkPhysicalDevice);

Description

GetVulkanGraphicsDeviceKHR function identifies to the application what graphics device (Vulkan VkPhysicalDevice) needs to be used. GetVulkanGraphicsDeviceKHR must be called prior to calling CreateSession, and the VkPhysicalDevice that GetVulkanGraphicsDeviceKHR returns should be passed to CreateSession in the XrGraphicsBindingVulkanKHR.

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to calling GetVulkanGraphicsDeviceKHR
• instance must be a valid XrInstance handle
• vkInstance must be a valid VkInstance value
• vkPhysicalDevice 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

Parameters:

instance - an XrInstance handle previously created with CreateInstance.

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

vkInstance - a valid Vulkan VkInstance.

vkPhysicalDevice - a pointer to a VkPhysicalDevice value to populate.

nxrGetVulkanGraphicsRequirementsKHR

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

Unsafe version of: GetVulkanGraphicsRequirementsKHR

xrGetVulkanGraphicsRequirementsKHR

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

Retrieve the Vulkan version requirements for an instance and system.

C Specification

To query Vulkan API version requirements, call:

 XrResult xrGetVulkanGraphicsRequirementsKHR(
     XrInstance                                  instance,
     XrSystemId                                  systemId,
     XrGraphicsRequirementsVulkanKHR*            graphicsRequirements);

Description

The GetVulkanGraphicsRequirementsKHR function identifies to the application the minimum Vulkan version requirement and the highest known tested Vulkan version. The runtime must return ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING (ERROR_VALIDATION_FAILURE may be returned due to legacy behavior) on calls to CreateSession if GetVulkanGraphicsRequirementsKHR has not been called for the same instance and systemId.

Valid Usage (Implicit)

• The XR_KHR_vulkan_enable extension must be enabled prior to calling GetVulkanGraphicsRequirementsKHR
• instance must be a valid XrInstance handle
• graphicsRequirements must be a pointer to an XrGraphicsRequirementsVulkanKHR structure

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

XrGraphicsRequirementsVulkanKHR

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.