C Specification

XrResult xrGetVulkanDeviceExtensionsKHR(
    XrInstance                                  instance,
    XrSystemId                                  systemId,
    uint32_t                                    namesCapacityInput,
    uint32_t*                                   namesCountOutput,
    char*                                       namesString);

Parameters

Parameter Descriptions

  • instance is an XrInstance handle previously created with xrCreateInstance.

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

  • namesCapacityInput is the capacity of the namesString array, or 0 to indicate a request to retrieve the required capacity.

  • namesCountOutput is a pointer to the count of characters written (including terminating \0), or a pointer to the required capacity in the case that namesCapacityInput is 0.

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

  • See Buffer Size Parameters chapter for a detailed description of retrieving the required namesString size.

Description

Valid Usage (Implicit)

  • The [XR_KHR_vulkan_enable] extension must be enabled prior to calling xrGetVulkanDeviceExtensionsKHR

  • instance must be a valid XrInstance handle

  • If namesCapacityInput is not 0, namesCapacityInput must be a valid uint32_t value

  • If namesCountOutput is not NULL, namesCountOutput must be a pointer to a uint32_t value

  • If namesCapacityInput is not 0, namesString must be a pointer to an array of namesCapacityInput null-terminated UTF-8 strings

Return Codes
On success, this command returns

  • XR_SUCCESS

On failure, this command returns

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SYSTEM_INVALID

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_SIZE_INSUFFICIENT

  • XR_ERROR_FUNCTION_UNSUPPORTED

See Also

XrInstance, XrSystemId, xrGetVulkanInstanceExtensionsKHR

Document Notes

For more information, see the OpenXR Specification at URL

https://www.khronos.org/registry/openxr/specs/1.0-extensions/html/xrspec.html#xrGetVulkanDeviceExtensionsKHR

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.