XrSwapchainImageVulkanKHR(3)

C Specification

The XrSwapchainImageVulkanKHR structure is defined as:

typedef struct XrSwapchainImageVulkanKHR {
    XrStructureType       type;
    void* XR_MAY_ALIAS    next;
    VkImage               image;
} XrSwapchainImageVulkanKHR;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to an extension-specific structure.
image is a valid Vulkan VkImage to use.

Description

If a given session was created with XrGraphicsBindingVulkanKHR, the following conditions must apply.

Calls to xrEnumerateSwapchainImages on an XrSwapchain in that session must return an array of XrSwapchainImageVulkanKHR structures.
Whenever an OpenXR function accepts an XrSwapchainImageBaseHeader pointer as a parameter in that session, the runtime must also accept a pointer to an XrSwapchainImageVulkanKHR.

The OpenXR runtime must interpret the top-left corner of the swapchain image as the coordinate origin unless specified otherwise by extension functionality.

The OpenXR runtime must interpret the swapchain images in a clip space of positive Y pointing down, near Z plane at 0, and far Z plane at 1.

Valid Usage (Implicit)

The [XR_KHR_vulkan_enable] extension must be enabled prior to using XrSwapchainImageVulkanKHR
type must be XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
next must be NULL
image must be a valid VkImage value

Document Notes

For more information, see the OpenXR Specification at URL

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

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

XrSwapchainImageVulkanKHR(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright