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 uint64_t stats
[OVERLAY_PARAM_ENABLED_MAX
];
56 /* Mapped from VkDevice */
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 /* For a single frame */
75 struct frame_stat frame_stats
;
78 /* Mapped from VkCommandBuffer */
79 struct command_buffer_data
{
80 struct device_data
*device
;
82 VkCommandBufferLevel level
;
84 VkCommandBuffer cmd_buffer
;
85 VkQueryPool pipeline_query_pool
;
88 struct frame_stat stats
;
91 /* Mapped from VkQueue */
93 struct device_data
*device
;
97 uint32_t family_index
;
100 /* Mapped from VkSwapchainKHR */
101 struct swapchain_data
{
102 struct device_data
*device
;
104 VkSwapchainKHR swapchain
;
105 unsigned width
, height
;
110 VkImageView
*image_views
;
111 VkFramebuffer
*framebuffers
;
113 VkRenderPass render_pass
;
115 VkDescriptorPool descriptor_pool
;
116 VkDescriptorSetLayout descriptor_layout
;
117 VkDescriptorSet descriptor_set
;
119 VkSampler font_sampler
;
121 VkPipelineLayout pipeline_layout
;
124 VkCommandPool command_pool
;
127 VkCommandBuffer command_buffer
;
129 VkBuffer vertex_buffer
;
130 VkDeviceMemory vertex_buffer_mem
;
131 VkDeviceSize vertex_buffer_size
;
133 VkBuffer index_buffer
;
134 VkDeviceMemory index_buffer_mem
;
135 VkDeviceSize index_buffer_size
;
140 VkImageView font_image_view
;
141 VkDeviceMemory font_mem
;
142 VkBuffer upload_font_buffer
;
143 VkDeviceMemory upload_font_buffer_mem
;
146 VkSemaphore submission_semaphore
;
149 ImGuiContext
* imgui_context
;
154 uint64_t last_present_time
;
156 unsigned n_frames_since_update
;
157 uint64_t last_fps_update
;
160 enum overlay_param_enabled stat_selector
;
161 struct frame_stat stats_min
, stats_max
;
162 struct frame_stat frames_stats
[200];
164 /* Over a single frame */
165 struct frame_stat frame_stats
;
167 /* Over fps_sampling_period */
168 struct frame_stat accumulated_stats
;
171 static struct hash_table
*vk_object_to_data
= NULL
;
172 static simple_mtx_t vk_object_to_data_mutex
= _SIMPLE_MTX_INITIALIZER_NP
;
174 thread_local ImGuiContext
* __MesaImGui
;
176 static inline void ensure_vk_object_map(void)
178 if (!vk_object_to_data
) {
179 vk_object_to_data
= _mesa_hash_table_create(NULL
,
181 _mesa_key_pointer_equal
);
185 #define FIND_SWAPCHAIN_DATA(obj) ((struct swapchain_data *)find_object_data((void *) obj))
186 #define FIND_CMD_BUFFER_DATA(obj) ((struct command_buffer_data *)find_object_data((void *) obj))
187 #define FIND_DEVICE_DATA(obj) ((struct device_data *)find_object_data((void *) obj))
188 #define FIND_QUEUE_DATA(obj) ((struct queue_data *)find_object_data((void *) obj))
189 #define FIND_PHYSICAL_DEVICE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
190 #define FIND_INSTANCE_DATA(obj) ((struct instance_data *)find_object_data((void *) obj))
191 static void *find_object_data(void *obj
)
193 simple_mtx_lock(&vk_object_to_data_mutex
);
194 ensure_vk_object_map();
195 struct hash_entry
*entry
= _mesa_hash_table_search(vk_object_to_data
, obj
);
196 void *data
= entry
? entry
->data
: NULL
;
197 simple_mtx_unlock(&vk_object_to_data_mutex
);
201 static void map_object(void *obj
, void *data
)
203 simple_mtx_lock(&vk_object_to_data_mutex
);
204 ensure_vk_object_map();
205 _mesa_hash_table_insert(vk_object_to_data
, obj
, data
);
206 simple_mtx_unlock(&vk_object_to_data_mutex
);
209 static void unmap_object(void *obj
)
211 simple_mtx_lock(&vk_object_to_data_mutex
);
212 struct hash_entry
*entry
= _mesa_hash_table_search(vk_object_to_data
, obj
);
213 _mesa_hash_table_remove(vk_object_to_data
, entry
);
214 simple_mtx_unlock(&vk_object_to_data_mutex
);
219 #define VK_CHECK(expr) \
221 VkResult __result = (expr); \
222 if (__result != VK_SUCCESS) { \
223 fprintf(stderr, "'%s' line %i failed with %s\n", \
224 #expr, __LINE__, vk_Result_to_str(__result)); \
230 static VkLayerInstanceCreateInfo
*get_instance_chain_info(const VkInstanceCreateInfo
*pCreateInfo
,
231 VkLayerFunction func
)
233 vk_foreach_struct(item
, pCreateInfo
->pNext
) {
234 if (item
->sType
== VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO
&&
235 ((VkLayerInstanceCreateInfo
*) item
)->function
== func
)
236 return (VkLayerInstanceCreateInfo
*) item
;
238 unreachable("instance chain info not found");
242 static VkLayerDeviceCreateInfo
*get_device_chain_info(const VkDeviceCreateInfo
*pCreateInfo
,
243 VkLayerFunction func
)
245 vk_foreach_struct(item
, pCreateInfo
->pNext
) {
246 if (item
->sType
== VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO
&&
247 ((VkLayerDeviceCreateInfo
*) item
)->function
== func
)
248 return (VkLayerDeviceCreateInfo
*)item
;
250 unreachable("device chain info not found");
256 static struct instance_data
*new_instance_data(VkInstance instance
)
258 struct instance_data
*data
= rzalloc(NULL
, struct instance_data
);
259 data
->instance
= instance
;
260 map_object(data
->instance
, data
);
264 static void destroy_instance_data(struct instance_data
*data
)
266 if (data
->params
.output_file
)
267 fclose(data
->params
.output_file
);
268 unmap_object(data
->instance
);
272 static void instance_data_map_physical_devices(struct instance_data
*instance_data
,
275 uint32_t physicalDeviceCount
= 0;
276 instance_data
->vtable
.EnumeratePhysicalDevices(instance_data
->instance
,
277 &physicalDeviceCount
,
280 VkPhysicalDevice
*physicalDevices
= (VkPhysicalDevice
*) malloc(sizeof(VkPhysicalDevice
) * physicalDeviceCount
);
281 instance_data
->vtable
.EnumeratePhysicalDevices(instance_data
->instance
,
282 &physicalDeviceCount
,
285 for (uint32_t i
= 0; i
< physicalDeviceCount
; i
++) {
287 map_object(physicalDevices
[i
], instance_data
);
289 unmap_object(physicalDevices
[i
]);
292 free(physicalDevices
);
296 static struct device_data
*new_device_data(VkDevice device
, struct instance_data
*instance
)
298 struct device_data
*data
= rzalloc(NULL
, struct device_data
);
299 data
->instance
= instance
;
300 data
->device
= device
;
301 map_object(data
->device
, data
);
305 static struct queue_data
*new_queue_data(VkQueue queue
,
306 const VkQueueFamilyProperties
*family_props
,
307 uint32_t family_index
,
308 struct device_data
*device_data
)
310 struct queue_data
*data
= rzalloc(device_data
, struct queue_data
);
311 data
->device
= device_data
;
313 data
->flags
= family_props
->queueFlags
;
314 data
->family_index
= family_index
;
315 map_object(data
->queue
, data
);
317 if (data
->flags
& VK_QUEUE_GRAPHICS_BIT
)
318 device_data
->graphic_queue
= data
;
323 static void device_map_queues(struct device_data
*data
,
324 const VkDeviceCreateInfo
*pCreateInfo
)
326 for (uint32_t i
= 0; i
< pCreateInfo
->queueCreateInfoCount
; i
++)
327 data
->n_queues
+= pCreateInfo
->pQueueCreateInfos
[i
].queueCount
;
328 data
->queues
= ralloc_array(data
, struct queue_data
*, data
->n_queues
);
330 struct instance_data
*instance_data
= data
->instance
;
331 uint32_t n_family_props
;
332 instance_data
->vtable
.GetPhysicalDeviceQueueFamilyProperties(data
->physical_device
,
335 VkQueueFamilyProperties
*family_props
=
336 (VkQueueFamilyProperties
*)malloc(sizeof(VkQueueFamilyProperties
) * n_family_props
);
337 instance_data
->vtable
.GetPhysicalDeviceQueueFamilyProperties(data
->physical_device
,
341 uint32_t queue_index
= 0;
342 for (uint32_t i
= 0; i
< pCreateInfo
->queueCreateInfoCount
; i
++) {
343 for (uint32_t j
= 0; j
< pCreateInfo
->pQueueCreateInfos
[i
].queueCount
; j
++) {
345 data
->vtable
.GetDeviceQueue(data
->device
,
346 pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
,
349 VK_CHECK(data
->set_device_loader_data(data
->device
, queue
));
351 data
->queues
[queue_index
++] =
352 new_queue_data(queue
, &family_props
[pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
],
353 pCreateInfo
->pQueueCreateInfos
[i
].queueFamilyIndex
, data
);
360 static void device_unmap_queues(struct device_data
*data
)
362 for (uint32_t i
= 0; i
< data
->n_queues
; i
++)
363 unmap_object(data
->queues
[i
]->queue
);
366 static void destroy_device_data(struct device_data
*data
)
368 unmap_object(data
->device
);
373 static struct command_buffer_data
*new_command_buffer_data(VkCommandBuffer cmd_buffer
,
374 VkCommandBufferLevel level
,
375 struct device_data
*device_data
)
377 struct command_buffer_data
*data
= rzalloc(NULL
, struct command_buffer_data
);
378 data
->device
= device_data
;
379 data
->cmd_buffer
= cmd_buffer
;
381 map_object((void *) data
->cmd_buffer
, data
);
385 static void destroy_command_buffer_data(struct command_buffer_data
*data
)
387 unmap_object((void *) data
->cmd_buffer
);
393 static struct swapchain_data
*new_swapchain_data(VkSwapchainKHR swapchain
,
394 struct device_data
*device_data
)
396 struct swapchain_data
*data
= rzalloc(NULL
, struct swapchain_data
);
397 data
->device
= device_data
;
398 data
->swapchain
= swapchain
;
399 data
->window_size
= ImVec2(300, 300);
400 map_object((void *) data
->swapchain
, data
);
404 static void destroy_swapchain_data(struct swapchain_data
*data
)
406 unmap_object((void *) data
->swapchain
);
410 static void snapshot_swapchain_frame(struct swapchain_data
*data
)
412 struct device_data
*device_data
= data
->device
;
413 struct instance_data
*instance_data
= device_data
->instance
;
414 uint32_t f_idx
= data
->n_frames
% ARRAY_SIZE(data
->frames_stats
);
415 uint64_t now
= os_time_get(); /* us */
417 if (data
->last_present_time
) {
418 data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_frame_timing
] =
419 now
- data
->last_present_time
;
422 memset(&data
->frames_stats
[f_idx
], 0, sizeof(data
->frames_stats
[f_idx
]));
423 for (int s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++) {
424 data
->frames_stats
[f_idx
].stats
[s
] += device_data
->frame_stats
.stats
[s
] + data
->frame_stats
.stats
[s
];
425 data
->accumulated_stats
.stats
[s
] += device_data
->frame_stats
.stats
[s
] + data
->frame_stats
.stats
[s
];
428 if (data
->last_fps_update
) {
429 double elapsed
= (double)(now
- data
->last_fps_update
); /* us */
430 if (elapsed
>= instance_data
->params
.fps_sampling_period
) {
431 data
->fps
= 1000000.0f
* data
->n_frames_since_update
/ elapsed
;
432 if (instance_data
->params
.output_file
) {
433 fprintf(instance_data
->params
.output_file
, "%.2f\n", data
->fps
);
434 fflush(instance_data
->params
.output_file
);
437 memset(&data
->accumulated_stats
, 0, sizeof(data
->accumulated_stats
));
438 data
->n_frames_since_update
= 0;
439 data
->last_fps_update
= now
;
442 data
->last_fps_update
= now
;
445 memset(&device_data
->frame_stats
, 0, sizeof(device_data
->frame_stats
));
446 memset(&data
->frame_stats
, 0, sizeof(device_data
->frame_stats
));
448 data
->last_present_time
= now
;
450 data
->n_frames_since_update
++;
453 static float get_time_stat(void *_data
, int _idx
)
455 struct swapchain_data
*data
= (struct swapchain_data
*) _data
;
456 if ((ARRAY_SIZE(data
->frames_stats
) - _idx
) > data
->n_frames
)
458 int idx
= ARRAY_SIZE(data
->frames_stats
) +
459 data
->n_frames
< ARRAY_SIZE(data
->frames_stats
) ?
460 _idx
- data
->n_frames
:
461 _idx
+ data
->n_frames
;
462 idx
%= ARRAY_SIZE(data
->frames_stats
);
463 /* Time stats are in us. */
464 return data
->frames_stats
[idx
].stats
[data
->stat_selector
] / 1000.0f
;
467 static float get_stat(void *_data
, int _idx
)
469 struct swapchain_data
*data
= (struct swapchain_data
*) _data
;
470 if ((ARRAY_SIZE(data
->frames_stats
) - _idx
) > data
->n_frames
)
472 int idx
= ARRAY_SIZE(data
->frames_stats
) +
473 data
->n_frames
< ARRAY_SIZE(data
->frames_stats
) ?
474 _idx
- data
->n_frames
:
475 _idx
+ data
->n_frames
;
476 idx
%= ARRAY_SIZE(data
->frames_stats
);
477 return data
->frames_stats
[idx
].stats
[data
->stat_selector
];
480 static void position_layer(struct swapchain_data
*data
)
483 struct device_data
*device_data
= data
->device
;
484 struct instance_data
*instance_data
= device_data
->instance
;
486 ImGui::SetNextWindowBgAlpha(0.5);
487 ImGui::SetNextWindowSize(data
->window_size
, ImGuiCond_Always
);
488 switch (instance_data
->params
.position
) {
489 case LAYER_POSITION_TOP_LEFT
:
490 ImGui::SetNextWindowPos(ImVec2(0, 0), ImGuiCond_Always
);
492 case LAYER_POSITION_TOP_RIGHT
:
493 ImGui::SetNextWindowPos(ImVec2(data
->width
- data
->window_size
.x
, 0),
496 case LAYER_POSITION_BOTTOM_LEFT
:
497 ImGui::SetNextWindowPos(ImVec2(0, data
->height
- data
->window_size
.y
),
500 case LAYER_POSITION_BOTTOM_RIGHT
:
501 ImGui::SetNextWindowPos(ImVec2(data
->width
- data
->window_size
.x
,
502 data
->height
- data
->window_size
.y
),
508 static void compute_swapchain_display(struct swapchain_data
*data
)
510 struct device_data
*device_data
= data
->device
;
511 struct instance_data
*instance_data
= device_data
->instance
;
513 ImGui::SetCurrentContext(data
->imgui_context
);
515 position_layer(data
);
516 ImGui::Begin("Mesa overlay");
517 ImGui::Text("Device: %s", device_data
->properties
.deviceName
);
519 const char *format_name
= vk_Format_to_str(data
->format
);
520 format_name
= format_name
? (format_name
+ strlen("VK_FORMAT_")) : "unknown";
521 ImGui::Text("Swapchain format: %s", format_name
);
522 ImGui::Text("Frames: %" PRIu64
, data
->n_frames
);
523 if (instance_data
->params
.enabled
[OVERLAY_PARAM_ENABLED_fps
])
524 ImGui::Text("FPS: %.2f" , data
->fps
);
526 /* Recompute min/max */
527 for (uint32_t s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++) {
528 data
->stats_min
.stats
[s
] = UINT64_MAX
;
529 data
->stats_max
.stats
[s
] = 0;
531 for (uint32_t f
= 0; f
< MIN2(data
->n_frames
, ARRAY_SIZE(data
->frames_stats
)); f
++) {
532 for (uint32_t s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++) {
533 data
->stats_min
.stats
[s
] = MIN2(data
->frames_stats
[f
].stats
[s
],
534 data
->stats_min
.stats
[s
]);
535 data
->stats_max
.stats
[s
] = MAX2(data
->frames_stats
[f
].stats
[s
],
536 data
->stats_max
.stats
[s
]);
539 for (uint32_t s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++) {
540 assert(data
->stats_min
.stats
[s
] != UINT64_MAX
);
543 for (uint32_t s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++) {
544 if (!instance_data
->params
.enabled
[s
] ||
545 s
== OVERLAY_PARAM_ENABLED_fps
)
549 snprintf(hash
, sizeof(hash
), "##%s", overlay_param_names
[s
]);
550 data
->stat_selector
= (enum overlay_param_enabled
) s
;
552 if (s
== OVERLAY_PARAM_ENABLED_frame_timing
||
553 s
== OVERLAY_PARAM_ENABLED_acquire_timing
) {
554 double min_time
= data
->stats_min
.stats
[s
] / 1000.0f
;
555 double max_time
= data
->stats_max
.stats
[s
] / 1000.0f
;
556 ImGui::PlotHistogram(hash
, get_time_stat
, data
,
557 ARRAY_SIZE(data
->frames_stats
), 0,
558 NULL
, min_time
, max_time
,
559 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
560 ImGui::Text("%s: %.3fms [%.3f, %.3f]", overlay_param_names
[s
],
561 get_time_stat(data
, ARRAY_SIZE(data
->frames_stats
) - 1),
564 ImGui::PlotHistogram(hash
, get_stat
, data
,
565 ARRAY_SIZE(data
->frames_stats
), 0,
567 data
->stats_min
.stats
[s
],
568 data
->stats_max
.stats
[s
],
569 ImVec2(ImGui::GetContentRegionAvailWidth(), 30));
570 ImGui::Text("%s: %.0f [%" PRIu64
", %" PRIu64
"]", overlay_param_names
[s
],
571 get_stat(data
, ARRAY_SIZE(data
->frames_stats
) - 1),
572 data
->stats_min
.stats
[s
], data
->stats_max
.stats
[s
]);
575 data
->window_size
= ImVec2(data
->window_size
.x
, ImGui::GetCursorPosY() + 10.0f
);
581 static uint32_t vk_memory_type(struct device_data
*data
,
582 VkMemoryPropertyFlags properties
,
585 VkPhysicalDeviceMemoryProperties prop
;
586 data
->instance
->vtable
.GetPhysicalDeviceMemoryProperties(data
->physical_device
, &prop
);
587 for (uint32_t i
= 0; i
< prop
.memoryTypeCount
; i
++)
588 if ((prop
.memoryTypes
[i
].propertyFlags
& properties
) == properties
&& type_bits
& (1<<i
))
590 return 0xFFFFFFFF; // Unable to find memoryType
593 static void ensure_swapchain_fonts(struct swapchain_data
*data
,
594 VkCommandBuffer command_buffer
)
596 if (data
->font_uploaded
)
599 data
->font_uploaded
= true;
601 struct device_data
*device_data
= data
->device
;
602 ImGuiIO
& io
= ImGui::GetIO();
603 unsigned char* pixels
;
605 io
.Fonts
->GetTexDataAsRGBA32(&pixels
, &width
, &height
);
606 size_t upload_size
= width
* height
* 4 * sizeof(char);
609 VkBufferCreateInfo buffer_info
= {};
610 buffer_info
.sType
= VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
;
611 buffer_info
.size
= upload_size
;
612 buffer_info
.usage
= VK_BUFFER_USAGE_TRANSFER_SRC_BIT
;
613 buffer_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
614 VK_CHECK(device_data
->vtable
.CreateBuffer(device_data
->device
, &buffer_info
,
615 NULL
, &data
->upload_font_buffer
));
616 VkMemoryRequirements upload_buffer_req
;
617 device_data
->vtable
.GetBufferMemoryRequirements(device_data
->device
,
618 data
->upload_font_buffer
,
620 VkMemoryAllocateInfo upload_alloc_info
= {};
621 upload_alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
622 upload_alloc_info
.allocationSize
= upload_buffer_req
.size
;
623 upload_alloc_info
.memoryTypeIndex
= vk_memory_type(device_data
,
624 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
,
625 upload_buffer_req
.memoryTypeBits
);
626 VK_CHECK(device_data
->vtable
.AllocateMemory(device_data
->device
,
629 &data
->upload_font_buffer_mem
));
630 VK_CHECK(device_data
->vtable
.BindBufferMemory(device_data
->device
,
631 data
->upload_font_buffer
,
632 data
->upload_font_buffer_mem
, 0));
634 /* Upload to Buffer */
636 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
,
637 data
->upload_font_buffer_mem
,
638 0, upload_size
, 0, (void**)(&map
)));
639 memcpy(map
, pixels
, upload_size
);
640 VkMappedMemoryRange range
[1] = {};
641 range
[0].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
642 range
[0].memory
= data
->upload_font_buffer_mem
;
643 range
[0].size
= upload_size
;
644 VK_CHECK(device_data
->vtable
.FlushMappedMemoryRanges(device_data
->device
, 1, range
));
645 device_data
->vtable
.UnmapMemory(device_data
->device
,
646 data
->upload_font_buffer_mem
);
648 /* Copy buffer to image */
649 VkImageMemoryBarrier copy_barrier
[1] = {};
650 copy_barrier
[0].sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
651 copy_barrier
[0].dstAccessMask
= VK_ACCESS_TRANSFER_WRITE_BIT
;
652 copy_barrier
[0].oldLayout
= VK_IMAGE_LAYOUT_UNDEFINED
;
653 copy_barrier
[0].newLayout
= VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
;
654 copy_barrier
[0].srcQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
655 copy_barrier
[0].dstQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
656 copy_barrier
[0].image
= data
->font_image
;
657 copy_barrier
[0].subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
658 copy_barrier
[0].subresourceRange
.levelCount
= 1;
659 copy_barrier
[0].subresourceRange
.layerCount
= 1;
660 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
661 VK_PIPELINE_STAGE_HOST_BIT
,
662 VK_PIPELINE_STAGE_TRANSFER_BIT
,
666 VkBufferImageCopy region
= {};
667 region
.imageSubresource
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
668 region
.imageSubresource
.layerCount
= 1;
669 region
.imageExtent
.width
= width
;
670 region
.imageExtent
.height
= height
;
671 region
.imageExtent
.depth
= 1;
672 device_data
->vtable
.CmdCopyBufferToImage(command_buffer
,
673 data
->upload_font_buffer
,
675 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
,
678 VkImageMemoryBarrier use_barrier
[1] = {};
679 use_barrier
[0].sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
680 use_barrier
[0].srcAccessMask
= VK_ACCESS_TRANSFER_WRITE_BIT
;
681 use_barrier
[0].dstAccessMask
= VK_ACCESS_SHADER_READ_BIT
;
682 use_barrier
[0].oldLayout
= VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
;
683 use_barrier
[0].newLayout
= VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
;
684 use_barrier
[0].srcQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
685 use_barrier
[0].dstQueueFamilyIndex
= VK_QUEUE_FAMILY_IGNORED
;
686 use_barrier
[0].image
= data
->font_image
;
687 use_barrier
[0].subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
688 use_barrier
[0].subresourceRange
.levelCount
= 1;
689 use_barrier
[0].subresourceRange
.layerCount
= 1;
690 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
691 VK_PIPELINE_STAGE_TRANSFER_BIT
,
692 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT
,
698 /* Store our identifier */
699 io
.Fonts
->TexID
= (ImTextureID
)(intptr_t)data
->font_image
;
702 static void CreateOrResizeBuffer(struct device_data
*data
,
704 VkDeviceMemory
*buffer_memory
,
705 VkDeviceSize
*buffer_size
,
706 size_t new_size
, VkBufferUsageFlagBits usage
)
708 if (*buffer
!= VK_NULL_HANDLE
)
709 data
->vtable
.DestroyBuffer(data
->device
, *buffer
, NULL
);
711 data
->vtable
.FreeMemory(data
->device
, *buffer_memory
, NULL
);
713 VkBufferCreateInfo buffer_info
= {};
714 buffer_info
.sType
= VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO
;
715 buffer_info
.size
= new_size
;
716 buffer_info
.usage
= usage
;
717 buffer_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
718 VK_CHECK(data
->vtable
.CreateBuffer(data
->device
, &buffer_info
, NULL
, buffer
));
720 VkMemoryRequirements req
;
721 data
->vtable
.GetBufferMemoryRequirements(data
->device
, *buffer
, &req
);
722 VkMemoryAllocateInfo alloc_info
= {};
723 alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
724 alloc_info
.allocationSize
= req
.size
;
725 alloc_info
.memoryTypeIndex
=
726 vk_memory_type(data
, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
, req
.memoryTypeBits
);
727 VK_CHECK(data
->vtable
.AllocateMemory(data
->device
, &alloc_info
, NULL
, buffer_memory
));
729 VK_CHECK(data
->vtable
.BindBufferMemory(data
->device
, *buffer
, *buffer_memory
, 0));
730 *buffer_size
= new_size
;
733 static void render_swapchain_display(struct swapchain_data
*data
, unsigned image_index
)
735 ImDrawData
* draw_data
= ImGui::GetDrawData();
736 if (draw_data
->TotalVtxCount
== 0)
739 struct device_data
*device_data
= data
->device
;
740 uint32_t idx
= data
->n_frames
% ARRAY_SIZE(data
->frame_data
);
741 VkCommandBuffer command_buffer
= data
->frame_data
[idx
].command_buffer
;
743 device_data
->vtable
.ResetCommandBuffer(command_buffer
, 0);
745 VkRenderPassBeginInfo render_pass_info
= {};
746 render_pass_info
.sType
= VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
;
747 render_pass_info
.renderPass
= data
->render_pass
;
748 render_pass_info
.framebuffer
= data
->framebuffers
[image_index
];
749 render_pass_info
.renderArea
.extent
.width
= data
->width
;
750 render_pass_info
.renderArea
.extent
.height
= data
->height
;
752 VkCommandBufferBeginInfo buffer_begin_info
= {};
753 buffer_begin_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
;
755 device_data
->vtable
.BeginCommandBuffer(command_buffer
, &buffer_begin_info
);
757 ensure_swapchain_fonts(data
, command_buffer
);
759 /* Bounce the image to display back to color attachment layout for
760 * rendering on top of it.
762 VkImageMemoryBarrier imb
;
763 imb
.sType
= VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
;
765 imb
.srcAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
766 imb
.dstAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
767 imb
.oldLayout
= VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
;
768 imb
.newLayout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
769 imb
.image
= data
->images
[image_index
];
770 imb
.subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
771 imb
.subresourceRange
.baseMipLevel
= 0;
772 imb
.subresourceRange
.levelCount
= 1;
773 imb
.subresourceRange
.baseArrayLayer
= 0;
774 imb
.subresourceRange
.layerCount
= 1;
775 imb
.srcQueueFamilyIndex
= device_data
->graphic_queue
->family_index
;
776 imb
.dstQueueFamilyIndex
= device_data
->graphic_queue
->family_index
;
777 device_data
->vtable
.CmdPipelineBarrier(command_buffer
,
778 VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT
,
779 VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT
,
780 0, /* dependency flags */
781 0, nullptr, /* memory barriers */
782 0, nullptr, /* buffer memory barriers */
783 1, &imb
); /* image memory barriers */
785 device_data
->vtable
.CmdBeginRenderPass(command_buffer
, &render_pass_info
,
786 VK_SUBPASS_CONTENTS_INLINE
);
788 /* Create/Resize vertex & index buffers */
789 size_t vertex_size
= draw_data
->TotalVtxCount
* sizeof(ImDrawVert
);
790 size_t index_size
= draw_data
->TotalIdxCount
* sizeof(ImDrawIdx
);
791 if (data
->frame_data
[idx
].vertex_buffer_size
< vertex_size
) {
792 CreateOrResizeBuffer(device_data
,
793 &data
->frame_data
[idx
].vertex_buffer
,
794 &data
->frame_data
[idx
].vertex_buffer_mem
,
795 &data
->frame_data
[idx
].vertex_buffer_size
,
796 vertex_size
, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT
);
798 if (data
->frame_data
[idx
].index_buffer_size
< index_size
) {
799 CreateOrResizeBuffer(device_data
,
800 &data
->frame_data
[idx
].index_buffer
,
801 &data
->frame_data
[idx
].index_buffer_mem
,
802 &data
->frame_data
[idx
].index_buffer_size
,
803 index_size
, VK_BUFFER_USAGE_INDEX_BUFFER_BIT
);
806 /* Upload vertex & index data */
807 VkBuffer vertex_buffer
= data
->frame_data
[idx
].vertex_buffer
;
808 VkDeviceMemory vertex_mem
= data
->frame_data
[idx
].vertex_buffer_mem
;
809 VkBuffer index_buffer
= data
->frame_data
[idx
].index_buffer
;
810 VkDeviceMemory index_mem
= data
->frame_data
[idx
].index_buffer_mem
;
811 ImDrawVert
* vtx_dst
= NULL
;
812 ImDrawIdx
* idx_dst
= NULL
;
813 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
, vertex_mem
,
814 0, vertex_size
, 0, (void**)(&vtx_dst
)));
815 VK_CHECK(device_data
->vtable
.MapMemory(device_data
->device
, index_mem
,
816 0, index_size
, 0, (void**)(&idx_dst
)));
817 for (int n
= 0; n
< draw_data
->CmdListsCount
; n
++)
819 const ImDrawList
* cmd_list
= draw_data
->CmdLists
[n
];
820 memcpy(vtx_dst
, cmd_list
->VtxBuffer
.Data
, cmd_list
->VtxBuffer
.Size
* sizeof(ImDrawVert
));
821 memcpy(idx_dst
, cmd_list
->IdxBuffer
.Data
, cmd_list
->IdxBuffer
.Size
* sizeof(ImDrawIdx
));
822 vtx_dst
+= cmd_list
->VtxBuffer
.Size
;
823 idx_dst
+= cmd_list
->IdxBuffer
.Size
;
825 VkMappedMemoryRange range
[2] = {};
826 range
[0].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
827 range
[0].memory
= vertex_mem
;
828 range
[0].size
= VK_WHOLE_SIZE
;
829 range
[1].sType
= VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
;
830 range
[1].memory
= index_mem
;
831 range
[1].size
= VK_WHOLE_SIZE
;
832 VK_CHECK(device_data
->vtable
.FlushMappedMemoryRanges(device_data
->device
, 2, range
));
833 device_data
->vtable
.UnmapMemory(device_data
->device
, vertex_mem
);
834 device_data
->vtable
.UnmapMemory(device_data
->device
, index_mem
);
836 /* Bind pipeline and descriptor sets */
837 device_data
->vtable
.CmdBindPipeline(command_buffer
, VK_PIPELINE_BIND_POINT_GRAPHICS
, data
->pipeline
);
838 VkDescriptorSet desc_set
[1] = { data
->descriptor_set
};
839 device_data
->vtable
.CmdBindDescriptorSets(command_buffer
, VK_PIPELINE_BIND_POINT_GRAPHICS
,
840 data
->pipeline_layout
, 0, 1, desc_set
, 0, NULL
);
842 /* Bind vertex & index buffers */
843 VkBuffer vertex_buffers
[1] = { vertex_buffer
};
844 VkDeviceSize vertex_offset
[1] = { 0 };
845 device_data
->vtable
.CmdBindVertexBuffers(command_buffer
, 0, 1, vertex_buffers
, vertex_offset
);
846 device_data
->vtable
.CmdBindIndexBuffer(command_buffer
, index_buffer
, 0, VK_INDEX_TYPE_UINT16
);
852 viewport
.width
= draw_data
->DisplaySize
.x
;
853 viewport
.height
= draw_data
->DisplaySize
.y
;
854 viewport
.minDepth
= 0.0f
;
855 viewport
.maxDepth
= 1.0f
;
856 device_data
->vtable
.CmdSetViewport(command_buffer
, 0, 1, &viewport
);
859 /* Setup scale and translation through push constants :
861 * Our visible imgui space lies from draw_data->DisplayPos (top left) to
862 * draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin
863 * is typically (0,0) for single viewport apps.
866 scale
[0] = 2.0f
/ draw_data
->DisplaySize
.x
;
867 scale
[1] = 2.0f
/ draw_data
->DisplaySize
.y
;
869 translate
[0] = -1.0f
- draw_data
->DisplayPos
.x
* scale
[0];
870 translate
[1] = -1.0f
- draw_data
->DisplayPos
.y
* scale
[1];
871 device_data
->vtable
.CmdPushConstants(command_buffer
, data
->pipeline_layout
,
872 VK_SHADER_STAGE_VERTEX_BIT
,
873 sizeof(float) * 0, sizeof(float) * 2, scale
);
874 device_data
->vtable
.CmdPushConstants(command_buffer
, data
->pipeline_layout
,
875 VK_SHADER_STAGE_VERTEX_BIT
,
876 sizeof(float) * 2, sizeof(float) * 2, translate
);
878 // Render the command lists:
881 ImVec2 display_pos
= draw_data
->DisplayPos
;
882 for (int n
= 0; n
< draw_data
->CmdListsCount
; n
++)
884 const ImDrawList
* cmd_list
= draw_data
->CmdLists
[n
];
885 for (int cmd_i
= 0; cmd_i
< cmd_list
->CmdBuffer
.Size
; cmd_i
++)
887 const ImDrawCmd
* pcmd
= &cmd_list
->CmdBuffer
[cmd_i
];
888 // Apply scissor/clipping rectangle
889 // FIXME: We could clamp width/height based on clamped min/max values.
891 scissor
.offset
.x
= (int32_t)(pcmd
->ClipRect
.x
- display_pos
.x
) > 0 ? (int32_t)(pcmd
->ClipRect
.x
- display_pos
.x
) : 0;
892 scissor
.offset
.y
= (int32_t)(pcmd
->ClipRect
.y
- display_pos
.y
) > 0 ? (int32_t)(pcmd
->ClipRect
.y
- display_pos
.y
) : 0;
893 scissor
.extent
.width
= (uint32_t)(pcmd
->ClipRect
.z
- pcmd
->ClipRect
.x
);
894 scissor
.extent
.height
= (uint32_t)(pcmd
->ClipRect
.w
- pcmd
->ClipRect
.y
+ 1); // FIXME: Why +1 here?
895 device_data
->vtable
.CmdSetScissor(command_buffer
, 0, 1, &scissor
);
898 device_data
->vtable
.CmdDrawIndexed(command_buffer
, pcmd
->ElemCount
, 1, idx_offset
, vtx_offset
, 0);
900 idx_offset
+= pcmd
->ElemCount
;
902 vtx_offset
+= cmd_list
->VtxBuffer
.Size
;
905 device_data
->vtable
.CmdEndRenderPass(command_buffer
);
906 device_data
->vtable
.EndCommandBuffer(command_buffer
);
908 if (data
->submission_semaphore
) {
909 device_data
->vtable
.DestroySemaphore(device_data
->device
,
910 data
->submission_semaphore
,
913 /* Submission semaphore */
914 VkSemaphoreCreateInfo semaphore_info
= {};
915 semaphore_info
.sType
= VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
;
916 VK_CHECK(device_data
->vtable
.CreateSemaphore(device_data
->device
, &semaphore_info
,
917 NULL
, &data
->submission_semaphore
));
919 VkSubmitInfo submit_info
= {};
920 VkPipelineStageFlags stage_wait
= VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT
;
921 submit_info
.sType
= VK_STRUCTURE_TYPE_SUBMIT_INFO
;
922 submit_info
.commandBufferCount
= 1;
923 submit_info
.pCommandBuffers
= &command_buffer
;
924 submit_info
.pWaitDstStageMask
= &stage_wait
;
925 submit_info
.signalSemaphoreCount
= 1;
926 submit_info
.pSignalSemaphores
= &data
->submission_semaphore
;
928 device_data
->vtable
.WaitForFences(device_data
->device
, 1, &data
->fence
, VK_TRUE
, UINT64_MAX
);
929 device_data
->vtable
.ResetFences(device_data
->device
, 1, &data
->fence
);
930 device_data
->vtable
.QueueSubmit(device_data
->graphic_queue
->queue
, 1, &submit_info
, data
->fence
);
933 static const uint32_t overlay_vert_spv
[] = {
934 #include "overlay.vert.spv.h"
936 static const uint32_t overlay_frag_spv
[] = {
937 #include "overlay.frag.spv.h"
940 static void setup_swapchain_data_pipeline(struct swapchain_data
*data
)
942 struct device_data
*device_data
= data
->device
;
943 VkShaderModule vert_module
, frag_module
;
945 /* Create shader modules */
946 VkShaderModuleCreateInfo vert_info
= {};
947 vert_info
.sType
= VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
;
948 vert_info
.codeSize
= sizeof(overlay_vert_spv
);
949 vert_info
.pCode
= overlay_vert_spv
;
950 VK_CHECK(device_data
->vtable
.CreateShaderModule(device_data
->device
,
951 &vert_info
, NULL
, &vert_module
));
952 VkShaderModuleCreateInfo frag_info
= {};
953 frag_info
.sType
= VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
;
954 frag_info
.codeSize
= sizeof(overlay_frag_spv
);
955 frag_info
.pCode
= (uint32_t*)overlay_frag_spv
;
956 VK_CHECK(device_data
->vtable
.CreateShaderModule(device_data
->device
,
957 &frag_info
, NULL
, &frag_module
));
960 VkSamplerCreateInfo sampler_info
= {};
961 sampler_info
.sType
= VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO
;
962 sampler_info
.magFilter
= VK_FILTER_LINEAR
;
963 sampler_info
.minFilter
= VK_FILTER_LINEAR
;
964 sampler_info
.mipmapMode
= VK_SAMPLER_MIPMAP_MODE_LINEAR
;
965 sampler_info
.addressModeU
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
966 sampler_info
.addressModeV
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
967 sampler_info
.addressModeW
= VK_SAMPLER_ADDRESS_MODE_REPEAT
;
968 sampler_info
.minLod
= -1000;
969 sampler_info
.maxLod
= 1000;
970 sampler_info
.maxAnisotropy
= 1.0f
;
971 VK_CHECK(device_data
->vtable
.CreateSampler(device_data
->device
, &sampler_info
,
972 NULL
, &data
->font_sampler
));
974 /* Descriptor pool */
975 VkDescriptorPoolSize sampler_pool_size
= {};
976 sampler_pool_size
.type
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
977 sampler_pool_size
.descriptorCount
= 1;
978 VkDescriptorPoolCreateInfo desc_pool_info
= {};
979 desc_pool_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
;
980 desc_pool_info
.maxSets
= 1;
981 desc_pool_info
.poolSizeCount
= 1;
982 desc_pool_info
.pPoolSizes
= &sampler_pool_size
;
983 VK_CHECK(device_data
->vtable
.CreateDescriptorPool(device_data
->device
,
985 NULL
, &data
->descriptor_pool
));
987 /* Descriptor layout */
988 VkSampler sampler
[1] = { data
->font_sampler
};
989 VkDescriptorSetLayoutBinding binding
[1] = {};
990 binding
[0].descriptorType
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
991 binding
[0].descriptorCount
= 1;
992 binding
[0].stageFlags
= VK_SHADER_STAGE_FRAGMENT_BIT
;
993 binding
[0].pImmutableSamplers
= sampler
;
994 VkDescriptorSetLayoutCreateInfo set_layout_info
= {};
995 set_layout_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
;
996 set_layout_info
.bindingCount
= 1;
997 set_layout_info
.pBindings
= binding
;
998 VK_CHECK(device_data
->vtable
.CreateDescriptorSetLayout(device_data
->device
,
1000 NULL
, &data
->descriptor_layout
));
1002 /* Descriptor set */
1003 VkDescriptorSetAllocateInfo alloc_info
= {};
1004 alloc_info
.sType
= VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
;
1005 alloc_info
.descriptorPool
= data
->descriptor_pool
;
1006 alloc_info
.descriptorSetCount
= 1;
1007 alloc_info
.pSetLayouts
= &data
->descriptor_layout
;
1008 VK_CHECK(device_data
->vtable
.AllocateDescriptorSets(device_data
->device
,
1010 &data
->descriptor_set
));
1012 /* Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full
1013 * 3d projection matrix
1015 VkPushConstantRange push_constants
[1] = {};
1016 push_constants
[0].stageFlags
= VK_SHADER_STAGE_VERTEX_BIT
;
1017 push_constants
[0].offset
= sizeof(float) * 0;
1018 push_constants
[0].size
= sizeof(float) * 4;
1019 VkPipelineLayoutCreateInfo layout_info
= {};
1020 layout_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
;
1021 layout_info
.setLayoutCount
= 1;
1022 layout_info
.pSetLayouts
= &data
->descriptor_layout
;
1023 layout_info
.pushConstantRangeCount
= 1;
1024 layout_info
.pPushConstantRanges
= push_constants
;
1025 VK_CHECK(device_data
->vtable
.CreatePipelineLayout(device_data
->device
,
1027 NULL
, &data
->pipeline_layout
));
1029 VkPipelineShaderStageCreateInfo stage
[2] = {};
1030 stage
[0].sType
= VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
;
1031 stage
[0].stage
= VK_SHADER_STAGE_VERTEX_BIT
;
1032 stage
[0].module
= vert_module
;
1033 stage
[0].pName
= "main";
1034 stage
[1].sType
= VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
;
1035 stage
[1].stage
= VK_SHADER_STAGE_FRAGMENT_BIT
;
1036 stage
[1].module
= frag_module
;
1037 stage
[1].pName
= "main";
1039 VkVertexInputBindingDescription binding_desc
[1] = {};
1040 binding_desc
[0].stride
= sizeof(ImDrawVert
);
1041 binding_desc
[0].inputRate
= VK_VERTEX_INPUT_RATE_VERTEX
;
1043 VkVertexInputAttributeDescription attribute_desc
[3] = {};
1044 attribute_desc
[0].location
= 0;
1045 attribute_desc
[0].binding
= binding_desc
[0].binding
;
1046 attribute_desc
[0].format
= VK_FORMAT_R32G32_SFLOAT
;
1047 attribute_desc
[0].offset
= IM_OFFSETOF(ImDrawVert
, pos
);
1048 attribute_desc
[1].location
= 1;
1049 attribute_desc
[1].binding
= binding_desc
[0].binding
;
1050 attribute_desc
[1].format
= VK_FORMAT_R32G32_SFLOAT
;
1051 attribute_desc
[1].offset
= IM_OFFSETOF(ImDrawVert
, uv
);
1052 attribute_desc
[2].location
= 2;
1053 attribute_desc
[2].binding
= binding_desc
[0].binding
;
1054 attribute_desc
[2].format
= VK_FORMAT_R8G8B8A8_UNORM
;
1055 attribute_desc
[2].offset
= IM_OFFSETOF(ImDrawVert
, col
);
1057 VkPipelineVertexInputStateCreateInfo vertex_info
= {};
1058 vertex_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
;
1059 vertex_info
.vertexBindingDescriptionCount
= 1;
1060 vertex_info
.pVertexBindingDescriptions
= binding_desc
;
1061 vertex_info
.vertexAttributeDescriptionCount
= 3;
1062 vertex_info
.pVertexAttributeDescriptions
= attribute_desc
;
1064 VkPipelineInputAssemblyStateCreateInfo ia_info
= {};
1065 ia_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO
;
1066 ia_info
.topology
= VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST
;
1068 VkPipelineViewportStateCreateInfo viewport_info
= {};
1069 viewport_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
;
1070 viewport_info
.viewportCount
= 1;
1071 viewport_info
.scissorCount
= 1;
1073 VkPipelineRasterizationStateCreateInfo raster_info
= {};
1074 raster_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO
;
1075 raster_info
.polygonMode
= VK_POLYGON_MODE_FILL
;
1076 raster_info
.cullMode
= VK_CULL_MODE_NONE
;
1077 raster_info
.frontFace
= VK_FRONT_FACE_COUNTER_CLOCKWISE
;
1078 raster_info
.lineWidth
= 1.0f
;
1080 VkPipelineMultisampleStateCreateInfo ms_info
= {};
1081 ms_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
;
1082 ms_info
.rasterizationSamples
= VK_SAMPLE_COUNT_1_BIT
;
1084 VkPipelineColorBlendAttachmentState color_attachment
[1] = {};
1085 color_attachment
[0].blendEnable
= VK_TRUE
;
1086 color_attachment
[0].srcColorBlendFactor
= VK_BLEND_FACTOR_SRC_ALPHA
;
1087 color_attachment
[0].dstColorBlendFactor
= VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA
;
1088 color_attachment
[0].colorBlendOp
= VK_BLEND_OP_ADD
;
1089 color_attachment
[0].srcAlphaBlendFactor
= VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA
;
1090 color_attachment
[0].dstAlphaBlendFactor
= VK_BLEND_FACTOR_ZERO
;
1091 color_attachment
[0].alphaBlendOp
= VK_BLEND_OP_ADD
;
1092 color_attachment
[0].colorWriteMask
= VK_COLOR_COMPONENT_R_BIT
|
1093 VK_COLOR_COMPONENT_G_BIT
| VK_COLOR_COMPONENT_B_BIT
| VK_COLOR_COMPONENT_A_BIT
;
1095 VkPipelineDepthStencilStateCreateInfo depth_info
= {};
1096 depth_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
;
1098 VkPipelineColorBlendStateCreateInfo blend_info
= {};
1099 blend_info
.sType
= VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO
;
1100 blend_info
.attachmentCount
= 1;
1101 blend_info
.pAttachments
= color_attachment
;
1103 VkDynamicState dynamic_states
[2] = { VK_DYNAMIC_STATE_VIEWPORT
, VK_DYNAMIC_STATE_SCISSOR
};
1104 VkPipelineDynamicStateCreateInfo dynamic_state
= {};
1105 dynamic_state
.sType
= VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO
;
1106 dynamic_state
.dynamicStateCount
= (uint32_t)IM_ARRAYSIZE(dynamic_states
);
1107 dynamic_state
.pDynamicStates
= dynamic_states
;
1109 VkGraphicsPipelineCreateInfo info
= {};
1110 info
.sType
= VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
;
1112 info
.stageCount
= 2;
1113 info
.pStages
= stage
;
1114 info
.pVertexInputState
= &vertex_info
;
1115 info
.pInputAssemblyState
= &ia_info
;
1116 info
.pViewportState
= &viewport_info
;
1117 info
.pRasterizationState
= &raster_info
;
1118 info
.pMultisampleState
= &ms_info
;
1119 info
.pDepthStencilState
= &depth_info
;
1120 info
.pColorBlendState
= &blend_info
;
1121 info
.pDynamicState
= &dynamic_state
;
1122 info
.layout
= data
->pipeline_layout
;
1123 info
.renderPass
= data
->render_pass
;
1125 device_data
->vtable
.CreateGraphicsPipelines(device_data
->device
, VK_NULL_HANDLE
,
1127 NULL
, &data
->pipeline
));
1129 device_data
->vtable
.DestroyShaderModule(device_data
->device
, vert_module
, NULL
);
1130 device_data
->vtable
.DestroyShaderModule(device_data
->device
, frag_module
, NULL
);
1132 ImGuiIO
& io
= ImGui::GetIO();
1133 unsigned char* pixels
;
1135 io
.Fonts
->GetTexDataAsRGBA32(&pixels
, &width
, &height
);
1138 VkImageCreateInfo image_info
= {};
1139 image_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
;
1140 image_info
.imageType
= VK_IMAGE_TYPE_2D
;
1141 image_info
.format
= VK_FORMAT_R8G8B8A8_UNORM
;
1142 image_info
.extent
.width
= width
;
1143 image_info
.extent
.height
= height
;
1144 image_info
.extent
.depth
= 1;
1145 image_info
.mipLevels
= 1;
1146 image_info
.arrayLayers
= 1;
1147 image_info
.samples
= VK_SAMPLE_COUNT_1_BIT
;
1148 image_info
.tiling
= VK_IMAGE_TILING_OPTIMAL
;
1149 image_info
.usage
= VK_IMAGE_USAGE_SAMPLED_BIT
| VK_IMAGE_USAGE_TRANSFER_DST_BIT
;
1150 image_info
.sharingMode
= VK_SHARING_MODE_EXCLUSIVE
;
1151 image_info
.initialLayout
= VK_IMAGE_LAYOUT_UNDEFINED
;
1152 VK_CHECK(device_data
->vtable
.CreateImage(device_data
->device
, &image_info
,
1153 NULL
, &data
->font_image
));
1154 VkMemoryRequirements font_image_req
;
1155 device_data
->vtable
.GetImageMemoryRequirements(device_data
->device
,
1156 data
->font_image
, &font_image_req
);
1157 VkMemoryAllocateInfo image_alloc_info
= {};
1158 image_alloc_info
.sType
= VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
;
1159 image_alloc_info
.allocationSize
= font_image_req
.size
;
1160 image_alloc_info
.memoryTypeIndex
= vk_memory_type(device_data
,
1161 VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT
,
1162 font_image_req
.memoryTypeBits
);
1163 VK_CHECK(device_data
->vtable
.AllocateMemory(device_data
->device
, &image_alloc_info
,
1164 NULL
, &data
->font_mem
));
1165 VK_CHECK(device_data
->vtable
.BindImageMemory(device_data
->device
,
1167 data
->font_mem
, 0));
1169 /* Font image view */
1170 VkImageViewCreateInfo view_info
= {};
1171 view_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
;
1172 view_info
.image
= data
->font_image
;
1173 view_info
.viewType
= VK_IMAGE_VIEW_TYPE_2D
;
1174 view_info
.format
= VK_FORMAT_R8G8B8A8_UNORM
;
1175 view_info
.subresourceRange
.aspectMask
= VK_IMAGE_ASPECT_COLOR_BIT
;
1176 view_info
.subresourceRange
.levelCount
= 1;
1177 view_info
.subresourceRange
.layerCount
= 1;
1178 VK_CHECK(device_data
->vtable
.CreateImageView(device_data
->device
, &view_info
,
1179 NULL
, &data
->font_image_view
));
1181 /* Descriptor set */
1182 VkDescriptorImageInfo desc_image
[1] = {};
1183 desc_image
[0].sampler
= data
->font_sampler
;
1184 desc_image
[0].imageView
= data
->font_image_view
;
1185 desc_image
[0].imageLayout
= VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
;
1186 VkWriteDescriptorSet write_desc
[1] = {};
1187 write_desc
[0].sType
= VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
;
1188 write_desc
[0].dstSet
= data
->descriptor_set
;
1189 write_desc
[0].descriptorCount
= 1;
1190 write_desc
[0].descriptorType
= VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
;
1191 write_desc
[0].pImageInfo
= desc_image
;
1192 device_data
->vtable
.UpdateDescriptorSets(device_data
->device
, 1, write_desc
, 0, NULL
);
1195 static void setup_swapchain_data(struct swapchain_data
*data
,
1196 const VkSwapchainCreateInfoKHR
*pCreateInfo
)
1198 data
->width
= pCreateInfo
->imageExtent
.width
;
1199 data
->height
= pCreateInfo
->imageExtent
.height
;
1200 data
->format
= pCreateInfo
->imageFormat
;
1202 data
->imgui_context
= ImGui::CreateContext();
1203 ImGui::SetCurrentContext(data
->imgui_context
);
1205 ImGui::GetIO().IniFilename
= NULL
;
1206 ImGui::GetIO().DisplaySize
= ImVec2((float)data
->width
, (float)data
->height
);
1208 struct device_data
*device_data
= data
->device
;
1211 VkAttachmentDescription attachment_desc
= {};
1212 attachment_desc
.format
= pCreateInfo
->imageFormat
;
1213 attachment_desc
.samples
= VK_SAMPLE_COUNT_1_BIT
;
1214 attachment_desc
.loadOp
= VK_ATTACHMENT_LOAD_OP_LOAD
;
1215 attachment_desc
.storeOp
= VK_ATTACHMENT_STORE_OP_STORE
;
1216 attachment_desc
.stencilLoadOp
= VK_ATTACHMENT_LOAD_OP_DONT_CARE
;
1217 attachment_desc
.stencilStoreOp
= VK_ATTACHMENT_STORE_OP_DONT_CARE
;
1218 attachment_desc
.initialLayout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
1219 attachment_desc
.finalLayout
= VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
;
1220 VkAttachmentReference color_attachment
= {};
1221 color_attachment
.attachment
= 0;
1222 color_attachment
.layout
= VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
;
1223 VkSubpassDescription subpass
= {};
1224 subpass
.pipelineBindPoint
= VK_PIPELINE_BIND_POINT_GRAPHICS
;
1225 subpass
.colorAttachmentCount
= 1;
1226 subpass
.pColorAttachments
= &color_attachment
;
1227 VkSubpassDependency dependency
= {};
1228 dependency
.srcSubpass
= VK_SUBPASS_EXTERNAL
;
1229 dependency
.dstSubpass
= 0;
1230 dependency
.srcStageMask
= VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
;
1231 dependency
.dstStageMask
= VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
;
1232 dependency
.srcAccessMask
= 0;
1233 dependency
.dstAccessMask
= VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT
;
1234 VkRenderPassCreateInfo render_pass_info
= {};
1235 render_pass_info
.sType
= VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
;
1236 render_pass_info
.attachmentCount
= 1;
1237 render_pass_info
.pAttachments
= &attachment_desc
;
1238 render_pass_info
.subpassCount
= 1;
1239 render_pass_info
.pSubpasses
= &subpass
;
1240 render_pass_info
.dependencyCount
= 1;
1241 render_pass_info
.pDependencies
= &dependency
;
1242 VK_CHECK(device_data
->vtable
.CreateRenderPass(device_data
->device
,
1244 NULL
, &data
->render_pass
));
1246 setup_swapchain_data_pipeline(data
);
1248 VK_CHECK(device_data
->vtable
.GetSwapchainImagesKHR(device_data
->device
,
1253 data
->images
= ralloc_array(data
, VkImage
, data
->n_images
);
1254 data
->image_views
= ralloc_array(data
, VkImageView
, data
->n_images
);
1255 data
->framebuffers
= ralloc_array(data
, VkFramebuffer
, data
->n_images
);
1257 VK_CHECK(device_data
->vtable
.GetSwapchainImagesKHR(device_data
->device
,
1263 VkImageViewCreateInfo view_info
= {};
1264 view_info
.sType
= VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
;
1265 view_info
.viewType
= VK_IMAGE_VIEW_TYPE_2D
;
1266 view_info
.format
= pCreateInfo
->imageFormat
;
1267 view_info
.components
.r
= VK_COMPONENT_SWIZZLE_R
;
1268 view_info
.components
.g
= VK_COMPONENT_SWIZZLE_G
;
1269 view_info
.components
.b
= VK_COMPONENT_SWIZZLE_B
;
1270 view_info
.components
.a
= VK_COMPONENT_SWIZZLE_A
;
1271 view_info
.subresourceRange
= { VK_IMAGE_ASPECT_COLOR_BIT
, 0, 1, 0, 1 };
1272 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1273 view_info
.image
= data
->images
[i
];
1274 VK_CHECK(device_data
->vtable
.CreateImageView(device_data
->device
,
1276 &data
->image_views
[i
]));
1280 VkImageView attachment
[1];
1281 VkFramebufferCreateInfo fb_info
= {};
1282 fb_info
.sType
= VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
;
1283 fb_info
.renderPass
= data
->render_pass
;
1284 fb_info
.attachmentCount
= 1;
1285 fb_info
.pAttachments
= attachment
;
1286 fb_info
.width
= data
->width
;
1287 fb_info
.height
= data
->height
;
1289 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1290 attachment
[0] = data
->image_views
[i
];
1291 VK_CHECK(device_data
->vtable
.CreateFramebuffer(device_data
->device
, &fb_info
,
1292 NULL
, &data
->framebuffers
[i
]));
1295 /* Command buffer */
1296 VkCommandPoolCreateInfo cmd_buffer_pool_info
= {};
1297 cmd_buffer_pool_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
;
1298 cmd_buffer_pool_info
.flags
= VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT
;
1299 cmd_buffer_pool_info
.queueFamilyIndex
= device_data
->graphic_queue
->family_index
;
1300 VK_CHECK(device_data
->vtable
.CreateCommandPool(device_data
->device
,
1301 &cmd_buffer_pool_info
,
1302 NULL
, &data
->command_pool
));
1304 VkCommandBuffer cmd_bufs
[ARRAY_SIZE(data
->frame_data
)];
1306 VkCommandBufferAllocateInfo cmd_buffer_info
= {};
1307 cmd_buffer_info
.sType
= VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
;
1308 cmd_buffer_info
.commandPool
= data
->command_pool
;
1309 cmd_buffer_info
.level
= VK_COMMAND_BUFFER_LEVEL_PRIMARY
;
1310 cmd_buffer_info
.commandBufferCount
= 2;
1311 VK_CHECK(device_data
->vtable
.AllocateCommandBuffers(device_data
->device
,
1314 for (uint32_t i
= 0; i
< ARRAY_SIZE(data
->frame_data
); i
++) {
1315 VK_CHECK(device_data
->set_device_loader_data(device_data
->device
,
1318 data
->frame_data
[i
].command_buffer
= cmd_bufs
[i
];
1321 /* Submission fence */
1322 VkFenceCreateInfo fence_info
= {};
1323 fence_info
.sType
= VK_STRUCTURE_TYPE_FENCE_CREATE_INFO
;
1324 fence_info
.flags
= VK_FENCE_CREATE_SIGNALED_BIT
;
1325 VK_CHECK(device_data
->vtable
.CreateFence(device_data
->device
, &fence_info
,
1326 NULL
, &data
->fence
));
1329 static void shutdown_swapchain_data(struct swapchain_data
*data
)
1331 struct device_data
*device_data
= data
->device
;
1333 for (uint32_t i
= 0; i
< data
->n_images
; i
++) {
1334 device_data
->vtable
.DestroyImageView(device_data
->device
, data
->image_views
[i
], NULL
);
1335 device_data
->vtable
.DestroyFramebuffer(device_data
->device
, data
->framebuffers
[i
], NULL
);
1338 device_data
->vtable
.DestroyRenderPass(device_data
->device
, data
->render_pass
, NULL
);
1340 for (uint32_t i
= 0; i
< ARRAY_SIZE(data
->frame_data
); i
++) {
1341 device_data
->vtable
.FreeCommandBuffers(device_data
->device
,
1343 1, &data
->frame_data
[i
].command_buffer
);
1344 if (data
->frame_data
[i
].vertex_buffer
)
1345 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->frame_data
[i
].vertex_buffer
, NULL
);
1346 if (data
->frame_data
[i
].index_buffer
)
1347 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->frame_data
[i
].index_buffer
, NULL
);
1348 if (data
->frame_data
[i
].vertex_buffer_mem
)
1349 device_data
->vtable
.FreeMemory(device_data
->device
, data
->frame_data
[i
].vertex_buffer_mem
, NULL
);
1350 if (data
->frame_data
[i
].index_buffer_mem
)
1351 device_data
->vtable
.FreeMemory(device_data
->device
, data
->frame_data
[i
].index_buffer_mem
, NULL
);
1353 device_data
->vtable
.DestroyCommandPool(device_data
->device
, data
->command_pool
, NULL
);
1355 device_data
->vtable
.DestroyFence(device_data
->device
, data
->fence
, NULL
);
1356 if (data
->submission_semaphore
)
1357 device_data
->vtable
.DestroySemaphore(device_data
->device
, data
->submission_semaphore
, NULL
);
1359 device_data
->vtable
.DestroyPipeline(device_data
->device
, data
->pipeline
, NULL
);
1360 device_data
->vtable
.DestroyPipelineLayout(device_data
->device
, data
->pipeline_layout
, NULL
);
1362 device_data
->vtable
.DestroyDescriptorPool(device_data
->device
,
1363 data
->descriptor_pool
, NULL
);
1364 device_data
->vtable
.DestroyDescriptorSetLayout(device_data
->device
,
1365 data
->descriptor_layout
, NULL
);
1367 device_data
->vtable
.DestroySampler(device_data
->device
, data
->font_sampler
, NULL
);
1368 device_data
->vtable
.DestroyImageView(device_data
->device
, data
->font_image_view
, NULL
);
1369 device_data
->vtable
.DestroyImage(device_data
->device
, data
->font_image
, NULL
);
1370 device_data
->vtable
.FreeMemory(device_data
->device
, data
->font_mem
, NULL
);
1372 device_data
->vtable
.DestroyBuffer(device_data
->device
, data
->upload_font_buffer
, NULL
);
1373 device_data
->vtable
.FreeMemory(device_data
->device
, data
->upload_font_buffer_mem
, NULL
);
1375 ImGui::DestroyContext(data
->imgui_context
);
1378 static void before_present(struct swapchain_data
*swapchain_data
,
1379 unsigned imageIndex
)
1381 snapshot_swapchain_frame(swapchain_data
);
1383 if (swapchain_data
->n_frames
> 0) {
1384 compute_swapchain_display(swapchain_data
);
1385 render_swapchain_display(swapchain_data
, imageIndex
);
1389 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateSwapchainKHR(
1391 const VkSwapchainCreateInfoKHR
* pCreateInfo
,
1392 const VkAllocationCallbacks
* pAllocator
,
1393 VkSwapchainKHR
* pSwapchain
)
1395 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1396 VkResult result
= device_data
->vtable
.CreateSwapchainKHR(device
, pCreateInfo
, pAllocator
, pSwapchain
);
1397 if (result
!= VK_SUCCESS
) return result
;
1399 struct swapchain_data
*swapchain_data
= new_swapchain_data(*pSwapchain
, device_data
);
1400 setup_swapchain_data(swapchain_data
, pCreateInfo
);
1404 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroySwapchainKHR(
1406 VkSwapchainKHR swapchain
,
1407 const VkAllocationCallbacks
* pAllocator
)
1409 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(swapchain
);
1411 shutdown_swapchain_data(swapchain_data
);
1412 swapchain_data
->device
->vtable
.DestroySwapchainKHR(device
, swapchain
, pAllocator
);
1413 destroy_swapchain_data(swapchain_data
);
1416 VKAPI_ATTR VkResult VKAPI_CALL
overlay_QueuePresentKHR(
1418 const VkPresentInfoKHR
* pPresentInfo
)
1420 struct queue_data
*queue_data
= FIND_QUEUE_DATA(queue
);
1421 struct device_data
*device_data
= queue_data
->device
;
1423 /* If we present on the graphic queue this layer is using to draw an
1424 * overlay, we don't need more than submitting the overlay draw prior to
1427 if (queue_data
== device_data
->graphic_queue
) {
1428 for (uint32_t i
= 0; i
< pPresentInfo
->swapchainCount
; i
++) {
1429 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pPresentInfo
->pSwapchains
[i
]);
1430 before_present(swapchain_data
, pPresentInfo
->pImageIndices
[i
]);
1432 return queue_data
->device
->vtable
.QueuePresentKHR(queue
, pPresentInfo
);
1435 /* Otherwise we need to do cross queue synchronization to tie the overlay
1436 * draw into the present queue.
1438 VkPresentInfoKHR present_info
= *pPresentInfo
;
1439 VkSemaphore
*semaphores
=
1440 (VkSemaphore
*)malloc(sizeof(VkSemaphore
) * (pPresentInfo
->waitSemaphoreCount
+ pPresentInfo
->swapchainCount
));
1441 for (uint32_t i
= 0; i
< pPresentInfo
->waitSemaphoreCount
; i
++)
1442 semaphores
[i
] = pPresentInfo
->pWaitSemaphores
[i
];
1443 for (uint32_t i
= 0; i
< pPresentInfo
->swapchainCount
; i
++) {
1444 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pPresentInfo
->pSwapchains
[i
]);
1445 before_present(swapchain_data
, pPresentInfo
->pImageIndices
[i
]);
1446 semaphores
[pPresentInfo
->waitSemaphoreCount
+ i
] = swapchain_data
->submission_semaphore
;
1448 present_info
.pWaitSemaphores
= semaphores
;
1449 present_info
.waitSemaphoreCount
= pPresentInfo
->waitSemaphoreCount
+ pPresentInfo
->swapchainCount
;
1450 VkResult result
= queue_data
->device
->vtable
.QueuePresentKHR(queue
, &present_info
);
1455 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AcquireNextImageKHR(
1457 VkSwapchainKHR swapchain
,
1459 VkSemaphore semaphore
,
1461 uint32_t* pImageIndex
)
1463 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(swapchain
);
1464 struct device_data
*device_data
= swapchain_data
->device
;
1466 uint64_t ts0
= os_time_get();
1467 VkResult result
= device_data
->vtable
.AcquireNextImageKHR(device
, swapchain
, timeout
,
1468 semaphore
, fence
, pImageIndex
);
1469 uint64_t ts1
= os_time_get();
1471 swapchain_data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_acquire_timing
] += ts1
- ts0
;
1472 swapchain_data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_acquire
]++;
1477 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AcquireNextImage2KHR(
1479 const VkAcquireNextImageInfoKHR
* pAcquireInfo
,
1480 uint32_t* pImageIndex
)
1482 struct swapchain_data
*swapchain_data
= FIND_SWAPCHAIN_DATA(pAcquireInfo
->swapchain
);
1483 struct device_data
*device_data
= swapchain_data
->device
;
1485 uint64_t ts0
= os_time_get();
1486 VkResult result
= device_data
->vtable
.AcquireNextImage2KHR(device
, pAcquireInfo
, pImageIndex
);
1487 uint64_t ts1
= os_time_get();
1489 swapchain_data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_acquire_timing
] += ts1
- ts0
;
1490 swapchain_data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_acquire
]++;
1495 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDraw(
1496 VkCommandBuffer commandBuffer
,
1497 uint32_t vertexCount
,
1498 uint32_t instanceCount
,
1499 uint32_t firstVertex
,
1500 uint32_t firstInstance
)
1502 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1503 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw
]++;
1504 struct device_data
*device_data
= cmd_buffer_data
->device
;
1505 device_data
->vtable
.CmdDraw(commandBuffer
, vertexCount
, instanceCount
,
1506 firstVertex
, firstInstance
);
1509 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexed(
1510 VkCommandBuffer commandBuffer
,
1511 uint32_t indexCount
,
1512 uint32_t instanceCount
,
1513 uint32_t firstIndex
,
1514 int32_t vertexOffset
,
1515 uint32_t firstInstance
)
1517 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1518 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed
]++;
1519 struct device_data
*device_data
= cmd_buffer_data
->device
;
1520 device_data
->vtable
.CmdDrawIndexed(commandBuffer
, indexCount
, instanceCount
,
1521 firstIndex
, vertexOffset
, firstInstance
);
1524 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndirect(
1525 VkCommandBuffer commandBuffer
,
1527 VkDeviceSize offset
,
1531 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1532 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indirect
]++;
1533 struct device_data
*device_data
= cmd_buffer_data
->device
;
1534 device_data
->vtable
.CmdDrawIndirect(commandBuffer
, buffer
, offset
, drawCount
, stride
);
1537 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexedIndirect(
1538 VkCommandBuffer commandBuffer
,
1540 VkDeviceSize offset
,
1544 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1545 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed_indirect
]++;
1546 struct device_data
*device_data
= cmd_buffer_data
->device
;
1547 device_data
->vtable
.CmdDrawIndexedIndirect(commandBuffer
, buffer
, offset
, drawCount
, stride
);
1550 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndirectCountKHR(
1551 VkCommandBuffer commandBuffer
,
1553 VkDeviceSize offset
,
1554 VkBuffer countBuffer
,
1555 VkDeviceSize countBufferOffset
,
1556 uint32_t maxDrawCount
,
1559 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1560 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indirect_count
]++;
1561 struct device_data
*device_data
= cmd_buffer_data
->device
;
1562 device_data
->vtable
.CmdDrawIndirectCountKHR(commandBuffer
, buffer
, offset
,
1563 countBuffer
, countBufferOffset
,
1564 maxDrawCount
, stride
);
1567 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDrawIndexedIndirectCountKHR(
1568 VkCommandBuffer commandBuffer
,
1570 VkDeviceSize offset
,
1571 VkBuffer countBuffer
,
1572 VkDeviceSize countBufferOffset
,
1573 uint32_t maxDrawCount
,
1576 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1577 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_draw_indexed_indirect_count
]++;
1578 struct device_data
*device_data
= cmd_buffer_data
->device
;
1579 device_data
->vtable
.CmdDrawIndexedIndirectCountKHR(commandBuffer
, buffer
, offset
,
1580 countBuffer
, countBufferOffset
,
1581 maxDrawCount
, stride
);
1584 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDispatch(
1585 VkCommandBuffer commandBuffer
,
1586 uint32_t groupCountX
,
1587 uint32_t groupCountY
,
1588 uint32_t groupCountZ
)
1590 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1591 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_dispatch
]++;
1592 struct device_data
*device_data
= cmd_buffer_data
->device
;
1593 device_data
->vtable
.CmdDispatch(commandBuffer
, groupCountX
, groupCountY
, groupCountZ
);
1596 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdDispatchIndirect(
1597 VkCommandBuffer commandBuffer
,
1599 VkDeviceSize offset
)
1601 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1602 cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_dispatch_indirect
]++;
1603 struct device_data
*device_data
= cmd_buffer_data
->device
;
1604 device_data
->vtable
.CmdDispatchIndirect(commandBuffer
, buffer
, offset
);
1607 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdBindPipeline(
1608 VkCommandBuffer commandBuffer
,
1609 VkPipelineBindPoint pipelineBindPoint
,
1610 VkPipeline pipeline
)
1612 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1613 switch (pipelineBindPoint
) {
1614 case VK_PIPELINE_BIND_POINT_GRAPHICS
: cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_graphics
]++; break;
1615 case VK_PIPELINE_BIND_POINT_COMPUTE
: cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_compute
]++; break;
1616 case VK_PIPELINE_BIND_POINT_RAY_TRACING_NV
: cmd_buffer_data
->stats
.stats
[OVERLAY_PARAM_ENABLED_pipeline_raytracing
]++; break;
1619 struct device_data
*device_data
= cmd_buffer_data
->device
;
1620 device_data
->vtable
.CmdBindPipeline(commandBuffer
, pipelineBindPoint
, pipeline
);
1623 VKAPI_ATTR VkResult VKAPI_CALL
overlay_BeginCommandBuffer(
1624 VkCommandBuffer commandBuffer
,
1625 const VkCommandBufferBeginInfo
* pBeginInfo
)
1627 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1628 struct device_data
*device_data
= cmd_buffer_data
->device
;
1630 return device_data
->vtable
.BeginCommandBuffer(commandBuffer
, pBeginInfo
);
1633 VKAPI_ATTR VkResult VKAPI_CALL
overlay_EndCommandBuffer(
1634 VkCommandBuffer commandBuffer
)
1636 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1637 struct device_data
*device_data
= cmd_buffer_data
->device
;
1639 if (cmd_buffer_data
->pipeline_query_pool
) {
1640 device_data
->vtable
.CmdEndQuery(commandBuffer
,
1641 cmd_buffer_data
->pipeline_query_pool
,
1642 cmd_buffer_data
->query_index
);
1645 return device_data
->vtable
.EndCommandBuffer(commandBuffer
);
1648 VKAPI_ATTR VkResult VKAPI_CALL
overlay_ResetCommandBuffer(
1649 VkCommandBuffer commandBuffer
,
1650 VkCommandBufferResetFlags flags
)
1652 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1653 struct device_data
*device_data
= cmd_buffer_data
->device
;
1655 memset(&cmd_buffer_data
->stats
, 0, sizeof(cmd_buffer_data
->stats
));
1657 return device_data
->vtable
.ResetCommandBuffer(commandBuffer
, flags
);
1660 VKAPI_ATTR
void VKAPI_CALL
overlay_CmdExecuteCommands(
1661 VkCommandBuffer commandBuffer
,
1662 uint32_t commandBufferCount
,
1663 const VkCommandBuffer
* pCommandBuffers
)
1665 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(commandBuffer
);
1666 struct device_data
*device_data
= cmd_buffer_data
->device
;
1668 /* Add the stats of the executed command buffers to the primary one. */
1669 for (uint32_t c
= 0; c
< commandBufferCount
; c
++) {
1670 struct command_buffer_data
*sec_cmd_buffer_data
= FIND_CMD_BUFFER_DATA(pCommandBuffers
[c
]);
1672 for (uint32_t s
= 0; s
< OVERLAY_PARAM_ENABLED_MAX
; s
++)
1673 cmd_buffer_data
->stats
.stats
[s
] += sec_cmd_buffer_data
->stats
.stats
[s
];
1676 device_data
->vtable
.CmdExecuteCommands(commandBuffer
, commandBufferCount
, pCommandBuffers
);
1679 VKAPI_ATTR VkResult VKAPI_CALL
overlay_AllocateCommandBuffers(
1681 const VkCommandBufferAllocateInfo
* pAllocateInfo
,
1682 VkCommandBuffer
* pCommandBuffers
)
1684 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1686 device_data
->vtable
.AllocateCommandBuffers(device
, pAllocateInfo
, pCommandBuffers
);
1687 if (result
!= VK_SUCCESS
)
1689 for (uint32_t i
= 0; i
< pAllocateInfo
->commandBufferCount
; i
++)
1690 new_command_buffer_data(pCommandBuffers
[i
], pAllocateInfo
->level
, device_data
);
1694 VKAPI_ATTR
void VKAPI_CALL
overlay_FreeCommandBuffers(VkDevice device
,
1695 VkCommandPool commandPool
,
1696 uint32_t commandBufferCount
,
1697 const VkCommandBuffer
* pCommandBuffers
)
1699 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1700 for (uint32_t i
= 0; i
< commandBufferCount
; i
++) {
1701 struct command_buffer_data
*cmd_buffer_data
= FIND_CMD_BUFFER_DATA(pCommandBuffers
[i
]);
1702 destroy_command_buffer_data(cmd_buffer_data
);
1704 device_data
->vtable
.FreeCommandBuffers(device
, commandPool
,
1705 commandBufferCount
, pCommandBuffers
);
1708 VKAPI_ATTR VkResult VKAPI_CALL
overlay_QueueSubmit(
1710 uint32_t submitCount
,
1711 const VkSubmitInfo
* pSubmits
,
1714 struct queue_data
*queue_data
= FIND_QUEUE_DATA(queue
);
1715 struct device_data
*device_data
= queue_data
->device
;
1717 device_data
->frame_stats
.stats
[OVERLAY_PARAM_ENABLED_submit
]++;
1719 for (uint32_t s
= 0; s
< submitCount
; s
++) {
1720 for (uint32_t c
= 0; c
< pSubmits
[s
].commandBufferCount
; c
++) {
1721 struct command_buffer_data
*cmd_buffer_data
=
1722 FIND_CMD_BUFFER_DATA(pSubmits
[s
].pCommandBuffers
[c
]);
1724 /* Merge the submitted command buffer stats into the device. */
1725 for (uint32_t st
= 0; st
< OVERLAY_PARAM_ENABLED_MAX
; st
++)
1726 device_data
->frame_stats
.stats
[st
] += cmd_buffer_data
->stats
.stats
[st
];
1730 return device_data
->vtable
.QueueSubmit(queue
, submitCount
, pSubmits
, fence
);
1733 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateDevice(
1734 VkPhysicalDevice physicalDevice
,
1735 const VkDeviceCreateInfo
* pCreateInfo
,
1736 const VkAllocationCallbacks
* pAllocator
,
1739 struct instance_data
*instance_data
= FIND_PHYSICAL_DEVICE_DATA(physicalDevice
);
1740 VkLayerDeviceCreateInfo
*chain_info
=
1741 get_device_chain_info(pCreateInfo
, VK_LAYER_LINK_INFO
);
1743 assert(chain_info
->u
.pLayerInfo
);
1744 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr
= chain_info
->u
.pLayerInfo
->pfnNextGetInstanceProcAddr
;
1745 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr
= chain_info
->u
.pLayerInfo
->pfnNextGetDeviceProcAddr
;
1746 PFN_vkCreateDevice fpCreateDevice
= (PFN_vkCreateDevice
)fpGetInstanceProcAddr(NULL
, "vkCreateDevice");
1747 if (fpCreateDevice
== NULL
) {
1748 return VK_ERROR_INITIALIZATION_FAILED
;
1751 // Advance the link info for the next element on the chain
1752 chain_info
->u
.pLayerInfo
= chain_info
->u
.pLayerInfo
->pNext
;
1754 VkResult result
= fpCreateDevice(physicalDevice
, pCreateInfo
, pAllocator
, pDevice
);
1755 if (result
!= VK_SUCCESS
) return result
;
1757 struct device_data
*device_data
= new_device_data(*pDevice
, instance_data
);
1758 device_data
->physical_device
= physicalDevice
;
1759 vk_load_device_commands(*pDevice
, fpGetDeviceProcAddr
, &device_data
->vtable
);
1761 instance_data
->vtable
.GetPhysicalDeviceProperties(device_data
->physical_device
,
1762 &device_data
->properties
);
1764 VkLayerDeviceCreateInfo
*load_data_info
=
1765 get_device_chain_info(pCreateInfo
, VK_LOADER_DATA_CALLBACK
);
1766 device_data
->set_device_loader_data
= load_data_info
->u
.pfnSetDeviceLoaderData
;
1768 device_map_queues(device_data
, pCreateInfo
);
1773 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroyDevice(
1775 const VkAllocationCallbacks
* pAllocator
)
1777 struct device_data
*device_data
= FIND_DEVICE_DATA(device
);
1778 device_unmap_queues(device_data
);
1779 device_data
->vtable
.DestroyDevice(device
, pAllocator
);
1780 destroy_device_data(device_data
);
1783 VKAPI_ATTR VkResult VKAPI_CALL
overlay_CreateInstance(
1784 const VkInstanceCreateInfo
* pCreateInfo
,
1785 const VkAllocationCallbacks
* pAllocator
,
1786 VkInstance
* pInstance
)
1788 VkLayerInstanceCreateInfo
*chain_info
=
1789 get_instance_chain_info(pCreateInfo
, VK_LAYER_LINK_INFO
);
1791 assert(chain_info
->u
.pLayerInfo
);
1792 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr
=
1793 chain_info
->u
.pLayerInfo
->pfnNextGetInstanceProcAddr
;
1794 PFN_vkCreateInstance fpCreateInstance
=
1795 (PFN_vkCreateInstance
)fpGetInstanceProcAddr(NULL
, "vkCreateInstance");
1796 if (fpCreateInstance
== NULL
) {
1797 return VK_ERROR_INITIALIZATION_FAILED
;
1800 // Advance the link info for the next element on the chain
1801 chain_info
->u
.pLayerInfo
= chain_info
->u
.pLayerInfo
->pNext
;
1803 VkResult result
= fpCreateInstance(pCreateInfo
, pAllocator
, pInstance
);
1804 if (result
!= VK_SUCCESS
) return result
;
1806 struct instance_data
*instance_data
= new_instance_data(*pInstance
);
1807 vk_load_instance_commands(instance_data
->instance
,
1808 fpGetInstanceProcAddr
,
1809 &instance_data
->vtable
);
1810 instance_data_map_physical_devices(instance_data
, true);
1812 parse_overlay_env(&instance_data
->params
, getenv("VK_LAYER_MESA_OVERLAY_CONFIG"));
1817 VKAPI_ATTR
void VKAPI_CALL
overlay_DestroyInstance(
1818 VkInstance instance
,
1819 const VkAllocationCallbacks
* pAllocator
)
1821 struct instance_data
*instance_data
= FIND_INSTANCE_DATA(instance
);
1822 instance_data_map_physical_devices(instance_data
, false);
1823 instance_data
->vtable
.DestroyInstance(instance
, pAllocator
);
1824 destroy_instance_data(instance_data
);
1827 static const struct {
1830 } name_to_funcptr_map
[] = {
1831 { "vkGetDeviceProcAddr", (void *) vkGetDeviceProcAddr
},
1832 #define ADD_HOOK(fn) { "vk" # fn, (void *) overlay_ ## fn }
1833 ADD_HOOK(AllocateCommandBuffers
),
1834 ADD_HOOK(FreeCommandBuffers
),
1835 ADD_HOOK(ResetCommandBuffer
),
1836 ADD_HOOK(BeginCommandBuffer
),
1837 ADD_HOOK(EndCommandBuffer
),
1838 ADD_HOOK(CmdExecuteCommands
),
1841 ADD_HOOK(CmdDrawIndexed
),
1842 ADD_HOOK(CmdDrawIndexedIndirect
),
1843 ADD_HOOK(CmdDispatch
),
1844 ADD_HOOK(CmdDispatchIndirect
),
1845 ADD_HOOK(CmdDrawIndirectCountKHR
),
1846 ADD_HOOK(CmdDrawIndexedIndirectCountKHR
),
1848 ADD_HOOK(CmdBindPipeline
),
1850 ADD_HOOK(CreateSwapchainKHR
),
1851 ADD_HOOK(QueuePresentKHR
),
1852 ADD_HOOK(DestroySwapchainKHR
),
1853 ADD_HOOK(AcquireNextImageKHR
),
1854 ADD_HOOK(AcquireNextImage2KHR
),
1856 ADD_HOOK(QueueSubmit
),
1857 ADD_HOOK(CreateInstance
),
1858 ADD_HOOK(DestroyInstance
),
1859 ADD_HOOK(CreateDevice
),
1860 ADD_HOOK(DestroyDevice
),
1864 static void *find_ptr(const char *name
)
1866 for (uint32_t i
= 0; i
< ARRAY_SIZE(name_to_funcptr_map
); i
++) {
1867 if (strcmp(name
, name_to_funcptr_map
[i
].name
) == 0)
1868 return name_to_funcptr_map
[i
].ptr
;
1874 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL
vkGetDeviceProcAddr(VkDevice dev
,
1875 const char *funcName
)
1877 void *ptr
= find_ptr(funcName
);
1878 if (ptr
) return reinterpret_cast<PFN_vkVoidFunction
>(ptr
);
1880 if (dev
== NULL
) return NULL
;
1882 struct device_data
*device_data
= FIND_DEVICE_DATA(dev
);
1883 if (device_data
->vtable
.GetDeviceProcAddr
== NULL
) return NULL
;
1884 return device_data
->vtable
.GetDeviceProcAddr(dev
, funcName
);
1887 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL
vkGetInstanceProcAddr(VkInstance instance
,
1888 const char *funcName
)
1890 void *ptr
= find_ptr(funcName
);
1891 if (ptr
) return reinterpret_cast<PFN_vkVoidFunction
>(ptr
);
1893 if (instance
== NULL
) return NULL
;
1895 struct instance_data
*instance_data
= FIND_INSTANCE_DATA(instance
);
1896 if (instance_data
->vtable
.GetInstanceProcAddr
== NULL
) return NULL
;
1897 return instance_data
->vtable
.GetInstanceProcAddr(instance
, funcName
);