Blender V5.3
GHOST_XrGraphicsBindingVulkan.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <list>
12
13#define VOLK_NAMESPACE
14#define VOLK_NO_DEVICE_PROTOTYPES
15#include "volk.h"
16#define VMA_VULKAN_VERSION 1002000 // Vulkan 1.2
17#if !defined(_WIN32) or defined(_M_ARM64)
18/* Silence compilation warning on non-windows x64 systems. */
19# define VMA_EXTERNAL_MEMORY_WIN32 0
20#endif
21#ifdef _WIN32
22# include <vulkan/vulkan_win32.h>
23#endif
24#include "vk_mem_alloc.h"
25
26#include "GHOST_ContextVK.hh"
28#include "GHOST_Types.hh"
29
70 public:
73
74 bool loadExtensionFunctions(XrInstance instance) override;
75
80 XrInstance instance,
81 XrSystemId system_id,
82 std::string *r_requirement_info) const override;
83
84 void initFromGhostContext(GHOST_Context &ghost_ctx,
85 XrInstance instance,
86 XrSystemId system_id) override;
87 std::optional<int64_t> chooseSwapchainFormat(const std::vector<int64_t> &runtime_formats,
88 GHOST_TXrSwapchainFormat &r_format,
89 bool &r_is_srgb_format) const override;
90 std::vector<XrSwapchainImageBaseHeader *> createSwapchainImages(uint32_t image_count) override;
91
92 void submitToSwapchainBegin() override;
93 void submitToSwapchainImage(XrSwapchainImageBaseHeader &swapchain_image,
94 const GHOST_XrDrawViewInfo &draw_info) override;
95 void submitToSwapchainEnd() override;
96
97 bool needsUpsideDownDrawing(GHOST_Context &ghost_ctx) const override;
98
99 private:
100 struct {
101 /* XR_KHR_vulkan_enable */
102 PFN_xrGetVulkanInstanceExtensionsKHR xrGetVulkanInstanceExtensionsKHR = nullptr;
103 PFN_xrGetVulkanDeviceExtensionsKHR xrGetVulkanDeviceExtensionsKHR = nullptr;
104 PFN_xrGetVulkanGraphicsDeviceKHR xrGetVulkanGraphicsDeviceKHR = nullptr;
105 PFN_xrGetVulkanGraphicsRequirementsKHR xrGetVulkanGraphicsRequirementsKHR = nullptr;
106
107 /* XR_KHR_vulkan_enable2 */
108 PFN_xrGetVulkanGraphicsRequirements2KHR xrGetVulkanGraphicsRequirements2KHR = nullptr;
109 PFN_xrGetVulkanGraphicsDevice2KHR xrGetVulkanGraphicsDevice2KHR = nullptr;
110 PFN_xrCreateVulkanInstanceKHR xrCreateVulkanInstanceKHR = nullptr;
111 PFN_xrCreateVulkanDeviceKHR xrCreateVulkanDeviceKHR = nullptr;
112 } functions_;
113
114 struct {
116 bool vulkan_enable = false;
118 bool vulkan_enable2 = false;
119 } extensions_;
120
121 GHOST_ContextVK &ghost_ctx_;
122
123 VkInstance vk_instance_ = VK_NULL_HANDLE;
124 VkPhysicalDevice vk_physical_device_ = VK_NULL_HANDLE;
125 uint32_t graphics_queue_family_ = 0;
126 VkQueue vk_queue_ = VK_NULL_HANDLE;
127 VkDevice vk_device_ = VK_NULL_HANDLE;
128 VmaAllocator vma_allocator_ = VK_NULL_HANDLE;
129 VmaAllocation vk_buffer_allocation_ = VK_NULL_HANDLE;
130 VkBuffer vk_buffer_ = VK_NULL_HANDLE;
131 VmaAllocationInfo vk_buffer_allocation_info_ = {};
132 GHOST_TVulkanXRModes data_transfer_mode_ = GHOST_kVulkanXRModeCPU;
133 volk::VolkDeviceTable functions = {};
134
135 std::list<std::vector<XrSwapchainImageVulkan2KHR>> image_cache_;
136 VkCommandPool vk_command_pool_ = VK_NULL_HANDLE;
137
138 struct ImportedMemory {
139 char view_idx;
140 VkImage vk_image_blender;
141 VkImage vk_image_xr;
142 VkDeviceMemory vk_device_memory_xr;
143 };
144 std::vector<ImportedMemory> imported_memory_;
145
146 GHOST_TVulkanXRModes choseDataTransferMode();
147 void submitToSwapchainImageCpu(XrSwapchainImageVulkan2KHR &swapchain_image,
148 const GHOST_XrDrawViewInfo &draw_info);
149 void submitToSwapchainImageGpu(XrSwapchainImageVulkan2KHR &swapchain_image,
150 const GHOST_XrDrawViewInfo &draw_info);
151 void submitToSwapchainImageRenderGraph(XrSwapchainImageVulkan2KHR &swapchain_image,
152 const GHOST_XrDrawViewInfo &draw_info);
153
159 VkCommandBuffer vk_command_buffer_ = VK_NULL_HANDLE;
160
166 bool tryReuseVulkanInstance(GHOST_ContextVK &ghost_ctx, XrInstance instance, XrSystemId system);
167 bool areRequiredInstanceExtensionsEnabled(XrInstance instance, XrSystemId system_id) const;
168 bool areRequiredDeviceExtensionsEnabled(XrInstance instance, XrSystemId system_id) const;
169 bool isSamePhysicalDeviceSelected(XrInstance instance,
170 XrSystemId system_id,
171 const GHOST_VulkanHandles &context_handles) const;
172};
GHOST_IXrGraphicsBinding()=default
std::vector< XrSwapchainImageBaseHeader * > createSwapchainImages(uint32_t image_count) override
std::optional< int64_t > chooseSwapchainFormat(const std::vector< int64_t > &runtime_formats, GHOST_TXrSwapchainFormat &r_format, bool &r_is_srgb_format) const override
void initFromGhostContext(GHOST_Context &ghost_ctx, XrInstance instance, XrSystemId system_id) override
void submitToSwapchainImage(XrSwapchainImageBaseHeader &swapchain_image, const GHOST_XrDrawViewInfo &draw_info) override
bool loadExtensionFunctions(XrInstance instance) override
load the functions for the graphics binding.
bool needsUpsideDownDrawing(GHOST_Context &ghost_ctx) const override
bool checkVersionRequirements(GHOST_Context &ghost_ctx, XrInstance instance, XrSystemId system_id, std::string *r_requirement_info) const override
GHOST_XrGraphicsBindingVulkan(GHOST_Context &ghost_ctx)