xrt_gfx_vk.h

Go to the documentation of this file.

// Copyright 2019-2024, Collabora, Ltd.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  Header defining an XRT graphics provider.
 * @author Jakob Bornecrantz <jakob@collabora.com>
 * @author Korcan Hussein <korcan.hussein@collabora.com>
 * @ingroup xrt_iface
 */
 
#pragma once
 
#include "xrt/xrt_device.h"
#include "xrt/xrt_compositor.h"
#include "xrt/xrt_vulkan_includes.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct time_state;
 
 
/*!
 * @brief A space-delimited string of Vulkan instance extensions required from a
 * client.
 *
 * Should be kept synchronized with the "Client" column in @ref
 * vulkan-extensions
 *
 * @ingroup xrt_iface
 */
extern const char *xrt_gfx_vk_instance_extensions;
 
/*!
 * @brief A space-delimited string of Vulkan device extensions required from a
 * client.
 *
 * Should be kept synchronized with the "Client" column in @ref
 * vulkan-extensions
 *
 * @ingroup xrt_iface
 */
extern const char *xrt_gfx_vk_device_extensions;
 
/*!
 * @ingroup xrt_iface
 */
void
xrt_gfx_vk_get_versions(struct xrt_api_requirements *ver);
 
/*!
 * Create a Vulkan compositor client.
 *
 * @ingroup xrt_iface
 * @public @memberof xrt_compositor_native
 */
struct xrt_compositor_vk *
xrt_gfx_vk_provider_create(struct xrt_compositor_native *xcn,
                           VkInstance instance,
                           PFN_vkGetInstanceProcAddr get_instance_proc_addr,
                           VkPhysicalDevice physical_device,
                           VkDevice device,
                           bool external_fence_fd_enabled,
                           bool external_semaphore_fd_enabled,
                           bool timeline_semaphore_enabled,
                           bool image_format_list_enabled,
                           bool debug_utils_enabled,
                           bool renderdoc_enabled,
                           uint32_t queue_family_index,
                           uint32_t queue_index);
 
 
#ifdef __cplusplus
}
#endif