2 * Copyright © 2019 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
28 #include <vulkan/vulkan.h>
29 #include <vulkan/vk_layer.h>
33 #include "overlay_params.h"
35 #include "util/debug.h"
36 #include "util/hash_table.h"
37 #include "util/ralloc.h"
38 #include "util/os_time.h"
39 #include "util/simple_mtx.h"
41 #include "vk_enum_to_str.h"
44 /* Mapped from VkInstace/VkPhysicalDevice */
45 struct instance_data
{
46 struct vk_instance_dispatch_table vtable
;
49 struct overlay_params params
;
53 uint32_t stats
[OVERLAY_PARAM_ENABLED_MAX
];
56 /* Mapped from VkDevice/VkCommandBuffer */
59 struct instance_data
*instance
;
61 PFN_vkSetDeviceLoaderData set_device_loader_data
;
63 struct vk_device_dispatch_table vtable
;
64 VkPhysicalDevice physical_device
;
67 VkPhysicalDeviceProperties properties
;
69 struct queue_data
*graphic_queue
;
71 struct queue_data
**queues
;
74 struct frame_stat stats
;
77 /* Mapped from VkQueue */
79 struct device_data
*device
;
83 uint32_t family_index
;
86 /* Mapped from VkSwapchainKHR */
87 struct swapchain_data
{
88 struct device_data
*device
;
90 VkSwapchainKHR swapchain
;
91 unsigned width
, height
;
96 VkImageView
*image_views
;
97 VkFramebuffer
*framebuffers
;
99 VkRenderPass render_pass
;
101 VkDescriptorPool descriptor_pool
;
102 VkDescriptorSetLayout descriptor_layout
;
103 VkDescriptorSet descriptor_set
;
105 VkSampler font_sampler
;
107 VkPipelineLayout pipeline_layout
;
110 VkCommandPool command_pool
;
113 VkCommandBuffer command_buffer
;
115 VkBuffer vertex_buffer
;
116 VkDeviceMemory vertex_buffer_mem
;
117 VkDeviceSize vertex_buffer_size
;
119 VkBuffer index_buffer
;
120 VkDeviceMemory index_buffer_mem
;
121 VkDeviceSize index_buffer_size
;
126 VkImageView font_image_view
;
127 VkDeviceMemory font_mem
;
128 VkBuffer upload_font_buffer
;
129 VkDeviceMemory upload_font_buffer_mem
;
132 VkSemaphore submission_semaphore
;
135 ImGuiContext
* imgui_context
;
140 uint64_t last_present_time
;
142 unsigned n_frames_since_update
;
143 uint64_t last_fps_update
;
146 double frame_times
[200];
148 double acquire_times
[200];
151 enum overlay_param_enabled stat_selector
;
152 struct frame_stat stats_min
, stats_max
;
153 struct frame_stat stats
[200];
156 static struct hash_table
*vk_object_to_data
= NULL
;
157 static simple_mtx_t vk_object_to_data_mutex
= _SIMPLE_MTX_INITIALIZER_NP
;
159 thread_local ImGuiContext
* __MesaImGui
;
161 static inline void ensure_vk_object_map(void)
163 if (!vk_object_to_data
) {
164 vk_object_to_data
= _mesa_hash_table_create(NULL
,
166 _mesa_key_pointer_equal
);
170 #define FIND_SWAPCHAIN_DATA(obj) ((struct swapchain_data *)find_object_data((void *) obj))
171 #define FIND_DEVICE_DATA(obj) ((struct device_data *)find_object_data((void *) obj))
172 #define FIND_QUEUE_DATA(obj) ((struct queue_data *)find_object_data((void *) obj))
173 #define FIND_PHYSICAL_DEVICE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
174 #define FIND_INSTANCE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
175 static void *find_object_data(void *obj
)
177 simple_mtx_lock(&vk_object_to_data_mutex
);
178 ensure_vk_object_map();
179 struct hash_entry
*entry
= _mesa_hash_table_search(vk_object_to_data
, obj
);
180 void *data
= entry
? entry
->data
: NULL
;
181 simple_mtx_unlock(&vk_object_to_data_mutex
);
185 static void map_object(void *obj
, void *data
)
187 simple_mtx_lock(&vk_object_to_data_mutex
);
188 ensure_vk_object_map();
189 _mesa_hash_table_insert(vk_object_to_data
, obj
, data
);
190 simple_mtx_unlock(&vk_object_to_data_mutex
);
193 static void unmap_object(void *obj
)
195 simple_mtx_lock(&vk_object_to_data_mutex
);
196 struct hash_entry
*entry
= _mesa_hash_table_search(vk_object_to_data
, obj
);
197 _mesa_hash_table_remove(vk_object_to_data
, entry
);
198 simple_mtx_unlock(&vk_object_to_data_mutex
);
203 #define VK_CHECK(expr) \
205 VkResult __result = (expr); \
206 if (__result != VK_SUCCESS) { \
207 fprintf(stderr, "'%s' line %i failed with %s\n", \
208 #expr, __LINE__, vk_Result_to_str(__result)); \
214 static VkLayerInstanceCreateInfo
*get_instance_chain_info(const VkInstanceCreateInfo
*pCreateInfo
,
215 VkLayerFunction func
)
217 vk_foreach_struct(item
, pCreateInfo
->pNext
) {
218 if (item
->sType
== VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO
&&
219 ((VkLayerInstanceCreateInfo
*) item
)->function
== func
)
220 return (VkLayerInstanceCreateInfo
*) item
;
222 unreachable("instance chain info not found");
226 static VkLayerDeviceCreateInfo
*get_device_chain_info(const VkDeviceCreateInfo
*pCreateInfo
,
227 VkLayerFunction func
)
229 vk_foreach_struct(item
, pCreateInfo
->pNext
) {
230 if (item
->sType
== VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO
&&
231 ((VkLayerDeviceCreateInfo
*) item
)->function
== func
)
232 return (VkLayerDeviceCreateInfo
*)item
;
234 unreachable("device chain info not found");
240 static struct instance_data
*new_instance_data(VkInstance instance
)
242 struct instance_data
*data
= rzalloc(NULL
, struct instance_data
);
243 data
->instance
= instance
;
244 map_object(data
->instance
, data
);
248 static void destroy_instance_data(struct instance_data
*data
)
250 if (data
->params
.output_file
)
251 fclose(data
->params
.output_file
);
252 unmap_object(data
->instance
);
256 static void instance_data_map_physical_devices(struct instance_data
*instance_data
,
259 uint32_t physicalDeviceCount
= 0;
260 instance_data
->vtable
.EnumeratePhysicalDevices(instance_data
->instance
,
261 &physicalDeviceCount
,
264 VkPhysicalDevice
*physicalDevices
= (VkPhysicalDevice
*) malloc(sizeof(VkPhysicalDevice
) * physicalDeviceCount
);
265 instance_data
->vtable
.EnumeratePhysicalDevices(instance_data
->instance
,
266 &physicalDeviceCount
,
269 for (uint32_t i
= 0; i
< physicalDeviceCount
; i
++) {
271 map_object(physicalDevices
[i
], instance_data
);
273 unmap_object(physicalDevices
[i
]);
276 free(physicalDevices
);
280 static struct device_data
*new_device_data(VkDevice device
, struct instance_data
*instance
)
282 struct device_data
*data
= rzalloc(NULL
, struct device_data
);
283 data
->instance
= instance
;
284 data
->device
= device
;
285 map_object(data
->device
, data
);
289 static struct queue_data
*new_queue_data(VkQueue queue
,
290 const VkQueueFamilyProperties
*family_props
,
291 uint32_t family_index
,
292 struct device_data
*device_data
)
294 struct queue_data
*data
= rzalloc(device_data
, struct queue_data
);
295 data
->device
= device_data
;
297 data
->flags
= family_props
->queueFlags
;
298 data
->family_index
= family_index
;
299 map_object(data
->queue
, data
);
301 if (data
->flags
& VK_QUEUE_GRAPHICS_BIT
)
302 device_data
->graphic_queue
= data
;
307 static void device_map_queues(struct device_data
*data
,
308 const VkDeviceCreateInfo
*pCreateInfo
)
310 for (uint32_t i
= 0; i
< pCreateInfo
->queueCreateInfoCount
; i
++)
311 data
->n_queues
+= pCreateInfo
->pQueueCreateInfos
[i
].queueCount
;
312 data
->queues
= ralloc_array(data
, struct queue_data
*, data
->n_queues
);
314 struct instance_data
*instance_data
= data
->instance
;
315 uint32_t n_family_props
;
316 instance_data
->vtable
.GetPhysicalDeviceQueueFamilyProperties(data
->physical_device
,
319 VkQueueFamilyProperties
*family_props
=
320 (VkQueueFamilyProperties
*)malloc(sizeof(VkQueueFamilyProperties
) * n_family_props
);
321 instance_data
->vtable
.GetPhysicalDeviceQueueFamilyProperties(data
->physical_device
,
325 uint32_t queue_index
= 0;
326 for (uint32_t i
= 0; i
< pCreateInfo
->queueCreateInfoCount
; i
++) {
327 for (uint32_t j
= 0; j
< pCreateInfo
->pQueueCreateInfos
[i
].queueCount
; j
++) {
329 data
->vtable
.GetDeviceQueue(data
->device
,
330 pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
,
333 VK_CHECK(data
->set_device_loader_data(data
->device
, queue
));
335 data
->queues
[queue_index
++] =
336 new_queue_data(queue
, &family_props
[pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
],
337 pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
, data
);
344 static void device_unmap_queues(struct device_data
*data
)
346 for (uint32_t i
= 0; i
< data
->n_queues
; i
++)
347 unmap_object(data
->queues
[i
]->queue
);
350 static void destroy_device_data(struct device_data
*data
)
352 unmap_object(data
->device
);
357 static struct swapchain_data
*new_swapchain_data(VkSwapchainKHR swapchain
,
358 struct device_data
*device_data
)
360 struct swapchain_data
*data
= rzalloc(NULL
, struct swapchain_data
);
361 data
->device
= device_data
;
362 data
->swapchain
= swapchain
;
363 data
->window_size
= ImVec2(300, 300);
364 map_object((void *) data
->swapchain
, data
);
368 static void destroy_swapchain_data(struct swapchain_data
*data
)
370 unmap_object((void *) data
->swapchain
);
374 static void snapshot_swapchain_frame(struct swapchain_data
*data
)
376 struct instance_data
*instance_data
= data
->device
->instance
;
377 uint64_t now
= os_time_get(); /* us */
379 if (data
->last_present_time
) {
380 data
->frame_times
[(data
->n_frames
- 1) % ARRAY_SIZE(data
->frame_times
)] =
381 ((double)now
- (double)data
->last_present_time
) / 1000.0;
384 if (data
->last_fps_update
) {
385 double elapsed
= (double)(now
- data
->last_fps_update
); /* us */
386 if (elapsed
>= instance_data
->params
.fps_sampling_period
) {
387 data
->fps
= 1000000.0f
* data
->n_frames_since_update
/ elapsed
;
388 data
->n_frames_since_update
= 0;
389 data
->last_fps_update
= now
;
390 if (instance_data
->params
.output_file
) {
391 fprintf(instance_data
->params
.output_file
, "%.2f\n", data
->fps
);
392 fflush(instance_data
->params
.output_file
);
396 data
->last_fps_update
= now
;
399 struct device_data
*device_data
= data
->device
;
400 data
->stats
[data
->n_frames
% ARRAY_SIZE(data
->frame_times
)] = device_data
->stats
;
401 memset(&device_data
->stats
, 0, sizeof(device_data
->stats
));
403 data
->last_present_time
= now
;
405 data
->n_frames_since_update
++;
408 static float get_frame_timing(void *_data
, int _idx
)
410 struct swapchain_data
*data
= (struct swapchain_data
*) _data
;
411 if ((ARRAY_SIZE(data
->frame_times
) - _idx
) > (data
->n_frames
- 2))
413 int idx
= ARRAY_SIZE(data
->frame_times
) +
414 (data
->n_frames
- 2) < ARRAY_SIZE(data
->frame_times
) ?
415 _idx
- (data
->n_frames
- 2) :
416 _idx
+ (data
->n_frames
- 2);
417 idx
%= ARRAY_SIZE(data
->frame_times
);
418 return data
->frame_times
[idx
];
421 static float get_acquire_timing(void *_data
, int _idx
)
423 struct swapchain_data
*data
= (struct swapchain_data
*) _data
;
424 if ((ARRAY_SIZE(data
->acquire_times
) - _idx
) > data
->n_acquire
)
426 int idx
= ARRAY_SIZE(data
->acquire_times
) +
427 data
->n_acquire
< ARRAY_SIZE(data
->acquire_times
) ?
428 _idx
- data
->n_acquire
:
429 _idx
+ data
->n_acquire
;
430 idx
%= ARRAY_SIZE(data
->acquire_times
);
431 return data
->acquire_times
[idx
];
434 static float get_stat(void *_data
, int _idx
)
436 struct swapchain_data
*data
= (struct swapchain_data
*) _data
;
437 if ((ARRAY_SIZE(data
->stats
) - _idx
) > data
->n_frames
)
439 int idx
= ARRAY_SIZE(data
->stats
) +
440 data
->n_frames
< ARRAY_SIZE(data
->stats
) ?
441 _idx
- data
->n_frames
:
442 _idx
+ data
->n_frames
;
443 idx
%= ARRAY_SIZE(data
->stats
);
444 return data
->stats
[idx
].stats
[data
->stat_selector
];
447 static void position_layer(struct swapchain_data
*data
)
450 struct device_data
*device_data
= data
->device
;
451 struct instance_data
*instance_data
= device_data
->instance
;
453 ImGui::SetNextWindowBgAlpha(0.5);
454 ImGui::SetNextWindowSize(data
->window_size
, ImGuiCond_Always
);
455 switch (instance_data
->params
.position
) {
456 case LAYER_POSITION_TOP_LEFT
:
457 ImGui::SetNextWindowPos(ImVec2(0, 0), ImGuiCond_Always
);
459 case LAYER_POSITION_TOP_RIGHT
:
460 ImGui::SetNextWindowPos(ImVec2(data
->width
- data
->window_size
.x
, 0),
463 case LAYER_POSITION_BOTTOM_LEFT
:
464 ImGui::SetNextWindowPos(ImVec2(0, data
->height
- data
->window_size
.y
),
467 case LAYER_POSITION_BOTTOM_RIGHT
:
468 ImGui::SetNextWindowPos(ImVec2(data
->width
- data
->window_size
.x
,
469 data
->height
- data
->window_size
.y
),
475 static void compute_swapchain_display(struct swapchain_data
*data
)
477 struct device_data
*device_data
= data
->device
;
478 struct instance_data
*instance_data
= device_data
->instance
;
480 ImGui::SetCurrentContext(data
->imgui_context
);
482 position_layer(data
);
483 ImGui::Begin("Mesa overlay");
484 ImGui::Text("Device: %s", device_data
->properties
.deviceName
);
486 const char *format_name
= vk_Format_to_str(data
->format
);
487 format_name
= format_name
? (format_name
+ strlen("VK_FORMAT_")) : "unknown";
488 ImGui::Text("Swapchain format: %s", format_name
);
489 ImGui::Text("Frames: %" PRIu64
, data
->n_frames
);
490 if (instance_data
->params
.enabled
[OVERLAY_PARAM_ENABLED_fps
])
491 ImGui::Text("FPS: %.2f" , data
->fps
);
493 if (instance_data
->params
.enabled
[OVERLAY_PARAM_ENABLED_frame_timing
]){
494 double min_time
= FLT_MAX
, max_time
= 0.0f
;
495 for (uint32_t i
= 0; i
< MIN2(data
->n_frames
- 2, ARRAY_SIZE(data
->frame_times
)); i
++) {
496 min_time
= MIN2(min_time
, data
->frame_times
[i
]);
497 max_time
= MAX2(max_time
, data
->frame_times
[i
]);
499 ImGui::PlotHistogram("##Frame timings", get_frame_timing
, data
,
500 ARRAY_SIZE(data
->frame_times
), 0,
501 NULL
, min_time
, max_time
,
502 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
503 ImGui::Text("Frame timing: %.3fms [%.3f, %.3f]",
504 get_frame_timing(data
, ARRAY_SIZE(data
->frame_times
) - 1),
508 if (instance_data
->params
.enabled
[OVERLAY_PARAM_ENABLED_acquire_timing
]) {
509 double min_time
= FLT_MAX
, max_time
= 0.0f
;
510 for (uint32_t i
= 0; i
< MIN2(data
->n_acquire
- 2, ARRAY_SIZE(data
->acquire_times
)); i
++) {
511 min_time
= MIN2(min_time
, data
->acquire_times
[i
]);
512 max_time
= MAX2(max_time
, data
->acquire_times
[i
]);
514 ImGui::PlotHistogram("##Acquire timings", get_acquire_timing
, data
,
515 ARRAY_SIZE(data
->acquire_times
), 0,
516 NULL
, min_time
, max_time
,
517 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
518 ImGui::Text("Acquire timing: %.3fms [%.3f, %.3f]",
519 get_acquire_timing(data
, ARRAY_SIZE(data
->acquire_times
) - 1),
523 for (uint32_t i
= 0; i
< ARRAY_SIZE(data
->stats_min
.stats
); i
++) {
524 data
->stats_min
.stats
[i
] = UINT32_MAX
;
525 data
->stats_max
.stats
[i
] = 0;
527 for (uint32_t i
= 0; i
< MIN2(data
->n_frames
- 1, ARRAY_SIZE(data
->stats
)); i
++) {
528 for (uint32_t j
= 0; j
< ARRAY_SIZE(data
->stats
[0].stats
); j
++) {
529 data
->stats_min
.stats
[j
] = MIN2(data
->stats
[i
].stats
[j
],
530 data
->stats_min
.stats
[j
]);
531 data
->stats_max
.stats
[j
] = MAX2(data
->stats
[i
].stats
[j
],
532 data
->stats_max
.stats
[j
]);
536 for (uint32_t i
= 0; i
< ARRAY_SIZE(device_data
->stats
.stats
); i
++) {
537 if (!instance_data
->params
.enabled
[i
] ||
538 i
== OVERLAY_PARAM_ENABLED_fps
||
539 i
== OVERLAY_PARAM_ENABLED_frame_timing
||
540 i
== OVERLAY_PARAM_ENABLED_acquire_timing
)
544 snprintf(hash
, sizeof(hash
), "##%s", overlay_param_names
[i
]);
545 data
->stat_selector
= (enum overlay_param_enabled
) i
;
547 ImGui::PlotHistogram(hash
, get_stat
, data
,
548 ARRAY_SIZE(data
->stats
), 0,
550 data
->stats_min
.stats
[i
],
551 data
->stats_max
.stats
[i
],
552 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
553 ImGui::Text("%s: %.0f [%u, %u]", overlay_param_names
[i
],
554 get_stat(data
, ARRAY_SIZE(data
->stats
) - 1),
555 data
->stats_min
.stats
[i
], data
->stats_max
.stats
[i
]);
557 data
->window_size
= ImVec2(data
->window_size
.x
, ImGui::GetCursorPosY() + 10.0f
);
563 static uint32_t vk_memory_type(struct device_data
*data
,
564 VkMemoryPropertyFlags properties
,
567 VkPhysicalDeviceMemoryProperties prop
;
568 data
->instance
->vtable
.GetPhysicalDeviceMemoryProperties(data
->physical_device
, &prop
);
569 for (uint32_t i
= 0; i
< prop
.memoryTypeCount
; i
++)
570 if ((prop
.memoryTypes
[i
].propertyFlags
& properties
) == properties
&& type_bits
& (1<<i
))
572 return 0xFFFFFFFF; // Unable to find memoryType
575 static void ensure_swapchain_fonts(struct swapchain_data
*data
,
576 VkCommandBuffer command_buffer
)
578 if (data
->font_uploaded
)
581 data
->font_uploaded
= true;
583 struct device_data
*device_data
= data
->device
;
584 ImGuiIO
& io
= ImGui::GetIO();
585 unsigned char* pixels
;
587 io
.Fonts
->GetTexDataAsRGBA32(&pixels
, &width
, &height
);
588 size_t upload_size
= width
* height
* 4 * sizeof(char);
591 VkBufferCreateInfo buffer_info
= {};
592 buffer_info
.sType
= VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
;
593 buffer_info
.size
= upload_size
;
594 buffer_info
.usage
= VK_BUFFER_USAGE_TRANSFER_SRC_BIT
;
595 buffer_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
596 VK_CHECK(device_data
->vtable
.CreateBuffer(device_data
->device
, &buffer_info
,
597 NULL
, &data
->upload_font_buffer
));
598 VkMemoryRequirements upload_buffer_req
;
599 device_data
->vtable
.GetBufferMemoryRequirements(device_data
->device
,
600 data
->upload_font_buffer
,
602 VkMemoryAllocateInfo upload_alloc_info
= {};
603 upload_alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
604 upload_alloc_info
.allocationSize
= upload_buffer_req
.size
;
605 upload_alloc_info
.memoryTypeIndex
= vk_memory_type(device_data
,
606 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
,
607 upload_buffer_req
.memoryTypeBits
);
608 VK_CHECK(device_data
->vtable
.AllocateMemory(device_data
->device
,
611 &data
->upload_font_buffer_mem
));
612 VK_CHECK(device_data
->vtable
.BindBufferMemory(device_data
->device
,
613 data
->upload_font_buffer
,
614 data
->upload_font_buffer_mem
, 0));
616 /* Upload to Buffer */
618 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
,
619 data
->upload_font_buffer_mem
,
620 0, upload_size
, 0, (void**)(&map
)));
621 memcpy(map
, pixels
, upload_size
);
622 VkMappedMemoryRange range
[1] = {};
623 range
[0].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
624 range
[0].memory
= data
->upload_font_buffer_mem
;
625 range
[0].size
= upload_size
;
626 VK_CHECK(device_data
->vtable
.FlushMappedMemoryRanges(device_data
->device
, 1, range
));
627 device_data
->vtable
.UnmapMemory(device_data
->device
,
628 data
->upload_font_buffer_mem
);
630 /* Copy buffer to image */
631 VkImageMemoryBarrier copy_barrier
[1] = {};
632 copy_barrier
[0].sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
633 copy_barrier
[0].dstAccessMask
= VK_ACCESS_TRANSFER_WRITE_BIT
;
634 copy_barrier
[0].oldLayout
= VK_IMAGE_LAYOUT_UNDEFINED
;
635 copy_barrier
[0].newLayout
= VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
;
636 copy_barrier
[0].srcQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
637 copy_barrier
[0].dstQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
638 copy_barrier
[0].image
= data
->font_image
;
639 copy_barrier
[0].subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
640 copy_barrier
[0].subresourceRange
.levelCount
= 1;
641 copy_barrier
[0].subresourceRange
.layerCount
= 1;
642 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
643 VK_PIPELINE_STAGE_HOST_BIT
,
644 VK_PIPELINE_STAGE_TRANSFER_BIT
,
648 VkBufferImageCopy region
= {};
649 region
.imageSubresource
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
650 region
.imageSubresource
.layerCount
= 1;
651 region
.imageExtent
.width
= width
;
652 region
.imageExtent
.height
= height
;
653 region
.imageExtent
.depth
= 1;
654 device_data
->vtable
.CmdCopyBufferToImage(command_buffer
,
655 data
->upload_font_buffer
,
657 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
,
660 VkImageMemoryBarrier use_barrier
[1] = {};
661 use_barrier
[0].sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
662 use_barrier
[0].srcAccessMask
= VK_ACCESS_TRANSFER_WRITE_BIT
;
663 use_barrier
[0].dstAccessMask
= VK_ACCESS_SHADER_READ_BIT
;
664 use_barrier
[0].oldLayout
= VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
;
665 use_barrier
[0].newLayout
= VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
;
666 use_barrier
[0].srcQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
667 use_barrier
[0].dstQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
668 use_barrier
[0].image
= data
->font_image
;
669 use_barrier
[0].subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
670 use_barrier
[0].subresourceRange
.levelCount
= 1;
671 use_barrier
[0].subresourceRange
.layerCount
= 1;
672 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
673 VK_PIPELINE_STAGE_TRANSFER_BIT
,
674 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT
,
680 /* Store our identifier */
681 io
.Fonts
->TexID
= (ImTextureID
)(intptr_t)data
->font_image
;
684 static void CreateOrResizeBuffer(struct device_data
*data
,
686 VkDeviceMemory
*buffer_memory
,
687 VkDeviceSize
*buffer_size
,
688 size_t new_size
, VkBufferUsageFlagBits usage
)
690 if (*buffer
!= VK_NULL_HANDLE
)
691 data
->vtable
.DestroyBuffer(data
->device
, *buffer
, NULL
);
693 data
->vtable
.FreeMemory(data
->device
, *buffer_memory
, NULL
);
695 VkBufferCreateInfo buffer_info
= {};
696 buffer_info
.sType
= VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
;
697 buffer_info
.size
= new_size
;
698 buffer_info
.usage
= usage
;
699 buffer_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
700 VK_CHECK(data
->vtable
.CreateBuffer(data
->device
, &buffer_info
, NULL
, buffer
));
702 VkMemoryRequirements req
;
703 data
->vtable
.GetBufferMemoryRequirements(data
->device
, *buffer
, &req
);
704 VkMemoryAllocateInfo alloc_info
= {};
705 alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
706 alloc_info
.allocationSize
= req
.size
;
707 alloc_info
.memoryTypeIndex
=
708 vk_memory_type(data
, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
, req
.memoryTypeBits
);
709 VK_CHECK(data
->vtable
.AllocateMemory(data
->device
, &alloc_info
, NULL
, buffer_memory
));
711 VK_CHECK(data
->vtable
.BindBufferMemory(data
->device
, *buffer
, *buffer_memory
, 0));
712 *buffer_size
= new_size
;
715 static void render_swapchain_display(struct swapchain_data
*data
, unsigned image_index
)
717 ImDrawData
* draw_data
= ImGui::GetDrawData();
718 if (draw_data
->TotalVtxCount
== 0)
721 struct device_data
*device_data
= data
->device
;
722 uint32_t idx
= data
->n_frames
% ARRAY_SIZE(data
->frame_data
);
723 VkCommandBuffer command_buffer
= data
->frame_data
[idx
].command_buffer
;
725 device_data
->vtable
.ResetCommandBuffer(command_buffer
, 0);
727 VkRenderPassBeginInfo render_pass_info
= {};
728 render_pass_info
.sType
= VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
;
729 render_pass_info
.renderPass
= data
->render_pass
;
730 render_pass_info
.framebuffer
= data
->framebuffers
[image_index
];
731 render_pass_info
.renderArea
.extent
.width
= data
->width
;
732 render_pass_info
.renderArea
.extent
.height
= data
->height
;
734 VkCommandBufferBeginInfo buffer_begin_info
= {};
735 buffer_begin_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
;
737 device_data
->vtable
.BeginCommandBuffer(command_buffer
, &buffer_begin_info
);
739 ensure_swapchain_fonts(data
, command_buffer
);
741 /* Bounce the image to display back to color attachment layout for
742 * rendering on top of it.
744 VkImageMemoryBarrier imb
;
745 imb
.sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
747 imb
.srcAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
748 imb
.dstAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
749 imb
.oldLayout
= VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
;
750 imb
.newLayout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
751 imb
.image
= data
->images
[image_index
];
752 imb
.subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
753 imb
.subresourceRange
.baseMipLevel
= 0;
754 imb
.subresourceRange
.levelCount
= 1;
755 imb
.subresourceRange
.baseArrayLayer
= 0;
756 imb
.subresourceRange
.layerCount
= 1;
757 imb
.srcQueueFamilyIndex
= device_data
->graphic_queue
->family_index
;
758 imb
.dstQueueFamilyIndex
= device_data
->graphic_queue
->family_index
;
759 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
760 VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT
,
761 VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT
,
762 0, /* dependency flags */
763 0, nullptr, /* memory barriers */
764 0, nullptr, /* buffer memory barriers */
765 1, &imb
); /* image memory barriers */
767 device_data
->vtable
.CmdBeginRenderPass(command_buffer
, &render_pass_info
,
768 VK_SUBPASS_CONTENTS_INLINE
);
770 /* Create/Resize vertex & index buffers */
771 size_t vertex_size
= draw_data
->TotalVtxCount
* sizeof(ImDrawVert
);
772 size_t index_size
= draw_data
->TotalIdxCount
* sizeof(ImDrawIdx
);
773 if (data
->frame_data
[idx
].vertex_buffer_size
< vertex_size
) {
774 CreateOrResizeBuffer(device_data
,
775 &data
->frame_data
[idx
].vertex_buffer
,
776 &data
->frame_data
[idx
].vertex_buffer_mem
,
777 &data
->frame_data
[idx
].vertex_buffer_size
,
778 vertex_size
, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT
);
780 if (data
->frame_data
[idx
].index_buffer_size
< index_size
) {
781 CreateOrResizeBuffer(device_data
,
782 &data
->frame_data
[idx
].index_buffer
,
783 &data
->frame_data
[idx
].index_buffer_mem
,
784 &data
->frame_data
[idx
].index_buffer_size
,
785 index_size
, VK_BUFFER_USAGE_INDEX_BUFFER_BIT
);
788 /* Upload vertex & index data */
789 VkBuffer vertex_buffer
= data
->frame_data
[idx
].vertex_buffer
;
790 VkDeviceMemory vertex_mem
= data
->frame_data
[idx
].vertex_buffer_mem
;
791 VkBuffer index_buffer
= data
->frame_data
[idx
].index_buffer
;
792 VkDeviceMemory index_mem
= data
->frame_data
[idx
].index_buffer_mem
;
793 ImDrawVert
* vtx_dst
= NULL
;
794 ImDrawIdx
* idx_dst
= NULL
;
795 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
, vertex_mem
,
796 0, vertex_size
, 0, (void**)(&vtx_dst
)));
797 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
, index_mem
,
798 0, index_size
, 0, (void**)(&idx_dst
)));
799 for (int n
= 0; n
< draw_data
->CmdListsCount
; n
++)
801 const ImDrawList
* cmd_list
= draw_data
->CmdLists
[n
];
802 memcpy(vtx_dst
, cmd_list
->VtxBuffer
.Data
, cmd_list
->VtxBuffer
.Size
* sizeof(ImDrawVert
));
803 memcpy(idx_dst
, cmd_list
->IdxBuffer
.Data
, cmd_list
->IdxBuffer
.Size
* sizeof(ImDrawIdx
));
804 vtx_dst
+= cmd_list
->VtxBuffer
.Size
;
805 idx_dst
+= cmd_list
->IdxBuffer
.Size
;
807 VkMappedMemoryRange range
[2] = {};
808 range
[0].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
809 range
[0].memory
= vertex_mem
;
810 range
[0].size
= VK_WHOLE_SIZE
;
811 range
[1].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
812 range
[1].memory
= index_mem
;
813 range
[1].size
= VK_WHOLE_SIZE
;
814 VK_CHECK(device_data
->vtable
.FlushMappedMemoryRanges(device_data
->device
, 2, range
));
815 device_data
->vtable
.UnmapMemory(device_data
->device
, vertex_mem
);
816 device_data
->vtable
.UnmapMemory(device_data
->device
, index_mem
);
818 /* Bind pipeline and descriptor sets */
819 device_data
->vtable
.CmdBindPipeline(command_buffer
, VK_PIPELINE_BIND_POINT_GRAPHICS
, data
->pipeline
);
820 VkDescriptorSet desc_set
[1] = { data
->descriptor_set
};
821 device_data
->vtable
.CmdBindDescriptorSets(command_buffer
, VK_PIPELINE_BIND_POINT_GRAPHICS
,
822 data
->pipeline_layout
, 0, 1, desc_set
, 0, NULL
);
824 /* Bind vertex & index buffers */
825 VkBuffer vertex_buffers
[1] = { vertex_buffer
};
826 VkDeviceSize vertex_offset
[1] = { 0 };
827 device_data
->vtable
.CmdBindVertexBuffers(command_buffer
, 0, 1, vertex_buffers
, vertex_offset
);
828 device_data
->vtable
.CmdBindIndexBuffer(command_buffer
, index_buffer
, 0, VK_INDEX_TYPE_UINT16
);
834 viewport
.width
= draw_data
->DisplaySize
.x
;
835 viewport
.height
= draw_data
->DisplaySize
.y
;
836 viewport
.minDepth
= 0.0f
;
837 viewport
.maxDepth
= 1.0f
;
838 device_data
->vtable
.CmdSetViewport(command_buffer
, 0, 1, &viewport
);
841 /* Setup scale and translation through push constants :
843 * Our visible imgui space lies from draw_data->DisplayPos (top left) to
844 * draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin
845 * is typically (0,0) for single viewport apps.
848 scale
[0] = 2.0f
/ draw_data
->DisplaySize
.x
;
849 scale
[1] = 2.0f
/ draw_data
->DisplaySize
.y
;
851 translate
[0] = -1.0f
- draw_data
->DisplayPos
.x
* scale
[0];
852 translate
[1] = -1.0f
- draw_data
->DisplayPos
.y
* scale
[1];
853 device_data
->vtable
.CmdPushConstants(command_buffer
, data
->pipeline_layout
,
854 VK_SHADER_STAGE_VERTEX_BIT
,
855 sizeof(float) * 0, sizeof(float) * 2, scale
);
856 device_data
->vtable
.CmdPushConstants(command_buffer
, data
->pipeline_layout
,
857 VK_SHADER_STAGE_VERTEX_BIT
,
858 sizeof(float) * 2, sizeof(float) * 2, translate
);
860 // Render the command lists:
863 ImVec2 display_pos
= draw_data
->DisplayPos
;
864 for (int n
= 0; n
< draw_data
->CmdListsCount
; n
++)
866 const ImDrawList
* cmd_list
= draw_data
->CmdLists
[n
];
867 for (int cmd_i
= 0; cmd_i
< cmd_list
->CmdBuffer
.Size
; cmd_i
++)
869 const ImDrawCmd
* pcmd
= &cmd_list
->CmdBuffer
[cmd_i
];
870 // Apply scissor/clipping rectangle
871 // FIXME: We could clamp width/height based on clamped min/max values.
873 scissor
.offset
.x
= (int32_t)(pcmd
->ClipRect
.x
- display_pos
.x
) > 0 ? (int32_t)(pcmd
->ClipRect
.x
- display_pos
.x
) : 0;
874 scissor
.offset
.y
= (int32_t)(pcmd
->ClipRect
.y
- display_pos
.y
) > 0 ? (int32_t)(pcmd
->ClipRect
.y
- display_pos
.y
) : 0;
875 scissor
.extent
.width
= (uint32_t)(pcmd
->ClipRect
.z
- pcmd
->ClipRect
.x
);
876 scissor
.extent
.height
= (uint32_t)(pcmd
->ClipRect
.w
- pcmd
->ClipRect
.y
+ 1); // FIXME: Why +1 here?
877 device_data
->vtable
.CmdSetScissor(command_buffer
, 0, 1, &scissor
);
880 device_data
->vtable
.CmdDrawIndexed(command_buffer
, pcmd
->ElemCount
, 1, idx_offset
, vtx_offset
, 0);
882 idx_offset
+= pcmd
->ElemCount
;
884 vtx_offset
+= cmd_list
->VtxBuffer
.Size
;
887 device_data
->vtable
.CmdEndRenderPass(command_buffer
);
888 device_data
->vtable
.EndCommandBuffer(command_buffer
);
890 if (data
->submission_semaphore
) {
891 device_data
->vtable
.DestroySemaphore(device_data
->device
,
892 data
->submission_semaphore
,
895 /* Submission semaphore */
896 VkSemaphoreCreateInfo semaphore_info
= {};
897 semaphore_info
.sType
= VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
;
898 VK_CHECK(device_data
->vtable
.CreateSemaphore(device_data
->device
, &semaphore_info
,
899 NULL
, &data
->submission_semaphore
));
901 VkSubmitInfo submit_info
= {};
902 VkPipelineStageFlags stage_wait
= VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT
;
903 submit_info
.sType
= VK_STRUCTURE_TYPE_SUBMIT_INFO
;
904 submit_info
.commandBufferCount
= 1;
905 submit_info
.pCommandBuffers
= &command_buffer
;
906 submit_info
.pWaitDstStageMask
= &stage_wait
;
907 submit_info
.signalSemaphoreCount
= 1;
908 submit_info
.pSignalSemaphores
= &data
->submission_semaphore
;
910 device_data
->vtable
.WaitForFences(device_data
->device
, 1, &data
->fence
, VK_TRUE
, UINT64_MAX
);
911 device_data
->vtable
.ResetFences(device_data
->device
, 1, &data
->fence
);
912 device_data
->vtable
.QueueSubmit(device_data
->graphic_queue
->queue
, 1, &submit_info
, data
->fence
);
915 static const uint32_t overlay_vert_spv
[] = {
916 #include "overlay.vert.spv.h"
918 static const uint32_t overlay_frag_spv
[] = {
919 #include "overlay.frag.spv.h"
922 static void setup_swapchain_data_pipeline(struct swapchain_data
*data
)
924 struct device_data
*device_data
= data
->device
;
925 VkShaderModule vert_module
, frag_module
;
927 /* Create shader modules */
928 VkShaderModuleCreateInfo vert_info
= {};
929 vert_info
.sType
= VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
;
930 vert_info
.codeSize
= sizeof(overlay_vert_spv
);
931 vert_info
.pCode
= overlay_vert_spv
;
932 VK_CHECK(device_data
->vtable
.CreateShaderModule(device_data
->device
,
933 &vert_info
, NULL
, &vert_module
));
934 VkShaderModuleCreateInfo frag_info
= {};
935 frag_info
.sType
= VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
;
936 frag_info
.codeSize
= sizeof(overlay_frag_spv
);
937 frag_info
.pCode
= (uint32_t*)overlay_frag_spv
;
938 VK_CHECK(device_data
->vtable
.CreateShaderModule(device_data
->device
,
939 &frag_info
, NULL
, &frag_module
));
942 VkSamplerCreateInfo sampler_info
= {};
943 sampler_info
.sType
= VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
;
944 sampler_info
.magFilter
= VK_FILTER_LINEAR
;
945 sampler_info
.minFilter
= VK_FILTER_LINEAR
;
946 sampler_info
.mipmapMode
= VK_SAMPLER_MIPMAP_MODE_LINEAR
;
947 sampler_info
.addressModeU
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
948 sampler_info
.addressModeV
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
949 sampler_info
.addressModeW
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
950 sampler_info
.minLod
= -1000;
951 sampler_info
.maxLod
= 1000;
952 sampler_info
.maxAnisotropy
= 1.0f
;
953 VK_CHECK(device_data
->vtable
.CreateSampler(device_data
->device
, &sampler_info
,
954 NULL
, &data
->font_sampler
));
956 /* Descriptor pool */
957 VkDescriptorPoolSize sampler_pool_size
= {};
958 sampler_pool_size
.type
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
959 sampler_pool_size
.descriptorCount
= 1;
960 VkDescriptorPoolCreateInfo desc_pool_info
= {};
961 desc_pool_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
;
962 desc_pool_info
.maxSets
= 1;
963 desc_pool_info
.poolSizeCount
= 1;
964 desc_pool_info
.pPoolSizes
= &sampler_pool_size
;
965 VK_CHECK(device_data
->vtable
.CreateDescriptorPool(device_data
->device
,
967 NULL
, &data
->descriptor_pool
));
969 /* Descriptor layout */
970 VkSampler sampler
[1] = { data
->font_sampler
};
971 VkDescriptorSetLayoutBinding binding
[1] = {};
972 binding
[0].descriptorType
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
973 binding
[0].descriptorCount
= 1;
974 binding
[0].stageFlags
= VK_SHADER_STAGE_FRAGMENT_BIT
;
975 binding
[0].pImmutableSamplers
= sampler
;
976 VkDescriptorSetLayoutCreateInfo set_layout_info
= {};
977 set_layout_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
;
978 set_layout_info
.bindingCount
= 1;
979 set_layout_info
.pBindings
= binding
;
980 VK_CHECK(device_data
->vtable
.CreateDescriptorSetLayout(device_data
->device
,
982 NULL
, &data
->descriptor_layout
));
985 VkDescriptorSetAllocateInfo alloc_info
= {};
986 alloc_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
;
987 alloc_info
.descriptorPool
= data
->descriptor_pool
;
988 alloc_info
.descriptorSetCount
= 1;
989 alloc_info
.pSetLayouts
= &data
->descriptor_layout
;
990 VK_CHECK(device_data
->vtable
.AllocateDescriptorSets(device_data
->device
,
992 &data
->descriptor_set
));
994 /* Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full
995 * 3d projection matrix
997 VkPushConstantRange push_constants
[1] = {};
998 push_constants
[0].stageFlags
= VK_SHADER_STAGE_VERTEX_BIT
;
999 push_constants
[0].offset
= sizeof(float) * 0;
1000 push_constants
[0].size
= sizeof(float) * 4;
1001 VkPipelineLayoutCreateInfo layout_info
= {};
1002 layout_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
;
1003 layout_info
.setLayoutCount
= 1;
1004 layout_info
.pSetLayouts
= &data
->descriptor_layout
;
1005 layout_info
.pushConstantRangeCount
= 1;
1006 layout_info
.pPushConstantRanges
= push_constants
;
1007 VK_CHECK(device_data
->vtable
.CreatePipelineLayout(device_data
->device
,
1009 NULL
, &data
->pipeline_layout
));
1011 VkPipelineShaderStageCreateInfo stage
[2] = {};
1012 stage
[0].sType
= VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
;
1013 stage
[0].stage
= VK_SHADER_STAGE_VERTEX_BIT
;
1014 stage
[0].module
= vert_module
;
1015 stage
[0].pName
= "main";
1016 stage
[1].sType
= VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
;
1017 stage
[1].stage
= VK_SHADER_STAGE_FRAGMENT_BIT
;
1018 stage
[1].module
= frag_module
;
1019 stage
[1].pName
= "main";
1021 VkVertexInputBindingDescription binding_desc
[1] = {};
1022 binding_desc
[0].stride
= sizeof(ImDrawVert
);
1023 binding_desc
[0].inputRate
= VK_VERTEX_INPUT_RATE_VERTEX
;
1025 VkVertexInputAttributeDescription attribute_desc
[3] = {};
1026 attribute_desc
[0].location
= 0;
1027 attribute_desc
[0].binding
= binding_desc
[0].binding
;
1028 attribute_desc
[0].format
= VK_FORMAT_R32G32_SFLOAT
;
1029 attribute_desc
[0].offset
= IM_OFFSETOF(ImDrawVert
, pos
);
1030 attribute_desc
[1].location
= 1;
1031 attribute_desc
[1].binding
= binding_desc
[0].binding
;
1032 attribute_desc
[1].format
= VK_FORMAT_R32G32_SFLOAT
;
1033 attribute_desc
[1].offset
= IM_OFFSETOF(ImDrawVert
, uv
);
1034 attribute_desc
[2].location
= 2;
1035 attribute_desc
[2].binding
= binding_desc
[0].binding
;
1036 attribute_desc
[2].format
= VK_FORMAT_R8G8B8A8_UNORM
;
1037 attribute_desc
[2].offset
= IM_OFFSETOF(ImDrawVert
, col
);
1039 VkPipelineVertexInputStateCreateInfo vertex_info
= {};
1040 vertex_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
;
1041 vertex_info
.vertexBindingDescriptionCount
= 1;
1042 vertex_info
.pVertexBindingDescriptions
= binding_desc
;
1043 vertex_info
.vertexAttributeDescriptionCount
= 3;
1044 vertex_info
.pVertexAttributeDescriptions
= attribute_desc
;
1046 VkPipelineInputAssemblyStateCreateInfo ia_info
= {};
1047 ia_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO
;
1048 ia_info
.topology
= VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST
;
1050 VkPipelineViewportStateCreateInfo viewport_info
= {};
1051 viewport_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
;
1052 viewport_info
.viewportCount
= 1;
1053 viewport_info
.scissorCount
= 1;
1055 VkPipelineRasterizationStateCreateInfo raster_info
= {};
1056 raster_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO
;
1057 raster_info
.polygonMode
= VK_POLYGON_MODE_FILL
;
1058 raster_info
.cullMode
= VK_CULL_MODE_NONE
;
1059 raster_info
.frontFace
= VK_FRONT_FACE_COUNTER_CLOCKWISE
;
1060 raster_info
.lineWidth
= 1.0f
;
1062 VkPipelineMultisampleStateCreateInfo ms_info
= {};
1063 ms_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
;
1064 ms_info
.rasterizationSamples
= VK_SAMPLE_COUNT_1_BIT
;
1066 VkPipelineColorBlendAttachmentState color_attachment
[1] = {};
1067 color_attachment
[0].blendEnable
= VK_TRUE
;
1068 color_attachment
[0].srcColorBlendFactor
= VK_BLEND_FACTOR_SRC_ALPHA
;
1069 color_attachment
[0].dstColorBlendFactor
= VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA
;
1070 color_attachment
[0].colorBlendOp
= VK_BLEND_OP_ADD
;
1071 color_attachment
[0].srcAlphaBlendFactor
= VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA
;
1072 color_attachment
[0].dstAlphaBlendFactor
= VK_BLEND_FACTOR_ZERO
;
1073 color_attachment
[0].alphaBlendOp
= VK_BLEND_OP_ADD
;
1074 color_attachment
[0].colorWriteMask
= VK_COLOR_COMPONENT_R_BIT
|
1075 VK_COLOR_COMPONENT_G_BIT
| VK_COLOR_COMPONENT_B_BIT
| VK_COLOR_COMPONENT_A_BIT
;
1077 VkPipelineDepthStencilStateCreateInfo depth_info
= {};
1078 depth_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
;
1080 VkPipelineColorBlendStateCreateInfo blend_info
= {};
1081 blend_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO
;
1082 blend_info
.attachmentCount
= 1;
1083 blend_info
.pAttachments
= color_attachment
;
1085 VkDynamicState dynamic_states
[2] = { VK_DYNAMIC_STATE_VIEWPORT
, VK_DYNAMIC_STATE_SCISSOR
};
1086 VkPipelineDynamicStateCreateInfo dynamic_state
= {};
1087 dynamic_state
.sType
= VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO
;
1088 dynamic_state
.dynamicStateCount
= (uint32_t)IM_ARRAYSIZE(dynamic_states
);
1089 dynamic_state
.pDynamicStates
= dynamic_states
;
1091 VkGraphicsPipelineCreateInfo info
= {};
1092 info
.sType
= VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
;
1094 info
.stageCount
= 2;
1095 info
.pStages
= stage
;
1096 info
.pVertexInputState
= &vertex_info
;
1097 info
.pInputAssemblyState
= &ia_info
;
1098 info
.pViewportState
= &viewport_info
;
1099 info
.pRasterizationState
= &raster_info
;
1100 info
.pMultisampleState
= &ms_info
;
1101 info
.pDepthStencilState
= &depth_info
;
1102 info
.pColorBlendState
= &blend_info
;
1103 info
.pDynamicState
= &dynamic_state
;
1104 info
.layout
= data
->pipeline_layout
;
1105 info
.renderPass
= data
->render_pass
;
1107 device_data
->vtable
.CreateGraphicsPipelines(device_data
->device
, VK_NULL_HANDLE
,
1109 NULL
, &data
->pipeline
));
1111 device_data
->vtable
.DestroyShaderModule(device_data
->device
, vert_module
, NULL
);
1112 device_data
->vtable
.DestroyShaderModule(device_data
->device
, frag_module
, NULL
);
1114 ImGuiIO
& io
= ImGui::GetIO();
1115 unsigned char* pixels
;
1117 io
.Fonts
->GetTexDataAsRGBA32(&pixels
, &width
, &height
);
1120 VkImageCreateInfo image_info
= {};
1121 image_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
;
1122 image_info
.imageType
= VK_IMAGE_TYPE_2D
;
1123 image_info
.format
= VK_FORMAT_R8G8B8A8_UNORM
;
1124 image_info
.extent
.width
= width
;
1125 image_info
.extent
.height
= height
;
1126 image_info
.extent
.depth
= 1;
1127 image_info
.mipLevels
= 1;
1128 image_info
.arrayLayers
= 1;
1129 image_info
.samples
= VK_SAMPLE_COUNT_1_BIT
;
1130 image_info
.tiling
= VK_IMAGE_TILING_OPTIMAL
;
1131 image_info
.usage
= VK_IMAGE_USAGE_SAMPLED_BIT
| VK_IMAGE_USAGE_TRANSFER_DST_BIT
;
1132 image_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
1133 image_info
.initialLayout
= VK_IMAGE_LAYOUT_UNDEFINED
;
1134 VK_CHECK(device_data
->vtable
.CreateImage(device_data
->device
, &image_info
,
1135 NULL
, &data
->font_image
));
1136 VkMemoryRequirements font_image_req
;
1137 device_data
->vtable
.GetImageMemoryRequirements(device_data
->device
,
1138 data
->font_image
, &font_image_req
);
1139 VkMemoryAllocateInfo image_alloc_info
= {};
1140 image_alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
1141 image_alloc_info
.allocationSize
= font_image_req
.size
;
1142 image_alloc_info
.memoryTypeIndex
= vk_memory_type(device_data
,
1143 VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT
,
1144 font_image_req
.memoryTypeBits
);
1145 VK_CHECK(device_data
->vtable
.AllocateMemory(device_data
->device
, &image_alloc_info
,
1146 NULL
, &data
->font_mem
));
1147 VK_CHECK(device_data
->vtable
.BindImageMemory(device_data
->device
,
1149 data
->font_mem
, 0));
1151 /* Font image view */
1152 VkImageViewCreateInfo view_info
= {};
1153 view_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
;
1154 view_info
.image
= data
->font_image
;
1155 view_info
.viewType
= VK_IMAGE_VIEW_TYPE_2D
;
1156 view_info
.format
= VK_FORMAT_R8G8B8A8_UNORM
;
1157 view_info
.subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
1158 view_info
.subresourceRange
.levelCount
= 1;
1159 view_info
.subresourceRange
.layerCount
= 1;
1160 VK_CHECK(device_data
->vtable
.CreateImageView(device_data
->device
, &view_info
,
1161 NULL
, &data
->font_image_view
));
1163 /* Descriptor set */
1164 VkDescriptorImageInfo desc_image
[1] = {};
1165 desc_image
[0].sampler
= data
->font_sampler
;
1166 desc_image
[0].imageView
= data
->font_image_view
;
1167 desc_image
[0].imageLayout
= VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
;
1168 VkWriteDescriptorSet write_desc
[1] = {};
1169 write_desc
[0].sType
= VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
;
1170 write_desc
[0].dstSet
= data
->descriptor_set
;
1171 write_desc
[0].descriptorCount
= 1;
1172 write_desc
[0].descriptorType
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
1173 write_desc
[0].pImageInfo
= desc_image
;
1174 device_data
->vtable
.UpdateDescriptorSets(device_data
->device
, 1, write_desc
, 0, NULL
);
1177 static void setup_swapchain_data(struct swapchain_data
*data
,
1178 const VkSwapchainCreateInfoKHR
*pCreateInfo
)
1180 data
->width
= pCreateInfo
->imageExtent
.width
;
1181 data
->height
= pCreateInfo
->imageExtent
.height
;
1182 data
->format
= pCreateInfo
->imageFormat
;
1184 data
->imgui_context
= ImGui::CreateContext();
1185 ImGui::SetCurrentContext(data
->imgui_context
);
1187 ImGui::GetIO().IniFilename
= NULL
;
1188 ImGui::GetIO().DisplaySize
= ImVec2((float)data
->width
, (float)data
->height
);
1190 struct device_data
*device_data
= data
->device
;
1193 VkAttachmentDescription attachment_desc
= {};
1194 attachment_desc
.format
= pCreateInfo
->imageFormat
;
1195 attachment_desc
.samples
= VK_SAMPLE_COUNT_1_BIT
;
1196 attachment_desc
.loadOp
= VK_ATTACHMENT_LOAD_OP_LOAD
;
1197 attachment_desc
.storeOp
= VK_ATTACHMENT_STORE_OP_STORE
;
1198 attachment_desc
.stencilLoadOp
= VK_ATTACHMENT_LOAD_OP_DONT_CARE
;
1199 attachment_desc
.stencilStoreOp
= VK_ATTACHMENT_STORE_OP_DONT_CARE
;
1200 attachment_desc
.initialLayout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
1201 attachment_desc
.finalLayout
= VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
;
1202 VkAttachmentReference color_attachment
= {};
1203 color_attachment
.attachment
= 0;
1204 color_attachment
.layout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
1205 VkSubpassDescription subpass
= {};
1206 subpass
.pipelineBindPoint
= VK_PIPELINE_BIND_POINT_GRAPHICS
;
1207 subpass
.colorAttachmentCount
= 1;
1208 subpass
.pColorAttachments
= &color_attachment
;
1209 VkSubpassDependency dependency
= {};
1210 dependency
.srcSubpass
= VK_SUBPASS_EXTERNAL
;
1211 dependency
.dstSubpass
= 0;
1212 dependency
.srcStageMask
= VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
;
1213 dependency
.dstStageMask
= VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
;
1214 dependency
.srcAccessMask
= 0;
1215 dependency
.dstAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
1216 VkRenderPassCreateInfo render_pass_info
= {};
1217 render_pass_info
.sType
= VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
;
1218 render_pass_info
.attachmentCount
= 1;
1219 render_pass_info
.pAttachments
= &attachment_desc
;
1220 render_pass_info
.subpassCount
= 1;
1221 render_pass_info
.pSubpasses
= &subpass
;
1222 render_pass_info
.dependencyCount
= 1;
1223 render_pass_info
.pDependencies
= &dependency
;
1224 VK_CHECK(device_data
->vtable
.CreateRenderPass(device_data
->device
,
1226 NULL
, &data
->render_pass
));
1228 setup_swapchain_data_pipeline(data
);
1230 VK_CHECK(device_data
->vtable
.GetSwapchainImagesKHR(device_data
->device
,
1235 data
->images
= ralloc_array(data
, VkImage
, data
->n_images
);
1236 data
->image_views
= ralloc_array(data
, VkImageView
, data
->n_images
);
1237 data
->framebuffers
= ralloc_array(data
, VkFramebuffer
, data
->n_images
);
1239 VK_CHECK(device_data
->vtable
.GetSwapchainImagesKHR(device_data
->device
,
1245 VkImageViewCreateInfo view_info
= {};
1246 view_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
;
1247 view_info
.viewType
= VK_IMAGE_VIEW_TYPE_2D
;
1248 view_info
.format
= pCreateInfo
->imageFormat
;
1249 view_info
.components
.r
= VK_COMPONENT_SWIZZLE_R
;
1250 view_info
.components
.g
= VK_COMPONENT_SWIZZLE_G
;
1251 view_info
.components
.b
= VK_COMPONENT_SWIZZLE_B
;
1252 view_info
.components
.a
= VK_COMPONENT_SWIZZLE_A
;
1253 view_info
.subresourceRange
= { VK_IMAGE_ASPECT_COLOR_BIT
, 0, 1, 0, 1 };
1254 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1255 view_info
.image
= data
->images
[i
];
1256 VK_CHECK(device_data
->vtable
.CreateImageView(device_data
->device
,
1258 &data
->image_views
[i
]));
1262 VkImageView attachment
[1];
1263 VkFramebufferCreateInfo fb_info
= {};
1264 fb_info
.sType
= VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
;
1265 fb_info
.renderPass
= data
->render_pass
;
1266 fb_info
.attachmentCount
= 1;
1267 fb_info
.pAttachments
= attachment
;
1268 fb_info
.width
= data
->width
;
1269 fb_info
.height
= data
->height
;
1271 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1272 attachment
[0] = data
->image_views
[i
];
1273 VK_CHECK(device_data
->vtable
.CreateFramebuffer(device_data
->device
, &fb_info
,
1274 NULL
, &data
->framebuffers
[i
]));
1277 /* Command buffer */
1278 VkCommandPoolCreateInfo cmd_buffer_pool_info
= {};
1279 cmd_buffer_pool_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
;
1280 cmd_buffer_pool_info
.flags
= VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT
;
1281 cmd_buffer_pool_info
.queueFamilyIndex
= device_data
->graphic_queue
->family_index
;
1282 VK_CHECK(device_data
->vtable
.CreateCommandPool(device_data
->device
,
1283 &cmd_buffer_pool_info
,
1284 NULL
, &data
->command_pool
));
1286 VkCommandBuffer cmd_bufs
[ARRAY_SIZE(data
->frame_data
)];
1288 VkCommandBufferAllocateInfo cmd_buffer_info
= {};
1289 cmd_buffer_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
;
1290 cmd_buffer_info
.commandPool
= data
->command_pool
;
1291 cmd_buffer_info
.level
= VK_COMMAND_BUFFER_LEVEL_PRIMARY
;
1292 cmd_buffer_info
.commandBufferCount
= 2;
1293 VK_CHECK(device_data
->vtable
.AllocateCommandBuffers(device_data
->device
,
1296 for (uint32_t i
= 0; i
< ARRAY_SIZE(data
->frame_data
); i
++) {
1297 VK_CHECK(device_data
->set_device_loader_data(device_data
->device
,
1300 data
->frame_data
[i
].command_buffer
= cmd_bufs
[i
];
1303 /* Submission fence */
1304 VkFenceCreateInfo fence_info
= {};
1305 fence_info
.sType
= VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
;
1306 fence_info
.flags
= VK_FENCE_CREATE_SIGNALED_BIT
;
1307 VK_CHECK(device_data
->vtable
.CreateFence(device_data
->device
, &fence_info
,
1308 NULL
, &data
->fence
));
1311 static void shutdown_swapchain_data(struct swapchain_data
*data
)
1313 struct device_data
*device_data
= data
->device
;
1315 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1316 device_data
->vtable
.DestroyImageView(device_data
->device
, data
->image_views
[i
], NULL
);
1317 device_data
->vtable
.DestroyFramebuffer(device_data
->device
, data
->framebuffers
[i
], NULL
);
1320 device_data
->vtable
.DestroyRenderPass(device_data
->device
, data
->render_pass
, NULL
);
1322 for (uint32_t i
= 0; i
< ARRAY_SIZE(data
->frame_data
); i
++) {
1323 device_data
->vtable
.FreeCommandBuffers(device_data
->device
,
1325 1, &data
->frame_data
[i
].command_buffer
);
1326 if (data
->frame_data
[i
].vertex_buffer
)
1327 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->frame_data
[i
].vertex_buffer
, NULL
);
1328 if (data
->frame_data
[i
].index_buffer
)
1329 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->frame_data
[i
].index_buffer
, NULL
);
1330 if (data
->frame_data
[i
].vertex_buffer_mem
)
1331 device_data
->vtable
.FreeMemory(device_data
->device
, data
->frame_data
[i
].vertex_buffer_mem
, NULL
);
1332 if (data
->frame_data
[i
].index_buffer_mem
)
1333 device_data
->vtable
.FreeMemory(device_data
->device
, data
->frame_data
[i
].index_buffer_mem
, NULL
);
1335 device_data
->vtable
.DestroyCommandPool(device_data
->device
, data
->command_pool
, NULL
);
1337 device_data
->vtable
.DestroyFence(device_data
->device
, data
->fence
, NULL
);
1338 if (data
->submission_semaphore
)
1339 device_data
->vtable
.DestroySemaphore(device_data
->device
, data
->submission_semaphore
, NULL
);
1341 device_data
->vtable
.DestroyPipeline(device_data
->device
, data
->pipeline
, NULL
);
1342 device_data
->vtable
.DestroyPipelineLayout(device_data
->device
, data
->pipeline_layout
, NULL
);
1344 device_data
->vtable
.DestroyDescriptorPool(device_data
->device
,
1345 data
->descriptor_pool
, NULL
);
1346 device_data
->vtable
.DestroyDescriptorSetLayout(device_data
->device
,
1347 data
->descriptor_layout
, NULL
);
1349 device_data
->vtable
.DestroySampler(device_data
->device
, data
->font_sampler
, NULL
);
1350 device_data
->vtable
.DestroyImageView(device_data
->device
, data
->font_image_view
, NULL
);
1351 device_data
->vtable
.DestroyImage(device_data
->device
, data
->font_image
, NULL
);
1352 device_data
->vtable
.FreeMemory(device_data
->device
, data
->font_mem
, NULL
);
1354 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->upload_font_buffer
, NULL
);
1355 device_data
->vtable
.FreeMemory(device_data
->device
, data
->upload_font_buffer_mem
, NULL
);
1357 ImGui::DestroyContext(data
->imgui_context
);
1360 static void before_present(struct swapchain_data
*swapchain_data
,
1361 unsigned imageIndex
)
1363 snapshot_swapchain_frame(swapchain_data
);
1365 compute_swapchain_display(swapchain_data
);
1366 render_swapchain_display(swapchain_data
, imageIndex
);
1369 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateSwapchainKHR(
1371 const VkSwapchainCreateInfoKHR
* pCreateInfo
,
1372 const VkAllocationCallbacks
* pAllocator
,
1373 VkSwapchainKHR
* pSwapchain
)
1375 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1376 VkResult result
= device_data
->vtable
.CreateSwapchainKHR(device
, pCreateInfo
, pAllocator
, pSwapchain
);
1377 if (result
!= VK_SUCCESS
) return result
;
1379 struct swapchain_data
*swapchain_data
= new_swapchain_data(*pSwapchain
, device_data
);
1380 setup_swapchain_data(swapchain_data
, pCreateInfo
);
1384 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroySwapchainKHR(
1386 VkSwapchainKHR swapchain
,
1387 const VkAllocationCallbacks
* pAllocator
)
1389 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(swapchain
);
1391 shutdown_swapchain_data(swapchain_data
);
1392 swapchain_data
->device
->vtable
.DestroySwapchainKHR(device
, swapchain
, pAllocator
);
1393 destroy_swapchain_data(swapchain_data
);
1396 VKAPI_ATTR VkResult VKAPI_CALL
overlay_QueuePresentKHR(
1398 const VkPresentInfoKHR
* pPresentInfo
)
1400 struct queue_data
*queue_data
= FIND_QUEUE_DATA(queue
);
1401 struct device_data
*device_data
= queue_data
->device
;
1403 /* If we present on the graphic queue this layer is using to draw an
1404 * overlay, we don't need more than submitting the overlay draw prior to
1407 if (queue_data
== device_data
->graphic_queue
) {
1408 for (uint32_t i
= 0; i
< pPresentInfo
->swapchainCount
; i
++) {
1409 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pPresentInfo
->pSwapchains
[i
]);
1410 before_present(swapchain_data
, pPresentInfo
->pImageIndices
[i
]);
1412 return queue_data
->device
->vtable
.QueuePresentKHR(queue
, pPresentInfo
);
1415 /* Otherwise we need to do cross queue synchronization to tie the overlay
1416 * draw into the present queue.
1418 VkPresentInfoKHR present_info
= *pPresentInfo
;
1419 VkSemaphore
*semaphores
=
1420 (VkSemaphore
*)malloc(sizeof(VkSemaphore
) * (pPresentInfo
->waitSemaphoreCount
+ pPresentInfo
->swapchainCount
));
1421 for (uint32_t i
= 0; i
< pPresentInfo
->waitSemaphoreCount
; i
++)
1422 semaphores
[i
] = pPresentInfo
->pWaitSemaphores
[i
];
1423 for (uint32_t i
= 0; i
< pPresentInfo
->swapchainCount
; i
++) {
1424 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pPresentInfo
->pSwapchains
[i
]);
1425 before_present(swapchain_data
, pPresentInfo
->pImageIndices
[i
]);
1426 semaphores
[pPresentInfo
->waitSemaphoreCount
+ i
] = swapchain_data
->submission_semaphore
;
1428 present_info
.pWaitSemaphores
= semaphores
;
1429 present_info
.waitSemaphoreCount
= pPresentInfo
->waitSemaphoreCount
+ pPresentInfo
->swapchainCount
;
1430 VkResult result
= queue_data
->device
->vtable
.QueuePresentKHR(queue
, &present_info
);
1435 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AcquireNextImageKHR(
1437 VkSwapchainKHR swapchain
,
1439 VkSemaphore semaphore
,
1441 uint32_t* pImageIndex
)
1443 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(swapchain
);
1444 struct device_data
*device_data
= swapchain_data
->device
;
1446 uint64_t ts0
= os_time_get();
1447 VkResult result
= device_data
->vtable
.AcquireNextImageKHR(device
, swapchain
, timeout
,
1448 semaphore
, fence
, pImageIndex
);
1449 uint64_t ts1
= os_time_get();
1451 swapchain_data
->acquire_times
[swapchain_data
->n_acquire
%
1452 ARRAY_SIZE(swapchain_data
->acquire_times
)] =
1453 ((double)ts1
- (double)ts0
) / 1000.0;
1454 swapchain_data
->n_acquire
++;
1459 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AcquireNextImage2KHR(
1461 const VkAcquireNextImageInfoKHR
* pAcquireInfo
,
1462 uint32_t* pImageIndex
)
1464 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pAcquireInfo
->swapchain
);
1465 struct device_data
*device_data
= swapchain_data
->device
;
1467 uint64_t ts0
= os_time_get();
1468 VkResult result
= device_data
->vtable
.AcquireNextImage2KHR(device
, pAcquireInfo
, pImageIndex
);
1469 uint64_t ts1
= os_time_get();
1471 swapchain_data
->acquire_times
[swapchain_data
->n_acquire
%
1472 ARRAY_SIZE(swapchain_data
->acquire_times
)] =
1473 ((double)ts1
- (double)ts0
) / 1000.0;
1474 swapchain_data
->n_acquire
++;
1479 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDraw(
1480 VkCommandBuffer commandBuffer
,
1481 uint32_t vertexCount
,
1482 uint32_t instanceCount
,
1483 uint32_t firstVertex
,
1484 uint32_t firstInstance
)
1486 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1487 device_data
->vtable
.CmdDraw(commandBuffer
, vertexCount
, instanceCount
,
1488 firstVertex
, firstInstance
);
1489 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw
]++;
1492 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexed(
1493 VkCommandBuffer commandBuffer
,
1494 uint32_t indexCount
,
1495 uint32_t instanceCount
,
1496 uint32_t firstIndex
,
1497 int32_t vertexOffset
,
1498 uint32_t firstInstance
)
1500 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1501 device_data
->vtable
.CmdDrawIndexed(commandBuffer
, indexCount
, instanceCount
,
1502 firstIndex
, vertexOffset
, firstInstance
);
1503 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed
]++;
1506 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndirect(
1507 VkCommandBuffer commandBuffer
,
1509 VkDeviceSize offset
,
1513 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1514 device_data
->vtable
.CmdDrawIndirect(commandBuffer
, buffer
, offset
, drawCount
, stride
);
1515 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indirect
]++;
1518 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexedIndirect(
1519 VkCommandBuffer commandBuffer
,
1521 VkDeviceSize offset
,
1525 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1526 device_data
->vtable
.CmdDrawIndexedIndirect(commandBuffer
, buffer
, offset
, drawCount
, stride
);
1527 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed_indirect
]++;
1530 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndirectCountKHR(
1531 VkCommandBuffer commandBuffer
,
1533 VkDeviceSize offset
,
1534 VkBuffer countBuffer
,
1535 VkDeviceSize countBufferOffset
,
1536 uint32_t maxDrawCount
,
1539 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1540 device_data
->vtable
.CmdDrawIndirectCountKHR(commandBuffer
, buffer
, offset
,
1541 countBuffer
, countBufferOffset
,
1542 maxDrawCount
, stride
);
1543 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indirect_count
]++;
1546 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexedIndirectCountKHR(
1547 VkCommandBuffer commandBuffer
,
1549 VkDeviceSize offset
,
1550 VkBuffer countBuffer
,
1551 VkDeviceSize countBufferOffset
,
1552 uint32_t maxDrawCount
,
1555 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1556 device_data
->vtable
.CmdDrawIndexedIndirectCountKHR(commandBuffer
, buffer
, offset
,
1557 countBuffer
, countBufferOffset
,
1558 maxDrawCount
, stride
);
1559 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed_indirect_count
]++;
1562 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDispatch(
1563 VkCommandBuffer commandBuffer
,
1564 uint32_t groupCountX
,
1565 uint32_t groupCountY
,
1566 uint32_t groupCountZ
)
1568 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1569 device_data
->vtable
.CmdDispatch(commandBuffer
, groupCountX
, groupCountY
, groupCountZ
);
1570 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_dispatch
]++;
1573 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDispatchIndirect(
1574 VkCommandBuffer commandBuffer
,
1576 VkDeviceSize offset
)
1578 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1579 device_data
->vtable
.CmdDispatchIndirect(commandBuffer
, buffer
, offset
);
1580 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_dispatch_indirect
]++;
1583 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdBindPipeline(
1584 VkCommandBuffer commandBuffer
,
1585 VkPipelineBindPoint pipelineBindPoint
,
1586 VkPipeline pipeline
)
1588 struct device_data
*device_data
= FIND_DEVICE_DATA(commandBuffer
);
1589 device_data
->vtable
.CmdBindPipeline(commandBuffer
, pipelineBindPoint
, pipeline
);
1590 switch (pipelineBindPoint
) {
1591 case VK_PIPELINE_BIND_POINT_GRAPHICS
: device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_graphics
]++; break;
1592 case VK_PIPELINE_BIND_POINT_COMPUTE
: device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_compute
]++; break;
1593 case VK_PIPELINE_BIND_POINT_RAY_TRACING_NV
: device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_raytracing
]++; break;
1598 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AllocateCommandBuffers(VkDevice device
,
1599 const VkCommandBufferAllocateInfo
* pAllocateInfo
,
1600 VkCommandBuffer
* pCommandBuffers
)
1602 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1605 device_data
->vtable
.AllocateCommandBuffers(device
, pAllocateInfo
, pCommandBuffers
);
1606 if (result
!= VK_SUCCESS
) return result
;
1608 for (uint32_t i
= 0; i
< pAllocateInfo
->commandBufferCount
; i
++)
1609 map_object(pCommandBuffers
[i
], device_data
);
1614 VKAPI_ATTR
void VKAPI_CALL
overlay_FreeCommandBuffers(VkDevice device
,
1615 VkCommandPool commandPool
,
1616 uint32_t commandBufferCount
,
1617 const VkCommandBuffer
* pCommandBuffers
)
1619 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1621 for (uint32_t i
= 0; i
< commandBufferCount
; i
++)
1622 unmap_object(pCommandBuffers
[i
]);
1624 device_data
->vtable
.FreeCommandBuffers(device
, commandPool
,
1625 commandBufferCount
, pCommandBuffers
);
1628 VKAPI_ATTR VkResult VKAPI_CALL
overlay_QueueSubmit(
1630 uint32_t submitCount
,
1631 const VkSubmitInfo
* pSubmits
,
1634 struct queue_data
*queue_data
= FIND_QUEUE_DATA(queue
);
1635 struct device_data
*device_data
= queue_data
->device
;
1637 device_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_submit
]++;
1639 return device_data
->vtable
.QueueSubmit(queue
, submitCount
, pSubmits
, fence
);
1642 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateDevice(
1643 VkPhysicalDevice physicalDevice
,
1644 const VkDeviceCreateInfo
* pCreateInfo
,
1645 const VkAllocationCallbacks
* pAllocator
,
1648 struct instance_data
*instance_data
= FIND_PHYSICAL_DEVICE_DATA(physicalDevice
);
1649 VkLayerDeviceCreateInfo
*chain_info
=
1650 get_device_chain_info(pCreateInfo
, VK_LAYER_LINK_INFO
);
1652 assert(chain_info
->u
.pLayerInfo
);
1653 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr
= chain_info
->u
.pLayerInfo
->pfnNextGetInstanceProcAddr
;
1654 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr
= chain_info
->u
.pLayerInfo
->pfnNextGetDeviceProcAddr
;
1655 PFN_vkCreateDevice fpCreateDevice
= (PFN_vkCreateDevice
)fpGetInstanceProcAddr(NULL
, "vkCreateDevice");
1656 if (fpCreateDevice
== NULL
) {
1657 return VK_ERROR_INITIALIZATION_FAILED
;
1660 // Advance the link info for the next element on the chain
1661 chain_info
->u
.pLayerInfo
= chain_info
->u
.pLayerInfo
->pNext
;
1663 VkResult result
= fpCreateDevice(physicalDevice
, pCreateInfo
, pAllocator
, pDevice
);
1664 if (result
!= VK_SUCCESS
) return result
;
1666 struct device_data
*device_data
= new_device_data(*pDevice
, instance_data
);
1667 device_data
->physical_device
= physicalDevice
;
1668 vk_load_device_commands(*pDevice
, fpGetDeviceProcAddr
, &device_data
->vtable
);
1670 instance_data
->vtable
.GetPhysicalDeviceProperties(device_data
->physical_device
,
1671 &device_data
->properties
);
1673 VkLayerDeviceCreateInfo
*load_data_info
=
1674 get_device_chain_info(pCreateInfo
, VK_LOADER_DATA_CALLBACK
);
1675 device_data
->set_device_loader_data
= load_data_info
->u
.pfnSetDeviceLoaderData
;
1677 device_map_queues(device_data
, pCreateInfo
);
1682 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroyDevice(
1684 const VkAllocationCallbacks
* pAllocator
)
1686 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1687 device_unmap_queues(device_data
);
1688 device_data
->vtable
.DestroyDevice(device
, pAllocator
);
1689 destroy_device_data(device_data
);
1692 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateInstance(
1693 const VkInstanceCreateInfo
* pCreateInfo
,
1694 const VkAllocationCallbacks
* pAllocator
,
1695 VkInstance
* pInstance
)
1697 VkLayerInstanceCreateInfo
*chain_info
=
1698 get_instance_chain_info(pCreateInfo
, VK_LAYER_LINK_INFO
);
1700 assert(chain_info
->u
.pLayerInfo
);
1701 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr
=
1702 chain_info
->u
.pLayerInfo
->pfnNextGetInstanceProcAddr
;
1703 PFN_vkCreateInstance fpCreateInstance
=
1704 (PFN_vkCreateInstance
)fpGetInstanceProcAddr(NULL
, "vkCreateInstance");
1705 if (fpCreateInstance
== NULL
) {
1706 return VK_ERROR_INITIALIZATION_FAILED
;
1709 // Advance the link info for the next element on the chain
1710 chain_info
->u
.pLayerInfo
= chain_info
->u
.pLayerInfo
->pNext
;
1712 VkResult result
= fpCreateInstance(pCreateInfo
, pAllocator
, pInstance
);
1713 if (result
!= VK_SUCCESS
) return result
;
1715 struct instance_data
*instance_data
= new_instance_data(*pInstance
);
1716 vk_load_instance_commands(instance_data
->instance
,
1717 fpGetInstanceProcAddr
,
1718 &instance_data
->vtable
);
1719 instance_data_map_physical_devices(instance_data
, true);
1721 parse_overlay_env(&instance_data
->params
, getenv("VK_LAYER_MESA_OVERLAY_CONFIG"));
1726 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroyInstance(
1727 VkInstance instance
,
1728 const VkAllocationCallbacks
* pAllocator
)
1730 struct instance_data
*instance_data
= FIND_INSTANCE_DATA(instance
);
1731 instance_data_map_physical_devices(instance_data
, false);
1732 instance_data
->vtable
.DestroyInstance(instance
, pAllocator
);
1733 destroy_instance_data(instance_data
);
1736 static const struct {
1739 } name_to_funcptr_map
[] = {
1740 { "vkGetDeviceProcAddr", (void *) vkGetDeviceProcAddr
},
1741 #define ADD_HOOK(fn) { "vk" # fn, (void *) overlay_ ## fn }
1742 ADD_HOOK(AllocateCommandBuffers
),
1745 ADD_HOOK(CmdDrawIndexed
),
1746 ADD_HOOK(CmdDrawIndexedIndirect
),
1747 ADD_HOOK(CmdDispatch
),
1748 ADD_HOOK(CmdDispatchIndirect
),
1749 ADD_HOOK(CmdDrawIndirectCountKHR
),
1750 ADD_HOOK(CmdDrawIndexedIndirectCountKHR
),
1752 ADD_HOOK(CmdBindPipeline
),
1754 ADD_HOOK(CreateSwapchainKHR
),
1755 ADD_HOOK(QueuePresentKHR
),
1756 ADD_HOOK(DestroySwapchainKHR
),
1757 ADD_HOOK(AcquireNextImageKHR
),
1758 ADD_HOOK(AcquireNextImage2KHR
),
1760 ADD_HOOK(QueueSubmit
),
1761 ADD_HOOK(CreateInstance
),
1762 ADD_HOOK(DestroyInstance
),
1763 ADD_HOOK(CreateDevice
),
1764 ADD_HOOK(DestroyDevice
),
1768 static void *find_ptr(const char *name
)
1770 for (uint32_t i
= 0; i
< ARRAY_SIZE(name_to_funcptr_map
); i
++) {
1771 if (strcmp(name
, name_to_funcptr_map
[i
].name
) == 0)
1772 return name_to_funcptr_map
[i
].ptr
;
1778 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL
vkGetDeviceProcAddr(VkDevice dev
,
1779 const char *funcName
)
1781 void *ptr
= find_ptr(funcName
);
1782 if (ptr
) return reinterpret_cast<PFN_vkVoidFunction
>(ptr
);
1784 if (dev
== NULL
) return NULL
;
1786 struct device_data
*device_data
= FIND_DEVICE_DATA(dev
);
1787 if (device_data
->vtable
.GetDeviceProcAddr
== NULL
) return NULL
;
1788 return device_data
->vtable
.GetDeviceProcAddr(dev
, funcName
);
1791 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL
vkGetInstanceProcAddr(VkInstance instance
,
1792 const char *funcName
)
1794 void *ptr
= find_ptr(funcName
);
1795 if (ptr
) return reinterpret_cast<PFN_vkVoidFunction
>(ptr
);
1797 if (instance
== NULL
) return NULL
;
1799 struct instance_data
*instance_data
= FIND_INSTANCE_DATA(instance
);
1800 if (instance_data
->vtable
.GetInstanceProcAddr
== NULL
) return NULL
;
1801 return instance_data
->vtable
.GetInstanceProcAddr(instance
, funcName
);