2 * Copyright (c) 2015-2016 The Khronos Group Inc.
3 * Copyright (c) 2015-2016 Valve Corporation
4 * Copyright (c) 2015-2016 LunarG, Inc.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * Author: Chia-I Wu <olv@lunarg.com>
19 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
20 * Author: Ian Elliott <ian@LunarG.com>
21 * Author: Ian Elliott <ianelliott@google.com>
22 * Author: Jon Ashburn <jon@lunarg.com>
23 * Author: Gwan-gyeong Mun <elongbug@gmail.com>
24 * Author: Tony Barbour <tony@LunarG.com>
25 * Author: Bill Hollings <bill.hollings@brenwill.com>
36 #if defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XCB_KHR)
37 #include <X11/Xutil.h>
38 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
39 #include <linux/input.h>
43 #pragma comment(linker, "/subsystem:windows")
44 #define APP_NAME_STR_LEN 80
48 #include "vulkan_wrapper.h"
50 #include <vulkan/vulkan.h>
53 #include <vulkan/vk_sdk_platform.h>
55 #include "object_type_string_helper.h"
59 #define MILLION 1000000L
60 #define BILLION 1000000000L
62 #define DEMO_TEXTURE_COUNT 1
63 #define APP_SHORT_NAME "vkcube"
64 #define APP_LONG_NAME "Vulkan Cube"
66 // Allow a maximum of two outstanding presentation operations.
69 #define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
71 #if defined(NDEBUG) && defined(__GNUC__)
72 #define U_ASSERT_ONLY __attribute__((unused))
78 #define UNUSED __attribute__((unused))
84 bool in_callback = false;
85 #define ERR_EXIT(err_msg, err_class) \
87 if (!demo->suppress_popups) MessageBox(NULL, err_msg, err_class, MB_OK); \
90 void DbgMsg(char *fmt, ...) {
98 #elif defined __ANDROID__
99 #include <android/log.h>
100 #define ERR_EXIT(err_msg, err_class) \
102 ((void)__android_log_print(ANDROID_LOG_INFO, "Vulkan Cube", err_msg)); \
105 #ifdef VARARGS_WORKS_ON_ANDROID
106 void DbgMsg(const char *fmt, ...) {
109 __android_log_print(ANDROID_LOG_INFO, "Vulkan Cube", fmt, va);
112 #else // VARARGS_WORKS_ON_ANDROID
113 #define DbgMsg(fmt, ...) \
115 ((void)__android_log_print(ANDROID_LOG_INFO, "Vulkan Cube", fmt, ##__VA_ARGS__)); \
117 #endif // VARARGS_WORKS_ON_ANDROID
119 #define ERR_EXIT(err_msg, err_class) \
121 printf("%s\n", err_msg); \
125 void DbgMsg(char *fmt, ...) {
134 #define GET_INSTANCE_PROC_ADDR(inst, entrypoint) \
136 demo->fp##entrypoint = (PFN_vk##entrypoint)vkGetInstanceProcAddr(inst, "vk" #entrypoint); \
137 if (demo->fp##entrypoint == NULL) { \
138 ERR_EXIT("vkGetInstanceProcAddr failed to find vk" #entrypoint, "vkGetInstanceProcAddr Failure"); \
142 static PFN_vkGetDeviceProcAddr g_gdpa = NULL;
144 #define GET_DEVICE_PROC_ADDR(dev, entrypoint) \
146 if (!g_gdpa) g_gdpa = (PFN_vkGetDeviceProcAddr)vkGetInstanceProcAddr(demo->inst, "vkGetDeviceProcAddr"); \
147 demo->fp##entrypoint = (PFN_vk##entrypoint)g_gdpa(dev, "vk" #entrypoint); \
148 if (demo->fp##entrypoint == NULL) { \
149 ERR_EXIT("vkGetDeviceProcAddr failed to find vk" #entrypoint, "vkGetDeviceProcAddr Failure"); \
154 * structure to track all objects related to a texture.
156 struct texture_object {
161 VkImageLayout imageLayout;
163 VkMemoryAllocateInfo mem_alloc;
166 int32_t tex_width, tex_height;
169 static char *tex_files[] = {"lunarg.ppm"};
171 static int validation_error = 0;
173 struct vktexcube_vs_uniform {
174 // Must start with MVP
176 float position[12 * 3][4];
177 float attr[12 * 3][4];
180 //--------------------------------------------------------------------------------------
181 // Mesh and VertexFormat Data
182 //--------------------------------------------------------------------------------------
184 static const float g_vertex_buffer_data[] = {
185 -1.0f,-1.0f,-1.0f, // -X side
192 -1.0f,-1.0f,-1.0f, // -Z side
199 -1.0f,-1.0f,-1.0f, // -Y side
206 -1.0f, 1.0f,-1.0f, // +Y side
213 1.0f, 1.0f,-1.0f, // +X side
220 -1.0f, 1.0f, 1.0f, // +Z side
228 static const float g_uv_buffer_data[] = {
229 0.0f, 1.0f, // -X side
236 1.0f, 1.0f, // -Z side
243 1.0f, 0.0f, // -Y side
250 1.0f, 0.0f, // +Y side
257 1.0f, 0.0f, // +X side
264 0.0f, 0.0f, // +Z side
273 void dumpMatrix(const char *note, mat4x4 MVP) {
276 printf("%s: \n", note);
277 for (i = 0; i < 4; i++) {
278 printf("%f, %f, %f, %f\n", MVP[i][0], MVP[i][1], MVP[i][2], MVP[i][3]);
284 void dumpVec4(const char *note, vec4 vector) {
285 printf("%s: \n", note);
286 printf("%f, %f, %f, %f\n", vector[0], vector[1], vector[2], vector[3]);
294 VkCommandBuffer graphics_to_present_cmd;
296 VkBuffer uniform_buffer;
297 VkDeviceMemory uniform_memory;
298 VkFramebuffer framebuffer;
299 VkDescriptorSet descriptor_set;
300 } SwapchainImageResources;
303 #if defined(VK_USE_PLATFORM_WIN32_KHR)
304 #define APP_NAME_STR_LEN 80
305 HINSTANCE connection; // hInstance - Windows Instance
306 char name[APP_NAME_STR_LEN]; // Name to put on the window/icon
307 HWND window; // hWnd - window handle
308 POINT minsize; // minimum window size
309 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
312 Atom xlib_wm_delete_window;
313 #elif defined(VK_USE_PLATFORM_XCB_KHR)
315 xcb_connection_t *connection;
316 xcb_screen_t *screen;
317 xcb_window_t xcb_window;
318 xcb_intern_atom_reply_t *atom_wm_delete_window;
319 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
320 struct wl_display *display;
321 struct wl_registry *registry;
322 struct wl_compositor *compositor;
323 struct wl_surface *window;
324 struct wl_shell *shell;
325 struct wl_shell_surface *shell_surface;
326 struct wl_seat *seat;
327 struct wl_pointer *pointer;
328 struct wl_keyboard *keyboard;
329 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
330 struct ANativeWindow *window;
331 #elif (defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK))
334 VkSurfaceKHR surface;
336 bool use_staging_buffer;
337 bool separate_present_queue;
340 bool VK_KHR_incremental_present_enabled;
342 bool VK_GOOGLE_display_timing_enabled;
343 bool syncd_with_actual_presents;
344 uint64_t refresh_duration;
345 uint64_t refresh_duration_multiplier;
346 uint64_t target_IPD; // image present duration (inverse of frame rate)
347 uint64_t prev_desired_present_time;
348 uint32_t next_present_id;
349 uint32_t last_early_id; // 0 if no early images
350 uint32_t last_late_id; // 0 if no late images
353 VkPhysicalDevice gpu;
355 VkQueue graphics_queue;
356 VkQueue present_queue;
357 uint32_t graphics_queue_family_index;
358 uint32_t present_queue_family_index;
359 VkSemaphore image_acquired_semaphores[FRAME_LAG];
360 VkSemaphore draw_complete_semaphores[FRAME_LAG];
361 VkSemaphore image_ownership_semaphores[FRAME_LAG];
362 VkPhysicalDeviceProperties gpu_props;
363 VkQueueFamilyProperties *queue_props;
364 VkPhysicalDeviceMemoryProperties memory_properties;
366 uint32_t enabled_extension_count;
367 uint32_t enabled_layer_count;
368 char *extension_names[64];
369 char *enabled_layers[64];
373 VkColorSpaceKHR color_space;
375 PFN_vkGetPhysicalDeviceSurfaceSupportKHR fpGetPhysicalDeviceSurfaceSupportKHR;
376 PFN_vkGetPhysicalDeviceSurfaceCapabilitiesKHR fpGetPhysicalDeviceSurfaceCapabilitiesKHR;
377 PFN_vkGetPhysicalDeviceSurfaceFormatsKHR fpGetPhysicalDeviceSurfaceFormatsKHR;
378 PFN_vkGetPhysicalDeviceSurfacePresentModesKHR fpGetPhysicalDeviceSurfacePresentModesKHR;
379 PFN_vkCreateSwapchainKHR fpCreateSwapchainKHR;
380 PFN_vkDestroySwapchainKHR fpDestroySwapchainKHR;
381 PFN_vkGetSwapchainImagesKHR fpGetSwapchainImagesKHR;
382 PFN_vkAcquireNextImageKHR fpAcquireNextImageKHR;
383 PFN_vkQueuePresentKHR fpQueuePresentKHR;
384 PFN_vkGetRefreshCycleDurationGOOGLE fpGetRefreshCycleDurationGOOGLE;
385 PFN_vkGetPastPresentationTimingGOOGLE fpGetPastPresentationTimingGOOGLE;
386 uint32_t swapchainImageCount;
387 VkSwapchainKHR swapchain;
388 SwapchainImageResources *swapchain_image_resources;
389 VkPresentModeKHR presentMode;
390 VkFence fences[FRAME_LAG];
393 VkCommandPool cmd_pool;
394 VkCommandPool present_cmd_pool;
400 VkMemoryAllocateInfo mem_alloc;
405 struct texture_object textures[DEMO_TEXTURE_COUNT];
406 struct texture_object staging_texture;
408 VkCommandBuffer cmd; // Buffer for initialization commands
409 VkPipelineLayout pipeline_layout;
410 VkDescriptorSetLayout desc_layout;
411 VkPipelineCache pipelineCache;
412 VkRenderPass render_pass;
415 mat4x4 projection_matrix;
420 float spin_increment;
423 VkShaderModule vert_shader_module;
424 VkShaderModule frag_shader_module;
426 VkDescriptorPool desc_pool;
432 bool validate_checks_disabled;
434 bool suppress_popups;
436 PFN_vkCreateDebugUtilsMessengerEXT CreateDebugUtilsMessengerEXT;
437 PFN_vkDestroyDebugUtilsMessengerEXT DestroyDebugUtilsMessengerEXT;
438 PFN_vkSubmitDebugUtilsMessageEXT SubmitDebugUtilsMessageEXT;
439 PFN_vkCmdBeginDebugUtilsLabelEXT CmdBeginDebugUtilsLabelEXT;
440 PFN_vkCmdEndDebugUtilsLabelEXT CmdEndDebugUtilsLabelEXT;
441 PFN_vkCmdInsertDebugUtilsLabelEXT CmdInsertDebugUtilsLabelEXT;
442 PFN_vkSetDebugUtilsObjectNameEXT SetDebugUtilsObjectNameEXT;
443 VkDebugUtilsMessengerEXT dbg_messenger;
445 uint32_t current_buffer;
446 uint32_t queue_family_count;
449 VKAPI_ATTR VkBool32 VKAPI_CALL debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
450 VkDebugUtilsMessageTypeFlagsEXT messageType,
451 const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData,
453 char prefix[64] = "";
454 char *message = (char *)malloc(strlen(pCallbackData->pMessage) + 5000);
456 struct demo *demo = (struct demo *)pUserData;
458 if (demo->use_break) {
466 if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) {
467 strcat(prefix, "VERBOSE : ");
468 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) {
469 strcat(prefix, "INFO : ");
470 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
471 strcat(prefix, "WARNING : ");
472 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
473 strcat(prefix, "ERROR : ");
476 if (messageType & VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT) {
477 strcat(prefix, "GENERAL");
479 if (messageType & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT) {
480 strcat(prefix, "VALIDATION");
481 validation_error = 1;
483 if (messageType & VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT) {
484 if (messageType & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT) {
487 strcat(prefix, "PERFORMANCE");
491 sprintf(message, "%s - Message Id Number: %d | Message Id Name: %s\n\t%s\n", prefix, pCallbackData->messageIdNumber,
492 pCallbackData->pMessageIdName, pCallbackData->pMessage);
493 if (pCallbackData->objectCount > 0) {
494 char tmp_message[500];
495 sprintf(tmp_message, "\n\tObjects - %d\n", pCallbackData->objectCount);
496 strcat(message, tmp_message);
497 for (uint32_t object = 0; object < pCallbackData->objectCount; ++object) {
498 if (NULL != pCallbackData->pObjects[object].pObjectName && strlen(pCallbackData->pObjects[object].pObjectName) > 0) {
499 sprintf(tmp_message, "\t\tObject[%d] - %s, Handle %p, Name \"%s\"\n", object,
500 string_VkObjectType(pCallbackData->pObjects[object].objectType),
501 (void *)(pCallbackData->pObjects[object].objectHandle), pCallbackData->pObjects[object].pObjectName);
503 sprintf(tmp_message, "\t\tObject[%d] - %s, Handle %p\n", object,
504 string_VkObjectType(pCallbackData->pObjects[object].objectType),
505 (void *)(pCallbackData->pObjects[object].objectHandle));
507 strcat(message, tmp_message);
510 if (pCallbackData->cmdBufLabelCount > 0) {
511 char tmp_message[500];
512 sprintf(tmp_message, "\n\tCommand Buffer Labels - %d\n", pCallbackData->cmdBufLabelCount);
513 strcat(message, tmp_message);
514 for (uint32_t cmd_buf_label = 0; cmd_buf_label < pCallbackData->cmdBufLabelCount; ++cmd_buf_label) {
515 sprintf(tmp_message, "\t\tLabel[%d] - %s { %f, %f, %f, %f}\n", cmd_buf_label,
516 pCallbackData->pCmdBufLabels[cmd_buf_label].pLabelName, pCallbackData->pCmdBufLabels[cmd_buf_label].color[0],
517 pCallbackData->pCmdBufLabels[cmd_buf_label].color[1], pCallbackData->pCmdBufLabels[cmd_buf_label].color[2],
518 pCallbackData->pCmdBufLabels[cmd_buf_label].color[3]);
519 strcat(message, tmp_message);
526 if (!demo->suppress_popups)
527 MessageBox(NULL, message, "Alert", MB_OK);
530 #elif defined(ANDROID)
532 if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) {
533 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message);
534 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
535 __android_log_print(ANDROID_LOG_WARN, APP_SHORT_NAME, "%s", message);
536 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
537 __android_log_print(ANDROID_LOG_ERROR, APP_SHORT_NAME, "%s", message);
538 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) {
539 __android_log_print(ANDROID_LOG_VERBOSE, APP_SHORT_NAME, "%s", message);
541 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message);
546 printf("%s\n", message);
553 // Don't bail out, but keep going.
557 bool ActualTimeLate(uint64_t desired, uint64_t actual, uint64_t rdur) {
558 // The desired time was the earliest time that the present should have
559 // occured. In almost every case, the actual time should be later than the
560 // desired time. We should only consider the actual time "late" if it is
561 // after "desired + rdur".
562 if (actual <= desired) {
563 // The actual time was before or equal to the desired time. This will
564 // probably never happen, but in case it does, return false since the
565 // present was obviously NOT late.
568 uint64_t deadline = desired + rdur;
569 if (actual > deadline) {
575 bool CanPresentEarlier(uint64_t earliest, uint64_t actual, uint64_t margin, uint64_t rdur) {
576 if (earliest < actual) {
577 // Consider whether this present could have occured earlier. Make sure
578 // that earliest time was at least 2msec earlier than actual time, and
579 // that the margin was at least 2msec:
580 uint64_t diff = actual - earliest;
581 if ((diff >= (2 * MILLION)) && (margin >= (2 * MILLION))) {
582 // This present could have occured earlier because both: 1) the
583 // earliest time was at least 2 msec before actual time, and 2) the
584 // margin was at least 2msec.
591 // Forward declaration:
592 static void demo_resize(struct demo *demo);
594 static bool memory_type_from_properties(struct demo *demo, uint32_t typeBits, VkFlags requirements_mask, uint32_t *typeIndex) {
595 // Search memtypes to find first index with those properties
596 for (uint32_t i = 0; i < VK_MAX_MEMORY_TYPES; i++) {
597 if ((typeBits & 1) == 1) {
598 // Type is available, does it match user properties?
599 if ((demo->memory_properties.memoryTypes[i].propertyFlags & requirements_mask) == requirements_mask) {
606 // No memory types matched, return failure
610 static void demo_flush_init_cmd(struct demo *demo) {
611 VkResult U_ASSERT_ONLY err;
613 // This function could get called twice if the texture uses a staging buffer
614 // In that case the second call should be ignored
615 if (demo->cmd == VK_NULL_HANDLE) return;
617 err = vkEndCommandBuffer(demo->cmd);
621 VkFenceCreateInfo fence_ci = {.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO, .pNext = NULL, .flags = 0};
622 err = vkCreateFence(demo->device, &fence_ci, NULL, &fence);
625 const VkCommandBuffer cmd_bufs[] = {demo->cmd};
626 VkSubmitInfo submit_info = {.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO,
628 .waitSemaphoreCount = 0,
629 .pWaitSemaphores = NULL,
630 .pWaitDstStageMask = NULL,
631 .commandBufferCount = 1,
632 .pCommandBuffers = cmd_bufs,
633 .signalSemaphoreCount = 0,
634 .pSignalSemaphores = NULL};
636 err = vkQueueSubmit(demo->graphics_queue, 1, &submit_info, fence);
639 err = vkWaitForFences(demo->device, 1, &fence, VK_TRUE, UINT64_MAX);
642 vkFreeCommandBuffers(demo->device, demo->cmd_pool, 1, cmd_bufs);
643 vkDestroyFence(demo->device, fence, NULL);
644 demo->cmd = VK_NULL_HANDLE;
647 static void demo_set_image_layout(struct demo *demo, VkImage image, VkImageAspectFlags aspectMask, VkImageLayout old_image_layout,
648 VkImageLayout new_image_layout, VkAccessFlagBits srcAccessMask, VkPipelineStageFlags src_stages,
649 VkPipelineStageFlags dest_stages) {
652 VkImageMemoryBarrier image_memory_barrier = {.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
654 .srcAccessMask = srcAccessMask,
656 .srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
657 .dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED,
658 .oldLayout = old_image_layout,
659 .newLayout = new_image_layout,
661 .subresourceRange = {aspectMask, 0, 1, 0, 1}};
663 switch (new_image_layout) {
664 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
665 /* Make sure anything that was copying from this image has completed */
666 image_memory_barrier.dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
669 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
670 image_memory_barrier.dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
673 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
674 image_memory_barrier.dstAccessMask = VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT;
677 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
678 image_memory_barrier.dstAccessMask = VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT;
681 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
682 image_memory_barrier.dstAccessMask = VK_ACCESS_TRANSFER_READ_BIT;
685 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR:
686 image_memory_barrier.dstAccessMask = VK_ACCESS_MEMORY_READ_BIT;
690 image_memory_barrier.dstAccessMask = 0;
694 VkImageMemoryBarrier *pmemory_barrier = &image_memory_barrier;
696 vkCmdPipelineBarrier(demo->cmd, src_stages, dest_stages, 0, 0, NULL, 0, NULL, 1, pmemory_barrier);
699 static void demo_draw_build_cmd(struct demo *demo, VkCommandBuffer cmd_buf) {
700 VkDebugUtilsLabelEXT label;
701 memset(&label, 0, sizeof(label));
702 const VkCommandBufferBeginInfo cmd_buf_info = {
703 .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO,
705 .flags = VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT,
706 .pInheritanceInfo = NULL,
708 const VkClearValue clear_values[2] = {
709 [0] = {.color.float32 = {0.2f, 0.2f, 0.2f, 0.2f}},
710 [1] = {.depthStencil = {1.0f, 0}},
712 const VkRenderPassBeginInfo rp_begin = {
713 .sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO,
715 .renderPass = demo->render_pass,
716 .framebuffer = demo->swapchain_image_resources[demo->current_buffer].framebuffer,
717 .renderArea.offset.x = 0,
718 .renderArea.offset.y = 0,
719 .renderArea.extent.width = demo->width,
720 .renderArea.extent.height = demo->height,
721 .clearValueCount = 2,
722 .pClearValues = clear_values,
724 VkResult U_ASSERT_ONLY err;
726 err = vkBeginCommandBuffer(cmd_buf, &cmd_buf_info);
728 if (demo->validate) {
729 // Set a name for the command buffer
730 VkDebugUtilsObjectNameInfoEXT cmd_buf_name = {
731 .sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT,
733 .objectType = VK_OBJECT_TYPE_COMMAND_BUFFER,
734 .objectHandle = (uint64_t)cmd_buf,
735 .pObjectName = "CubeDrawCommandBuf",
737 demo->SetDebugUtilsObjectNameEXT(demo->device, &cmd_buf_name);
739 label.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
741 label.pLabelName = "DrawBegin";
742 label.color[0] = 0.4f;
743 label.color[1] = 0.3f;
744 label.color[2] = 0.2f;
745 label.color[3] = 0.1f;
746 demo->CmdBeginDebugUtilsLabelEXT(cmd_buf, &label);
750 vkCmdBeginRenderPass(cmd_buf, &rp_begin, VK_SUBPASS_CONTENTS_INLINE);
752 if (demo->validate) {
753 label.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
755 label.pLabelName = "InsideRenderPass";
756 label.color[0] = 8.4f;
757 label.color[1] = 7.3f;
758 label.color[2] = 6.2f;
759 label.color[3] = 7.1f;
760 demo->CmdBeginDebugUtilsLabelEXT(cmd_buf, &label);
763 vkCmdBindPipeline(cmd_buf, VK_PIPELINE_BIND_POINT_GRAPHICS, demo->pipeline);
764 vkCmdBindDescriptorSets(cmd_buf, VK_PIPELINE_BIND_POINT_GRAPHICS, demo->pipeline_layout, 0, 1,
765 &demo->swapchain_image_resources[demo->current_buffer].descriptor_set, 0, NULL);
767 memset(&viewport, 0, sizeof(viewport));
768 viewport.height = (float)demo->height;
769 viewport.width = (float)demo->width;
770 viewport.minDepth = (float)0.0f;
771 viewport.maxDepth = (float)1.0f;
772 vkCmdSetViewport(cmd_buf, 0, 1, &viewport);
775 memset(&scissor, 0, sizeof(scissor));
776 scissor.extent.width = demo->width;
777 scissor.extent.height = demo->height;
778 scissor.offset.x = 0;
779 scissor.offset.y = 0;
780 vkCmdSetScissor(cmd_buf, 0, 1, &scissor);
782 if (demo->validate) {
783 label.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
785 label.pLabelName = "ActualDraw";
786 label.color[0] = -0.4f;
787 label.color[1] = -0.3f;
788 label.color[2] = -0.2f;
789 label.color[3] = -0.1f;
790 demo->CmdBeginDebugUtilsLabelEXT(cmd_buf, &label);
793 vkCmdDraw(cmd_buf, 12 * 3, 1, 0, 0);
794 if (demo->validate) {
795 demo->CmdEndDebugUtilsLabelEXT(cmd_buf);
798 // Note that ending the renderpass changes the image's layout from
799 // COLOR_ATTACHMENT_OPTIMAL to PRESENT_SRC_KHR
800 vkCmdEndRenderPass(cmd_buf);
801 if (demo->validate) {
802 demo->CmdEndDebugUtilsLabelEXT(cmd_buf);
805 if (demo->separate_present_queue) {
806 // We have to transfer ownership from the graphics queue family to the
807 // present queue family to be able to present. Note that we don't have
808 // to transfer from present queue family back to graphics queue family at
809 // the start of the next frame because we don't care about the image's
810 // contents at that point.
811 VkImageMemoryBarrier image_ownership_barrier = {.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
815 .oldLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
816 .newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
817 .srcQueueFamilyIndex = demo->graphics_queue_family_index,
818 .dstQueueFamilyIndex = demo->present_queue_family_index,
819 .image = demo->swapchain_image_resources[demo->current_buffer].image,
820 .subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1}};
822 vkCmdPipelineBarrier(cmd_buf, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, 0, 0, NULL, 0,
823 NULL, 1, &image_ownership_barrier);
825 if (demo->validate) {
826 demo->CmdEndDebugUtilsLabelEXT(cmd_buf);
828 err = vkEndCommandBuffer(cmd_buf);
832 void demo_build_image_ownership_cmd(struct demo *demo, int i) {
833 VkResult U_ASSERT_ONLY err;
835 const VkCommandBufferBeginInfo cmd_buf_info = {
836 .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO,
838 .flags = VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT,
839 .pInheritanceInfo = NULL,
841 err = vkBeginCommandBuffer(demo->swapchain_image_resources[i].graphics_to_present_cmd, &cmd_buf_info);
844 VkImageMemoryBarrier image_ownership_barrier = {.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
848 .oldLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
849 .newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
850 .srcQueueFamilyIndex = demo->graphics_queue_family_index,
851 .dstQueueFamilyIndex = demo->present_queue_family_index,
852 .image = demo->swapchain_image_resources[i].image,
853 .subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1}};
855 vkCmdPipelineBarrier(demo->swapchain_image_resources[i].graphics_to_present_cmd, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
856 VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, 0, 0, NULL, 0, NULL, 1, &image_ownership_barrier);
857 err = vkEndCommandBuffer(demo->swapchain_image_resources[i].graphics_to_present_cmd);
861 void demo_update_data_buffer(struct demo *demo) {
862 mat4x4 MVP, Model, VP;
863 int matrixSize = sizeof(MVP);
865 VkResult U_ASSERT_ONLY err;
867 mat4x4_mul(VP, demo->projection_matrix, demo->view_matrix);
869 // Rotate around the Y axis
870 mat4x4_dup(Model, demo->model_matrix);
871 mat4x4_rotate(demo->model_matrix, Model, 0.0f, 1.0f, 0.0f, (float)degreesToRadians(demo->spin_angle));
872 mat4x4_mul(MVP, VP, demo->model_matrix);
874 err = vkMapMemory(demo->device, demo->swapchain_image_resources[demo->current_buffer].uniform_memory, 0, VK_WHOLE_SIZE, 0,
878 memcpy(pData, (const void *)&MVP[0][0], matrixSize);
880 vkUnmapMemory(demo->device, demo->swapchain_image_resources[demo->current_buffer].uniform_memory);
883 void DemoUpdateTargetIPD(struct demo *demo) {
884 // Look at what happened to previous presents, and make appropriate
885 // adjustments in timing:
886 VkResult U_ASSERT_ONLY err;
887 VkPastPresentationTimingGOOGLE *past = NULL;
890 err = demo->fpGetPastPresentationTimingGOOGLE(demo->device, demo->swapchain, &count, NULL);
893 past = (VkPastPresentationTimingGOOGLE *)malloc(sizeof(VkPastPresentationTimingGOOGLE) * count);
895 err = demo->fpGetPastPresentationTimingGOOGLE(demo->device, demo->swapchain, &count, past);
900 bool calibrate_next = false;
901 for (uint32_t i = 0; i < count; i++) {
902 if (!demo->syncd_with_actual_presents) {
903 // This is the first time that we've received an
904 // actualPresentTime for this swapchain. In order to not
905 // perceive these early frames as "late", we need to sync-up
906 // our future desiredPresentTime's with the
907 // actualPresentTime(s) that we're receiving now.
908 calibrate_next = true;
910 // So that we don't suspect any pending presents as late,
911 // record them all as suspected-late presents:
912 demo->last_late_id = demo->next_present_id - 1;
913 demo->last_early_id = 0;
914 demo->syncd_with_actual_presents = true;
916 } else if (CanPresentEarlier(past[i].earliestPresentTime, past[i].actualPresentTime, past[i].presentMargin,
917 demo->refresh_duration)) {
918 // This image could have been presented earlier. We don't want
919 // to decrease the target_IPD until we've seen early presents
920 // for at least two seconds.
921 if (demo->last_early_id == past[i].presentID) {
922 // We've now seen two seconds worth of early presents.
923 // Flag it as such, and reset the counter:
925 demo->last_early_id = 0;
926 } else if (demo->last_early_id == 0) {
927 // This is the first early present we've seen.
928 // Calculate the presentID for two seconds from now.
929 uint64_t lastEarlyTime = past[i].actualPresentTime + (2 * BILLION);
930 uint32_t howManyPresents = (uint32_t)((lastEarlyTime - past[i].actualPresentTime) / demo->target_IPD);
931 demo->last_early_id = past[i].presentID + howManyPresents;
933 // We are in the midst of a set of early images,
934 // and so we won't do anything.
937 demo->last_late_id = 0;
938 } else if (ActualTimeLate(past[i].desiredPresentTime, past[i].actualPresentTime, demo->refresh_duration)) {
939 // This image was presented after its desired time. Since
940 // there's a delay between calling vkQueuePresentKHR and when
941 // we get the timing data, several presents may have been late.
942 // Thus, we need to threat all of the outstanding presents as
943 // being likely late, so that we only increase the target_IPD
944 // once for all of those presents.
945 if ((demo->last_late_id == 0) || (demo->last_late_id < past[i].presentID)) {
947 // Record the last suspected-late present:
948 demo->last_late_id = demo->next_present_id - 1;
950 // We are in the midst of a set of likely-late images,
951 // and so we won't do anything.
954 demo->last_early_id = 0;
956 // Since this image was not presented early or late, reset
957 // any sets of early or late presentIDs:
960 calibrate_next = true;
961 demo->last_early_id = 0;
962 demo->last_late_id = 0;
967 // Since we've seen at least two-seconds worth of presnts that
968 // could have occured earlier than desired, let's decrease the
969 // target_IPD (i.e. increase the frame rate):
971 // TODO(ianelliott): Try to calculate a better target_IPD based
972 // on the most recently-seen present (this is overly-simplistic).
973 demo->refresh_duration_multiplier--;
974 if (demo->refresh_duration_multiplier == 0) {
975 // This should never happen, but in case it does, don't
977 demo->refresh_duration_multiplier = 1;
979 demo->target_IPD = demo->refresh_duration * demo->refresh_duration_multiplier;
982 // Since we found a new instance of a late present, we want to
983 // increase the target_IPD (i.e. decrease the frame rate):
985 // TODO(ianelliott): Try to calculate a better target_IPD based
986 // on the most recently-seen present (this is overly-simplistic).
987 demo->refresh_duration_multiplier++;
988 demo->target_IPD = demo->refresh_duration * demo->refresh_duration_multiplier;
991 if (calibrate_next) {
992 int64_t multiple = demo->next_present_id - past[count - 1].presentID;
993 demo->prev_desired_present_time = (past[count - 1].actualPresentTime + (multiple * demo->target_IPD));
999 static void demo_draw(struct demo *demo) {
1000 VkResult U_ASSERT_ONLY err;
1002 // Ensure no more than FRAME_LAG renderings are outstanding
1003 vkWaitForFences(demo->device, 1, &demo->fences[demo->frame_index], VK_TRUE, UINT64_MAX);
1004 vkResetFences(demo->device, 1, &demo->fences[demo->frame_index]);
1007 // Get the index of the next available swapchain image:
1009 demo->fpAcquireNextImageKHR(demo->device, demo->swapchain, UINT64_MAX,
1010 demo->image_acquired_semaphores[demo->frame_index], VK_NULL_HANDLE, &demo->current_buffer);
1012 if (err == VK_ERROR_OUT_OF_DATE_KHR) {
1013 // demo->swapchain is out of date (e.g. the window was resized) and
1014 // must be recreated:
1016 } else if (err == VK_SUBOPTIMAL_KHR) {
1017 // demo->swapchain is not as optimal as it could be, but the platform's
1018 // presentation engine will still present the image correctly.
1023 } while (err != VK_SUCCESS);
1025 demo_update_data_buffer(demo);
1027 if (demo->VK_GOOGLE_display_timing_enabled) {
1028 // Look at what happened to previous presents, and make appropriate
1029 // adjustments in timing:
1030 DemoUpdateTargetIPD(demo);
1032 // Note: a real application would position its geometry to that it's in
1033 // the correct locatoin for when the next image is presented. It might
1034 // also wait, so that there's less latency between any input and when
1035 // the next image is rendered/presented. This demo program is so
1036 // simple that it doesn't do either of those.
1039 // Wait for the image acquired semaphore to be signaled to ensure
1040 // that the image won't be rendered to until the presentation
1041 // engine has fully released ownership to the application, and it is
1042 // okay to render to the image.
1043 VkPipelineStageFlags pipe_stage_flags;
1044 VkSubmitInfo submit_info;
1045 submit_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
1046 submit_info.pNext = NULL;
1047 submit_info.pWaitDstStageMask = &pipe_stage_flags;
1048 pipe_stage_flags = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
1049 submit_info.waitSemaphoreCount = 1;
1050 submit_info.pWaitSemaphores = &demo->image_acquired_semaphores[demo->frame_index];
1051 submit_info.commandBufferCount = 1;
1052 submit_info.pCommandBuffers = &demo->swapchain_image_resources[demo->current_buffer].cmd;
1053 submit_info.signalSemaphoreCount = 1;
1054 submit_info.pSignalSemaphores = &demo->draw_complete_semaphores[demo->frame_index];
1055 err = vkQueueSubmit(demo->graphics_queue, 1, &submit_info, demo->fences[demo->frame_index]);
1058 if (demo->separate_present_queue) {
1059 // If we are using separate queues, change image ownership to the
1060 // present queue before presenting, waiting for the draw complete
1061 // semaphore and signalling the ownership released semaphore when finished
1062 VkFence nullFence = VK_NULL_HANDLE;
1063 pipe_stage_flags = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
1064 submit_info.waitSemaphoreCount = 1;
1065 submit_info.pWaitSemaphores = &demo->draw_complete_semaphores[demo->frame_index];
1066 submit_info.commandBufferCount = 1;
1067 submit_info.pCommandBuffers = &demo->swapchain_image_resources[demo->current_buffer].graphics_to_present_cmd;
1068 submit_info.signalSemaphoreCount = 1;
1069 submit_info.pSignalSemaphores = &demo->image_ownership_semaphores[demo->frame_index];
1070 err = vkQueueSubmit(demo->present_queue, 1, &submit_info, nullFence);
1074 // If we are using separate queues we have to wait for image ownership,
1075 // otherwise wait for draw complete
1076 VkPresentInfoKHR present = {
1077 .sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR,
1079 .waitSemaphoreCount = 1,
1080 .pWaitSemaphores = (demo->separate_present_queue) ? &demo->image_ownership_semaphores[demo->frame_index]
1081 : &demo->draw_complete_semaphores[demo->frame_index],
1082 .swapchainCount = 1,
1083 .pSwapchains = &demo->swapchain,
1084 .pImageIndices = &demo->current_buffer,
1087 VkRectLayerKHR rect;
1088 VkPresentRegionKHR region;
1089 VkPresentRegionsKHR regions;
1090 if (demo->VK_KHR_incremental_present_enabled) {
1091 // If using VK_KHR_incremental_present, we provide a hint of the region
1092 // that contains changed content relative to the previously-presented
1093 // image. The implementation can use this hint in order to save
1094 // work/power (by only copying the region in the hint). The
1095 // implementation is free to ignore the hint though, and so we must
1096 // ensure that the entire image has the correctly-drawn content.
1097 uint32_t eighthOfWidth = demo->width / 8;
1098 uint32_t eighthOfHeight = demo->height / 8;
1100 rect.offset.x = eighthOfWidth;
1101 rect.offset.y = eighthOfHeight;
1102 rect.extent.width = eighthOfWidth * 6;
1103 rect.extent.height = eighthOfHeight * 6;
1106 region.rectangleCount = 1;
1107 region.pRectangles = ▭
1109 regions.sType = VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR;
1110 regions.pNext = present.pNext;
1111 regions.swapchainCount = present.swapchainCount;
1112 regions.pRegions = ®ion;
1113 present.pNext = ®ions;
1116 if (demo->VK_GOOGLE_display_timing_enabled) {
1117 VkPresentTimeGOOGLE ptime;
1118 if (demo->prev_desired_present_time == 0) {
1119 // This must be the first present for this swapchain.
1121 // We don't know where we are relative to the presentation engine's
1122 // display's refresh cycle. We also don't know how long rendering
1123 // takes. Let's make a grossly-simplified assumption that the
1124 // desiredPresentTime should be half way between now and
1125 // now+target_IPD. We will adjust over time.
1126 uint64_t curtime = getTimeInNanoseconds();
1128 // Since we didn't find out the current time, don't give a
1129 // desiredPresentTime:
1130 ptime.desiredPresentTime = 0;
1132 ptime.desiredPresentTime = curtime + (demo->target_IPD >> 1);
1135 ptime.desiredPresentTime = (demo->prev_desired_present_time + demo->target_IPD);
1137 ptime.presentID = demo->next_present_id++;
1138 demo->prev_desired_present_time = ptime.desiredPresentTime;
1140 VkPresentTimesInfoGOOGLE present_time = {
1141 .sType = VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE,
1142 .pNext = present.pNext,
1143 .swapchainCount = present.swapchainCount,
1146 if (demo->VK_GOOGLE_display_timing_enabled) {
1147 present.pNext = &present_time;
1151 err = demo->fpQueuePresentKHR(demo->present_queue, &present);
1152 demo->frame_index += 1;
1153 demo->frame_index %= FRAME_LAG;
1155 if (err == VK_ERROR_OUT_OF_DATE_KHR) {
1156 // demo->swapchain is out of date (e.g. the window was resized) and
1157 // must be recreated:
1159 } else if (err == VK_SUBOPTIMAL_KHR) {
1160 // demo->swapchain is not as optimal as it could be, but the platform's
1161 // presentation engine will still present the image correctly.
1167 static void demo_prepare_buffers(struct demo *demo) {
1168 VkResult U_ASSERT_ONLY err;
1169 VkSwapchainKHR oldSwapchain = demo->swapchain;
1171 // Check the surface capabilities and formats
1172 VkSurfaceCapabilitiesKHR surfCapabilities;
1173 err = demo->fpGetPhysicalDeviceSurfaceCapabilitiesKHR(demo->gpu, demo->surface, &surfCapabilities);
1176 uint32_t presentModeCount;
1177 err = demo->fpGetPhysicalDeviceSurfacePresentModesKHR(demo->gpu, demo->surface, &presentModeCount, NULL);
1179 VkPresentModeKHR *presentModes = (VkPresentModeKHR *)malloc(presentModeCount * sizeof(VkPresentModeKHR));
1180 assert(presentModes);
1181 err = demo->fpGetPhysicalDeviceSurfacePresentModesKHR(demo->gpu, demo->surface, &presentModeCount, presentModes);
1184 VkExtent2D swapchainExtent;
1185 // width and height are either both 0xFFFFFFFF, or both not 0xFFFFFFFF.
1186 if (surfCapabilities.currentExtent.width == 0xFFFFFFFF) {
1187 // If the surface size is undefined, the size is set to the size
1188 // of the images requested, which must fit within the minimum and
1190 swapchainExtent.width = demo->width;
1191 swapchainExtent.height = demo->height;
1193 if (swapchainExtent.width < surfCapabilities.minImageExtent.width) {
1194 swapchainExtent.width = surfCapabilities.minImageExtent.width;
1195 } else if (swapchainExtent.width > surfCapabilities.maxImageExtent.width) {
1196 swapchainExtent.width = surfCapabilities.maxImageExtent.width;
1199 if (swapchainExtent.height < surfCapabilities.minImageExtent.height) {
1200 swapchainExtent.height = surfCapabilities.minImageExtent.height;
1201 } else if (swapchainExtent.height > surfCapabilities.maxImageExtent.height) {
1202 swapchainExtent.height = surfCapabilities.maxImageExtent.height;
1205 // If the surface size is defined, the swap chain size must match
1206 swapchainExtent = surfCapabilities.currentExtent;
1207 demo->width = surfCapabilities.currentExtent.width;
1208 demo->height = surfCapabilities.currentExtent.height;
1211 if (demo->width == 0 || demo->height == 0) {
1212 demo->is_minimized = true;
1215 demo->is_minimized = false;
1218 // The FIFO present mode is guaranteed by the spec to be supported
1219 // and to have no tearing. It's a great default present mode to use.
1220 VkPresentModeKHR swapchainPresentMode = VK_PRESENT_MODE_FIFO_KHR;
1222 // There are times when you may wish to use another present mode. The
1223 // following code shows how to select them, and the comments provide some
1224 // reasons you may wish to use them.
1226 // It should be noted that Vulkan 1.0 doesn't provide a method for
1227 // synchronizing rendering with the presentation engine's display. There
1228 // is a method provided for throttling rendering with the display, but
1229 // there are some presentation engines for which this method will not work.
1230 // If an application doesn't throttle its rendering, and if it renders much
1231 // faster than the refresh rate of the display, this can waste power on
1232 // mobile devices. That is because power is being spent rendering images
1233 // that may never be seen.
1235 // VK_PRESENT_MODE_IMMEDIATE_KHR is for applications that don't care about
1236 // tearing, or have some way of synchronizing their rendering with the
1238 // VK_PRESENT_MODE_MAILBOX_KHR may be useful for applications that
1239 // generally render a new presentable image every refresh cycle, but are
1240 // occasionally early. In this case, the application wants the new image
1241 // to be displayed instead of the previously-queued-for-presentation image
1242 // that has not yet been displayed.
1243 // VK_PRESENT_MODE_FIFO_RELAXED_KHR is for applications that generally
1244 // render a new presentable image every refresh cycle, but are occasionally
1245 // late. In this case (perhaps because of stuttering/latency concerns),
1246 // the application wants the late image to be immediately displayed, even
1247 // though that may mean some tearing.
1249 if (demo->presentMode != swapchainPresentMode) {
1250 for (size_t i = 0; i < presentModeCount; ++i) {
1251 if (presentModes[i] == demo->presentMode) {
1252 swapchainPresentMode = demo->presentMode;
1257 if (swapchainPresentMode != demo->presentMode) {
1258 ERR_EXIT("Present mode specified is not supported\n", "Present mode unsupported");
1261 // Determine the number of VkImages to use in the swap chain.
1262 // Application desires to acquire 3 images at a time for triple
1264 uint32_t desiredNumOfSwapchainImages = 3;
1265 if (desiredNumOfSwapchainImages < surfCapabilities.minImageCount) {
1266 desiredNumOfSwapchainImages = surfCapabilities.minImageCount;
1268 // If maxImageCount is 0, we can ask for as many images as we want;
1269 // otherwise we're limited to maxImageCount
1270 if ((surfCapabilities.maxImageCount > 0) && (desiredNumOfSwapchainImages > surfCapabilities.maxImageCount)) {
1271 // Application must settle for fewer images than desired:
1272 desiredNumOfSwapchainImages = surfCapabilities.maxImageCount;
1275 VkSurfaceTransformFlagsKHR preTransform;
1276 if (surfCapabilities.supportedTransforms & VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR) {
1277 preTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
1279 preTransform = surfCapabilities.currentTransform;
1282 // Find a supported composite alpha mode - one of these is guaranteed to be set
1283 VkCompositeAlphaFlagBitsKHR compositeAlpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
1284 VkCompositeAlphaFlagBitsKHR compositeAlphaFlags[4] = {
1285 VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR,
1286 VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR,
1287 VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR,
1288 VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR,
1290 for (uint32_t i = 0; i < ARRAY_SIZE(compositeAlphaFlags); i++) {
1291 if (surfCapabilities.supportedCompositeAlpha & compositeAlphaFlags[i]) {
1292 compositeAlpha = compositeAlphaFlags[i];
1297 VkSwapchainCreateInfoKHR swapchain_ci = {
1298 .sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR,
1300 .surface = demo->surface,
1301 .minImageCount = desiredNumOfSwapchainImages,
1302 .imageFormat = demo->format,
1303 .imageColorSpace = demo->color_space,
1306 .width = swapchainExtent.width,
1307 .height = swapchainExtent.height,
1309 .imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
1310 .preTransform = preTransform,
1311 .compositeAlpha = compositeAlpha,
1312 .imageArrayLayers = 1,
1313 .imageSharingMode = VK_SHARING_MODE_EXCLUSIVE,
1314 .queueFamilyIndexCount = 0,
1315 .pQueueFamilyIndices = NULL,
1316 .presentMode = swapchainPresentMode,
1317 .oldSwapchain = oldSwapchain,
1321 err = demo->fpCreateSwapchainKHR(demo->device, &swapchain_ci, NULL, &demo->swapchain);
1324 // If we just re-created an existing swapchain, we should destroy the old
1325 // swapchain at this point.
1326 // Note: destroying the swapchain also cleans up all its associated
1327 // presentable images once the platform is done with them.
1328 if (oldSwapchain != VK_NULL_HANDLE) {
1329 demo->fpDestroySwapchainKHR(demo->device, oldSwapchain, NULL);
1332 err = demo->fpGetSwapchainImagesKHR(demo->device, demo->swapchain, &demo->swapchainImageCount, NULL);
1335 VkImage *swapchainImages = (VkImage *)malloc(demo->swapchainImageCount * sizeof(VkImage));
1336 assert(swapchainImages);
1337 err = demo->fpGetSwapchainImagesKHR(demo->device, demo->swapchain, &demo->swapchainImageCount, swapchainImages);
1340 demo->swapchain_image_resources =
1341 (SwapchainImageResources *)malloc(sizeof(SwapchainImageResources) * demo->swapchainImageCount);
1342 assert(demo->swapchain_image_resources);
1344 for (i = 0; i < demo->swapchainImageCount; i++) {
1345 VkImageViewCreateInfo color_image_view = {
1346 .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO,
1348 .format = demo->format,
1351 .r = VK_COMPONENT_SWIZZLE_R,
1352 .g = VK_COMPONENT_SWIZZLE_G,
1353 .b = VK_COMPONENT_SWIZZLE_B,
1354 .a = VK_COMPONENT_SWIZZLE_A,
1357 {.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT, .baseMipLevel = 0, .levelCount = 1, .baseArrayLayer = 0, .layerCount = 1},
1358 .viewType = VK_IMAGE_VIEW_TYPE_2D,
1362 demo->swapchain_image_resources[i].image = swapchainImages[i];
1364 color_image_view.image = demo->swapchain_image_resources[i].image;
1366 err = vkCreateImageView(demo->device, &color_image_view, NULL, &demo->swapchain_image_resources[i].view);
1370 if (demo->VK_GOOGLE_display_timing_enabled) {
1371 VkRefreshCycleDurationGOOGLE rc_dur;
1372 err = demo->fpGetRefreshCycleDurationGOOGLE(demo->device, demo->swapchain, &rc_dur);
1374 demo->refresh_duration = rc_dur.refreshDuration;
1376 demo->syncd_with_actual_presents = false;
1377 // Initially target 1X the refresh duration:
1378 demo->target_IPD = demo->refresh_duration;
1379 demo->refresh_duration_multiplier = 1;
1380 demo->prev_desired_present_time = 0;
1381 demo->next_present_id = 1;
1384 if (NULL != swapchainImages) {
1385 free(swapchainImages);
1388 if (NULL != presentModes) {
1393 static void demo_prepare_depth(struct demo *demo) {
1394 const VkFormat depth_format = VK_FORMAT_D16_UNORM;
1395 const VkImageCreateInfo image = {
1396 .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO,
1398 .imageType = VK_IMAGE_TYPE_2D,
1399 .format = depth_format,
1400 .extent = {demo->width, demo->height, 1},
1403 .samples = VK_SAMPLE_COUNT_1_BIT,
1404 .tiling = VK_IMAGE_TILING_OPTIMAL,
1405 .usage = VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT,
1409 VkImageViewCreateInfo view = {
1410 .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO,
1412 .image = VK_NULL_HANDLE,
1413 .format = depth_format,
1415 {.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT, .baseMipLevel = 0, .levelCount = 1, .baseArrayLayer = 0, .layerCount = 1},
1417 .viewType = VK_IMAGE_VIEW_TYPE_2D,
1420 VkMemoryRequirements mem_reqs;
1421 VkResult U_ASSERT_ONLY err;
1422 bool U_ASSERT_ONLY pass;
1424 demo->depth.format = depth_format;
1427 err = vkCreateImage(demo->device, &image, NULL, &demo->depth.image);
1430 vkGetImageMemoryRequirements(demo->device, demo->depth.image, &mem_reqs);
1433 demo->depth.mem_alloc.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
1434 demo->depth.mem_alloc.pNext = NULL;
1435 demo->depth.mem_alloc.allocationSize = mem_reqs.size;
1436 demo->depth.mem_alloc.memoryTypeIndex = 0;
1438 pass = memory_type_from_properties(demo, mem_reqs.memoryTypeBits, VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
1439 &demo->depth.mem_alloc.memoryTypeIndex);
1442 /* allocate memory */
1443 err = vkAllocateMemory(demo->device, &demo->depth.mem_alloc, NULL, &demo->depth.mem);
1447 err = vkBindImageMemory(demo->device, demo->depth.image, demo->depth.mem, 0);
1450 /* create image view */
1451 view.image = demo->depth.image;
1452 err = vkCreateImageView(demo->device, &view, NULL, &demo->depth.view);
1456 /* Convert ppm image data from header file into RGBA texture image */
1457 #include "lunarg.ppm.h"
1458 bool loadTexture(const char *filename, uint8_t *rgba_data, VkSubresourceLayout *layout, int32_t *width, int32_t *height) {
1461 cPtr = (char *)lunarg_ppm;
1462 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "P6\n", 3)) {
1465 while (strncmp(cPtr++, "\n", 1))
1467 sscanf(cPtr, "%u %u", width, height);
1468 if (rgba_data == NULL) {
1471 while (strncmp(cPtr++, "\n", 1))
1473 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "255\n", 4)) {
1476 while (strncmp(cPtr++, "\n", 1))
1478 for (int y = 0; y < *height; y++) {
1479 uint8_t *rowPtr = rgba_data;
1480 for (int x = 0; x < *width; x++) {
1481 memcpy(rowPtr, cPtr, 3);
1482 rowPtr[3] = 255; /* Alpha of 1 */
1486 rgba_data += layout->rowPitch;
1491 static void demo_prepare_texture_buffer(struct demo *demo, const char *filename, struct texture_object *tex_obj) {
1494 VkResult U_ASSERT_ONLY err;
1495 bool U_ASSERT_ONLY pass;
1497 if (!loadTexture(filename, NULL, NULL, &tex_width, &tex_height)) {
1498 ERR_EXIT("Failed to load textures", "Load Texture Failure");
1501 tex_obj->tex_width = tex_width;
1502 tex_obj->tex_height = tex_height;
1504 const VkBufferCreateInfo buffer_create_info = {.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO,
1507 .size = tex_width * tex_height * 4,
1508 .usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT,
1509 .sharingMode = VK_SHARING_MODE_EXCLUSIVE,
1510 .queueFamilyIndexCount = 0,
1511 .pQueueFamilyIndices = NULL};
1513 err = vkCreateBuffer(demo->device, &buffer_create_info, NULL, &tex_obj->buffer);
1516 VkMemoryRequirements mem_reqs;
1517 vkGetBufferMemoryRequirements(demo->device, tex_obj->buffer, &mem_reqs);
1519 tex_obj->mem_alloc.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
1520 tex_obj->mem_alloc.pNext = NULL;
1521 tex_obj->mem_alloc.allocationSize = mem_reqs.size;
1522 tex_obj->mem_alloc.memoryTypeIndex = 0;
1524 VkFlags requirements = VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT;
1525 pass = memory_type_from_properties(demo, mem_reqs.memoryTypeBits, requirements, &tex_obj->mem_alloc.memoryTypeIndex);
1528 err = vkAllocateMemory(demo->device, &tex_obj->mem_alloc, NULL, &(tex_obj->mem));
1532 err = vkBindBufferMemory(demo->device, tex_obj->buffer, tex_obj->mem, 0);
1535 VkSubresourceLayout layout;
1536 memset(&layout, 0, sizeof(layout));
1537 layout.rowPitch = tex_width * 4;
1540 err = vkMapMemory(demo->device, tex_obj->mem, 0, tex_obj->mem_alloc.allocationSize, 0, &data);
1543 if (!loadTexture(filename, data, &layout, &tex_width, &tex_height)) {
1544 fprintf(stderr, "Error loading texture: %s\n", filename);
1547 vkUnmapMemory(demo->device, tex_obj->mem);
1550 static void demo_prepare_texture_image(struct demo *demo, const char *filename, struct texture_object *tex_obj,
1551 VkImageTiling tiling, VkImageUsageFlags usage, VkFlags required_props) {
1552 const VkFormat tex_format = VK_FORMAT_R8G8B8A8_UNORM;
1555 VkResult U_ASSERT_ONLY err;
1556 bool U_ASSERT_ONLY pass;
1558 if (!loadTexture(filename, NULL, NULL, &tex_width, &tex_height)) {
1559 ERR_EXIT("Failed to load textures", "Load Texture Failure");
1562 tex_obj->tex_width = tex_width;
1563 tex_obj->tex_height = tex_height;
1565 const VkImageCreateInfo image_create_info = {
1566 .sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO,
1568 .imageType = VK_IMAGE_TYPE_2D,
1569 .format = tex_format,
1570 .extent = {tex_width, tex_height, 1},
1573 .samples = VK_SAMPLE_COUNT_1_BIT,
1577 .initialLayout = VK_IMAGE_LAYOUT_PREINITIALIZED,
1580 VkMemoryRequirements mem_reqs;
1582 err = vkCreateImage(demo->device, &image_create_info, NULL, &tex_obj->image);
1585 vkGetImageMemoryRequirements(demo->device, tex_obj->image, &mem_reqs);
1587 tex_obj->mem_alloc.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
1588 tex_obj->mem_alloc.pNext = NULL;
1589 tex_obj->mem_alloc.allocationSize = mem_reqs.size;
1590 tex_obj->mem_alloc.memoryTypeIndex = 0;
1592 pass = memory_type_from_properties(demo, mem_reqs.memoryTypeBits, required_props, &tex_obj->mem_alloc.memoryTypeIndex);
1595 /* allocate memory */
1596 err = vkAllocateMemory(demo->device, &tex_obj->mem_alloc, NULL, &(tex_obj->mem));
1600 err = vkBindImageMemory(demo->device, tex_obj->image, tex_obj->mem, 0);
1603 if (required_props & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT) {
1604 const VkImageSubresource subres = {
1605 .aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
1609 VkSubresourceLayout layout;
1612 vkGetImageSubresourceLayout(demo->device, tex_obj->image, &subres, &layout);
1614 err = vkMapMemory(demo->device, tex_obj->mem, 0, tex_obj->mem_alloc.allocationSize, 0, &data);
1617 if (!loadTexture(filename, data, &layout, &tex_width, &tex_height)) {
1618 fprintf(stderr, "Error loading texture: %s\n", filename);
1621 vkUnmapMemory(demo->device, tex_obj->mem);
1624 tex_obj->imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
1627 static void demo_destroy_texture(struct demo *demo, struct texture_object *tex_objs) {
1628 /* clean up staging resources */
1629 vkFreeMemory(demo->device, tex_objs->mem, NULL);
1630 if (tex_objs->image) vkDestroyImage(demo->device, tex_objs->image, NULL);
1631 if (tex_objs->buffer) vkDestroyBuffer(demo->device, tex_objs->buffer, NULL);
1634 static void demo_prepare_textures(struct demo *demo) {
1635 const VkFormat tex_format = VK_FORMAT_R8G8B8A8_UNORM;
1636 VkFormatProperties props;
1639 vkGetPhysicalDeviceFormatProperties(demo->gpu, tex_format, &props);
1641 for (i = 0; i < DEMO_TEXTURE_COUNT; i++) {
1642 VkResult U_ASSERT_ONLY err;
1644 if ((props.linearTilingFeatures & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT) && !demo->use_staging_buffer) {
1645 /* Device can texture using linear textures */
1646 demo_prepare_texture_image(demo, tex_files[i], &demo->textures[i], VK_IMAGE_TILING_LINEAR, VK_IMAGE_USAGE_SAMPLED_BIT,
1647 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT);
1648 // Nothing in the pipeline needs to be complete to start, and don't allow fragment
1649 // shader to run until layout transition completes
1650 demo_set_image_layout(demo, demo->textures[i].image, VK_IMAGE_ASPECT_COLOR_BIT, VK_IMAGE_LAYOUT_PREINITIALIZED,
1651 demo->textures[i].imageLayout, 0, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
1652 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT);
1653 demo->staging_texture.image = 0;
1654 } else if (props.optimalTilingFeatures & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT) {
1655 /* Must use staging buffer to copy linear texture to optimized */
1657 memset(&demo->staging_texture, 0, sizeof(demo->staging_texture));
1658 demo_prepare_texture_buffer(demo, tex_files[i], &demo->staging_texture);
1660 demo_prepare_texture_image(demo, tex_files[i], &demo->textures[i], VK_IMAGE_TILING_OPTIMAL,
1661 (VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT),
1662 VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT);
1664 demo_set_image_layout(demo, demo->textures[i].image, VK_IMAGE_ASPECT_COLOR_BIT, VK_IMAGE_LAYOUT_PREINITIALIZED,
1665 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 0, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
1666 VK_PIPELINE_STAGE_TRANSFER_BIT);
1668 VkBufferImageCopy copy_region = {
1670 .bufferRowLength = demo->staging_texture.tex_width,
1671 .bufferImageHeight = demo->staging_texture.tex_height,
1672 .imageSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1},
1673 .imageOffset = {0, 0, 0},
1674 .imageExtent = {demo->staging_texture.tex_width, demo->staging_texture.tex_height, 1},
1677 vkCmdCopyBufferToImage(demo->cmd, demo->staging_texture.buffer, demo->textures[i].image,
1678 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, ©_region);
1680 demo_set_image_layout(demo, demo->textures[i].image, VK_IMAGE_ASPECT_COLOR_BIT, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL,
1681 demo->textures[i].imageLayout, VK_ACCESS_TRANSFER_WRITE_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT,
1682 VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT);
1685 /* Can't support VK_FORMAT_R8G8B8A8_UNORM !? */
1686 assert(!"No support for R8G8B8A8_UNORM as texture image format");
1689 const VkSamplerCreateInfo sampler = {
1690 .sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO,
1692 .magFilter = VK_FILTER_NEAREST,
1693 .minFilter = VK_FILTER_NEAREST,
1694 .mipmapMode = VK_SAMPLER_MIPMAP_MODE_NEAREST,
1695 .addressModeU = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
1696 .addressModeV = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
1697 .addressModeW = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE,
1699 .anisotropyEnable = VK_FALSE,
1701 .compareOp = VK_COMPARE_OP_NEVER,
1704 .borderColor = VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE,
1705 .unnormalizedCoordinates = VK_FALSE,
1708 VkImageViewCreateInfo view = {
1709 .sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO,
1711 .image = VK_NULL_HANDLE,
1712 .viewType = VK_IMAGE_VIEW_TYPE_2D,
1713 .format = tex_format,
1716 VK_COMPONENT_SWIZZLE_R,
1717 VK_COMPONENT_SWIZZLE_G,
1718 VK_COMPONENT_SWIZZLE_B,
1719 VK_COMPONENT_SWIZZLE_A,
1721 .subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1},
1725 /* create sampler */
1726 err = vkCreateSampler(demo->device, &sampler, NULL, &demo->textures[i].sampler);
1729 /* create image view */
1730 view.image = demo->textures[i].image;
1731 err = vkCreateImageView(demo->device, &view, NULL, &demo->textures[i].view);
1736 void demo_prepare_cube_data_buffers(struct demo *demo) {
1737 VkBufferCreateInfo buf_info;
1738 VkMemoryRequirements mem_reqs;
1739 VkMemoryAllocateInfo mem_alloc;
1742 VkResult U_ASSERT_ONLY err;
1743 bool U_ASSERT_ONLY pass;
1744 struct vktexcube_vs_uniform data;
1746 mat4x4_mul(VP, demo->projection_matrix, demo->view_matrix);
1747 mat4x4_mul(MVP, VP, demo->model_matrix);
1748 memcpy(data.mvp, MVP, sizeof(MVP));
1749 // dumpMatrix("MVP", MVP);
1751 for (unsigned int i = 0; i < 12 * 3; i++) {
1752 data.position[i][0] = g_vertex_buffer_data[i * 3];
1753 data.position[i][1] = g_vertex_buffer_data[i * 3 + 1];
1754 data.position[i][2] = g_vertex_buffer_data[i * 3 + 2];
1755 data.position[i][3] = 1.0f;
1756 data.attr[i][0] = g_uv_buffer_data[2 * i];
1757 data.attr[i][1] = g_uv_buffer_data[2 * i + 1];
1758 data.attr[i][2] = 0;
1759 data.attr[i][3] = 0;
1762 memset(&buf_info, 0, sizeof(buf_info));
1763 buf_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
1764 buf_info.usage = VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT;
1765 buf_info.size = sizeof(data);
1767 for (unsigned int i = 0; i < demo->swapchainImageCount; i++) {
1768 err = vkCreateBuffer(demo->device, &buf_info, NULL, &demo->swapchain_image_resources[i].uniform_buffer);
1771 vkGetBufferMemoryRequirements(demo->device, demo->swapchain_image_resources[i].uniform_buffer, &mem_reqs);
1773 mem_alloc.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
1774 mem_alloc.pNext = NULL;
1775 mem_alloc.allocationSize = mem_reqs.size;
1776 mem_alloc.memoryTypeIndex = 0;
1778 pass = memory_type_from_properties(demo, mem_reqs.memoryTypeBits,
1779 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT,
1780 &mem_alloc.memoryTypeIndex);
1783 err = vkAllocateMemory(demo->device, &mem_alloc, NULL, &demo->swapchain_image_resources[i].uniform_memory);
1786 err = vkMapMemory(demo->device, demo->swapchain_image_resources[i].uniform_memory, 0, VK_WHOLE_SIZE, 0, (void **)&pData);
1789 memcpy(pData, &data, sizeof data);
1791 vkUnmapMemory(demo->device, demo->swapchain_image_resources[i].uniform_memory);
1793 err = vkBindBufferMemory(demo->device, demo->swapchain_image_resources[i].uniform_buffer,
1794 demo->swapchain_image_resources[i].uniform_memory, 0);
1799 static void demo_prepare_descriptor_layout(struct demo *demo) {
1800 const VkDescriptorSetLayoutBinding layout_bindings[2] = {
1804 .descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER,
1805 .descriptorCount = 1,
1806 .stageFlags = VK_SHADER_STAGE_VERTEX_BIT,
1807 .pImmutableSamplers = NULL,
1812 .descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
1813 .descriptorCount = DEMO_TEXTURE_COUNT,
1814 .stageFlags = VK_SHADER_STAGE_FRAGMENT_BIT,
1815 .pImmutableSamplers = NULL,
1818 const VkDescriptorSetLayoutCreateInfo descriptor_layout = {
1819 .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO,
1822 .pBindings = layout_bindings,
1824 VkResult U_ASSERT_ONLY err;
1826 err = vkCreateDescriptorSetLayout(demo->device, &descriptor_layout, NULL, &demo->desc_layout);
1829 const VkPipelineLayoutCreateInfo pPipelineLayoutCreateInfo = {
1830 .sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO,
1832 .setLayoutCount = 1,
1833 .pSetLayouts = &demo->desc_layout,
1836 err = vkCreatePipelineLayout(demo->device, &pPipelineLayoutCreateInfo, NULL, &demo->pipeline_layout);
1840 static void demo_prepare_render_pass(struct demo *demo) {
1841 // The initial layout for the color and depth attachments will be LAYOUT_UNDEFINED
1842 // because at the start of the renderpass, we don't care about their contents.
1843 // At the start of the subpass, the color attachment's layout will be transitioned
1844 // to LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth stencil attachment's layout
1845 // will be transitioned to LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL. At the end of
1846 // the renderpass, the color attachment's layout will be transitioned to
1847 // LAYOUT_PRESENT_SRC_KHR to be ready to present. This is all done as part of
1848 // the renderpass, no barriers are necessary.
1849 const VkAttachmentDescription attachments[2] = {
1852 .format = demo->format,
1854 .samples = VK_SAMPLE_COUNT_1_BIT,
1855 .loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR,
1856 .storeOp = VK_ATTACHMENT_STORE_OP_STORE,
1857 .stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE,
1858 .stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE,
1859 .initialLayout = VK_IMAGE_LAYOUT_UNDEFINED,
1860 .finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
1864 .format = demo->depth.format,
1866 .samples = VK_SAMPLE_COUNT_1_BIT,
1867 .loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR,
1868 .storeOp = VK_ATTACHMENT_STORE_OP_DONT_CARE,
1869 .stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE,
1870 .stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE,
1871 .initialLayout = VK_IMAGE_LAYOUT_UNDEFINED,
1872 .finalLayout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
1875 const VkAttachmentReference color_reference = {
1877 .layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL,
1879 const VkAttachmentReference depth_reference = {
1881 .layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
1883 const VkSubpassDescription subpass = {
1884 .pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS,
1886 .inputAttachmentCount = 0,
1887 .pInputAttachments = NULL,
1888 .colorAttachmentCount = 1,
1889 .pColorAttachments = &color_reference,
1890 .pResolveAttachments = NULL,
1891 .pDepthStencilAttachment = &depth_reference,
1892 .preserveAttachmentCount = 0,
1893 .pPreserveAttachments = NULL,
1895 const VkRenderPassCreateInfo rp_info = {
1896 .sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO,
1899 .attachmentCount = 2,
1900 .pAttachments = attachments,
1902 .pSubpasses = &subpass,
1903 .dependencyCount = 0,
1904 .pDependencies = NULL,
1906 VkResult U_ASSERT_ONLY err;
1908 err = vkCreateRenderPass(demo->device, &rp_info, NULL, &demo->render_pass);
1912 static VkShaderModule demo_prepare_shader_module(struct demo *demo, const uint32_t *code, size_t size) {
1913 VkShaderModule module;
1914 VkShaderModuleCreateInfo moduleCreateInfo;
1915 VkResult U_ASSERT_ONLY err;
1917 moduleCreateInfo.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
1918 moduleCreateInfo.pNext = NULL;
1919 moduleCreateInfo.flags = 0;
1920 moduleCreateInfo.codeSize = size;
1921 moduleCreateInfo.pCode = code;
1923 err = vkCreateShaderModule(demo->device, &moduleCreateInfo, NULL, &module);
1929 static void demo_prepare_vs(struct demo *demo) {
1930 const uint32_t vs_code[] = {
1931 #include "cube.vert.inc"
1933 demo->vert_shader_module = demo_prepare_shader_module(demo, vs_code, sizeof(vs_code));
1936 static void demo_prepare_fs(struct demo *demo) {
1937 const uint32_t fs_code[] = {
1938 #include "cube.frag.inc"
1940 demo->frag_shader_module = demo_prepare_shader_module(demo, fs_code, sizeof(fs_code));
1943 static void demo_prepare_pipeline(struct demo *demo) {
1944 VkGraphicsPipelineCreateInfo pipeline;
1945 VkPipelineCacheCreateInfo pipelineCache;
1946 VkPipelineVertexInputStateCreateInfo vi;
1947 VkPipelineInputAssemblyStateCreateInfo ia;
1948 VkPipelineRasterizationStateCreateInfo rs;
1949 VkPipelineColorBlendStateCreateInfo cb;
1950 VkPipelineDepthStencilStateCreateInfo ds;
1951 VkPipelineViewportStateCreateInfo vp;
1952 VkPipelineMultisampleStateCreateInfo ms;
1953 VkDynamicState dynamicStateEnables[VK_DYNAMIC_STATE_RANGE_SIZE];
1954 VkPipelineDynamicStateCreateInfo dynamicState;
1955 VkResult U_ASSERT_ONLY err;
1957 memset(dynamicStateEnables, 0, sizeof dynamicStateEnables);
1958 memset(&dynamicState, 0, sizeof dynamicState);
1959 dynamicState.sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
1960 dynamicState.pDynamicStates = dynamicStateEnables;
1962 memset(&pipeline, 0, sizeof(pipeline));
1963 pipeline.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
1964 pipeline.layout = demo->pipeline_layout;
1966 memset(&vi, 0, sizeof(vi));
1967 vi.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
1969 memset(&ia, 0, sizeof(ia));
1970 ia.sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
1971 ia.topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
1973 memset(&rs, 0, sizeof(rs));
1974 rs.sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
1975 rs.polygonMode = VK_POLYGON_MODE_FILL;
1976 rs.cullMode = VK_CULL_MODE_BACK_BIT;
1977 rs.frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
1978 rs.depthClampEnable = VK_FALSE;
1979 rs.rasterizerDiscardEnable = VK_FALSE;
1980 rs.depthBiasEnable = VK_FALSE;
1981 rs.lineWidth = 1.0f;
1983 memset(&cb, 0, sizeof(cb));
1984 cb.sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
1985 VkPipelineColorBlendAttachmentState att_state[1];
1986 memset(att_state, 0, sizeof(att_state));
1987 att_state[0].colorWriteMask = 0xf;
1988 att_state[0].blendEnable = VK_FALSE;
1989 cb.attachmentCount = 1;
1990 cb.pAttachments = att_state;
1992 memset(&vp, 0, sizeof(vp));
1993 vp.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
1994 vp.viewportCount = 1;
1995 dynamicStateEnables[dynamicState.dynamicStateCount++] = VK_DYNAMIC_STATE_VIEWPORT;
1996 vp.scissorCount = 1;
1997 dynamicStateEnables[dynamicState.dynamicStateCount++] = VK_DYNAMIC_STATE_SCISSOR;
1999 memset(&ds, 0, sizeof(ds));
2000 ds.sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
2001 ds.depthTestEnable = VK_TRUE;
2002 ds.depthWriteEnable = VK_TRUE;
2003 ds.depthCompareOp = VK_COMPARE_OP_LESS_OR_EQUAL;
2004 ds.depthBoundsTestEnable = VK_FALSE;
2005 ds.back.failOp = VK_STENCIL_OP_KEEP;
2006 ds.back.passOp = VK_STENCIL_OP_KEEP;
2007 ds.back.compareOp = VK_COMPARE_OP_ALWAYS;
2008 ds.stencilTestEnable = VK_FALSE;
2011 memset(&ms, 0, sizeof(ms));
2012 ms.sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
2013 ms.pSampleMask = NULL;
2014 ms.rasterizationSamples = VK_SAMPLE_COUNT_1_BIT;
2016 demo_prepare_vs(demo);
2017 demo_prepare_fs(demo);
2019 // Two stages: vs and fs
2020 VkPipelineShaderStageCreateInfo shaderStages[2];
2021 memset(&shaderStages, 0, 2 * sizeof(VkPipelineShaderStageCreateInfo));
2023 shaderStages[0].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
2024 shaderStages[0].stage = VK_SHADER_STAGE_VERTEX_BIT;
2025 shaderStages[0].module = demo->vert_shader_module;
2026 shaderStages[0].pName = "main";
2028 shaderStages[1].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
2029 shaderStages[1].stage = VK_SHADER_STAGE_FRAGMENT_BIT;
2030 shaderStages[1].module = demo->frag_shader_module;
2031 shaderStages[1].pName = "main";
2033 memset(&pipelineCache, 0, sizeof(pipelineCache));
2034 pipelineCache.sType = VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO;
2036 err = vkCreatePipelineCache(demo->device, &pipelineCache, NULL, &demo->pipelineCache);
2039 pipeline.pVertexInputState = &vi;
2040 pipeline.pInputAssemblyState = &ia;
2041 pipeline.pRasterizationState = &rs;
2042 pipeline.pColorBlendState = &cb;
2043 pipeline.pMultisampleState = &ms;
2044 pipeline.pViewportState = &vp;
2045 pipeline.pDepthStencilState = &ds;
2046 pipeline.stageCount = ARRAY_SIZE(shaderStages);
2047 pipeline.pStages = shaderStages;
2048 pipeline.renderPass = demo->render_pass;
2049 pipeline.pDynamicState = &dynamicState;
2051 pipeline.renderPass = demo->render_pass;
2053 err = vkCreateGraphicsPipelines(demo->device, demo->pipelineCache, 1, &pipeline, NULL, &demo->pipeline);
2056 vkDestroyShaderModule(demo->device, demo->frag_shader_module, NULL);
2057 vkDestroyShaderModule(demo->device, demo->vert_shader_module, NULL);
2060 static void demo_prepare_descriptor_pool(struct demo *demo) {
2061 const VkDescriptorPoolSize type_counts[2] = {
2064 .type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER,
2065 .descriptorCount = demo->swapchainImageCount,
2069 .type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
2070 .descriptorCount = demo->swapchainImageCount * DEMO_TEXTURE_COUNT,
2073 const VkDescriptorPoolCreateInfo descriptor_pool = {
2074 .sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO,
2076 .maxSets = demo->swapchainImageCount,
2078 .pPoolSizes = type_counts,
2080 VkResult U_ASSERT_ONLY err;
2082 err = vkCreateDescriptorPool(demo->device, &descriptor_pool, NULL, &demo->desc_pool);
2086 static void demo_prepare_descriptor_set(struct demo *demo) {
2087 VkDescriptorImageInfo tex_descs[DEMO_TEXTURE_COUNT];
2088 VkWriteDescriptorSet writes[2];
2089 VkResult U_ASSERT_ONLY err;
2091 VkDescriptorSetAllocateInfo alloc_info = {.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO,
2093 .descriptorPool = demo->desc_pool,
2094 .descriptorSetCount = 1,
2095 .pSetLayouts = &demo->desc_layout};
2097 VkDescriptorBufferInfo buffer_info;
2098 buffer_info.offset = 0;
2099 buffer_info.range = sizeof(struct vktexcube_vs_uniform);
2101 memset(&tex_descs, 0, sizeof(tex_descs));
2102 for (unsigned int i = 0; i < DEMO_TEXTURE_COUNT; i++) {
2103 tex_descs[i].sampler = demo->textures[i].sampler;
2104 tex_descs[i].imageView = demo->textures[i].view;
2105 tex_descs[i].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
2108 memset(&writes, 0, sizeof(writes));
2110 writes[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
2111 writes[0].descriptorCount = 1;
2112 writes[0].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
2113 writes[0].pBufferInfo = &buffer_info;
2115 writes[1].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
2116 writes[1].dstBinding = 1;
2117 writes[1].descriptorCount = DEMO_TEXTURE_COUNT;
2118 writes[1].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
2119 writes[1].pImageInfo = tex_descs;
2121 for (unsigned int i = 0; i < demo->swapchainImageCount; i++) {
2122 err = vkAllocateDescriptorSets(demo->device, &alloc_info, &demo->swapchain_image_resources[i].descriptor_set);
2124 buffer_info.buffer = demo->swapchain_image_resources[i].uniform_buffer;
2125 writes[0].dstSet = demo->swapchain_image_resources[i].descriptor_set;
2126 writes[1].dstSet = demo->swapchain_image_resources[i].descriptor_set;
2127 vkUpdateDescriptorSets(demo->device, 2, writes, 0, NULL);
2131 static void demo_prepare_framebuffers(struct demo *demo) {
2132 VkImageView attachments[2];
2133 attachments[1] = demo->depth.view;
2135 const VkFramebufferCreateInfo fb_info = {
2136 .sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO,
2138 .renderPass = demo->render_pass,
2139 .attachmentCount = 2,
2140 .pAttachments = attachments,
2141 .width = demo->width,
2142 .height = demo->height,
2145 VkResult U_ASSERT_ONLY err;
2148 for (i = 0; i < demo->swapchainImageCount; i++) {
2149 attachments[0] = demo->swapchain_image_resources[i].view;
2150 err = vkCreateFramebuffer(demo->device, &fb_info, NULL, &demo->swapchain_image_resources[i].framebuffer);
2155 static void demo_prepare(struct demo *demo) {
2156 VkResult U_ASSERT_ONLY err;
2157 if (demo->cmd_pool == VK_NULL_HANDLE) {
2158 const VkCommandPoolCreateInfo cmd_pool_info = {
2159 .sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO,
2161 .queueFamilyIndex = demo->graphics_queue_family_index,
2164 err = vkCreateCommandPool(demo->device, &cmd_pool_info, NULL, &demo->cmd_pool);
2168 const VkCommandBufferAllocateInfo cmd = {
2169 .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO,
2171 .commandPool = demo->cmd_pool,
2172 .level = VK_COMMAND_BUFFER_LEVEL_PRIMARY,
2173 .commandBufferCount = 1,
2175 err = vkAllocateCommandBuffers(demo->device, &cmd, &demo->cmd);
2177 VkCommandBufferBeginInfo cmd_buf_info = {
2178 .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO,
2181 .pInheritanceInfo = NULL,
2183 err = vkBeginCommandBuffer(demo->cmd, &cmd_buf_info);
2186 demo_prepare_buffers(demo);
2188 if (demo->is_minimized) {
2189 demo->prepared = false;
2193 demo_prepare_depth(demo);
2194 demo_prepare_textures(demo);
2195 demo_prepare_cube_data_buffers(demo);
2197 demo_prepare_descriptor_layout(demo);
2198 demo_prepare_render_pass(demo);
2199 demo_prepare_pipeline(demo);
2201 for (uint32_t i = 0; i < demo->swapchainImageCount; i++) {
2202 err = vkAllocateCommandBuffers(demo->device, &cmd, &demo->swapchain_image_resources[i].cmd);
2206 if (demo->separate_present_queue) {
2207 const VkCommandPoolCreateInfo present_cmd_pool_info = {
2208 .sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO,
2210 .queueFamilyIndex = demo->present_queue_family_index,
2213 err = vkCreateCommandPool(demo->device, &present_cmd_pool_info, NULL, &demo->present_cmd_pool);
2215 const VkCommandBufferAllocateInfo present_cmd_info = {
2216 .sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO,
2218 .commandPool = demo->present_cmd_pool,
2219 .level = VK_COMMAND_BUFFER_LEVEL_PRIMARY,
2220 .commandBufferCount = 1,
2222 for (uint32_t i = 0; i < demo->swapchainImageCount; i++) {
2223 err = vkAllocateCommandBuffers(demo->device, &present_cmd_info,
2224 &demo->swapchain_image_resources[i].graphics_to_present_cmd);
2226 demo_build_image_ownership_cmd(demo, i);
2230 demo_prepare_descriptor_pool(demo);
2231 demo_prepare_descriptor_set(demo);
2233 demo_prepare_framebuffers(demo);
2235 for (uint32_t i = 0; i < demo->swapchainImageCount; i++) {
2236 demo->current_buffer = i;
2237 demo_draw_build_cmd(demo, demo->swapchain_image_resources[i].cmd);
2241 * Prepare functions above may generate pipeline commands
2242 * that need to be flushed before beginning the render loop.
2244 demo_flush_init_cmd(demo);
2245 if (demo->staging_texture.buffer) {
2246 demo_destroy_texture(demo, &demo->staging_texture);
2249 demo->current_buffer = 0;
2250 demo->prepared = true;
2253 static void demo_cleanup(struct demo *demo) {
2256 demo->prepared = false;
2257 vkDeviceWaitIdle(demo->device);
2259 // Wait for fences from present operations
2260 for (i = 0; i < FRAME_LAG; i++) {
2261 vkWaitForFences(demo->device, 1, &demo->fences[i], VK_TRUE, UINT64_MAX);
2262 vkDestroyFence(demo->device, demo->fences[i], NULL);
2263 vkDestroySemaphore(demo->device, demo->image_acquired_semaphores[i], NULL);
2264 vkDestroySemaphore(demo->device, demo->draw_complete_semaphores[i], NULL);
2265 if (demo->separate_present_queue) {
2266 vkDestroySemaphore(demo->device, demo->image_ownership_semaphores[i], NULL);
2270 // If the window is currently minimized, demo_resize has already done some cleanup for us.
2271 if (!demo->is_minimized) {
2272 for (i = 0; i < demo->swapchainImageCount; i++) {
2273 vkDestroyFramebuffer(demo->device, demo->swapchain_image_resources[i].framebuffer, NULL);
2275 vkDestroyDescriptorPool(demo->device, demo->desc_pool, NULL);
2277 vkDestroyPipeline(demo->device, demo->pipeline, NULL);
2278 vkDestroyPipelineCache(demo->device, demo->pipelineCache, NULL);
2279 vkDestroyRenderPass(demo->device, demo->render_pass, NULL);
2280 vkDestroyPipelineLayout(demo->device, demo->pipeline_layout, NULL);
2281 vkDestroyDescriptorSetLayout(demo->device, demo->desc_layout, NULL);
2283 for (i = 0; i < DEMO_TEXTURE_COUNT; i++) {
2284 vkDestroyImageView(demo->device, demo->textures[i].view, NULL);
2285 vkDestroyImage(demo->device, demo->textures[i].image, NULL);
2286 vkFreeMemory(demo->device, demo->textures[i].mem, NULL);
2287 vkDestroySampler(demo->device, demo->textures[i].sampler, NULL);
2289 demo->fpDestroySwapchainKHR(demo->device, demo->swapchain, NULL);
2291 vkDestroyImageView(demo->device, demo->depth.view, NULL);
2292 vkDestroyImage(demo->device, demo->depth.image, NULL);
2293 vkFreeMemory(demo->device, demo->depth.mem, NULL);
2295 for (i = 0; i < demo->swapchainImageCount; i++) {
2296 vkDestroyImageView(demo->device, demo->swapchain_image_resources[i].view, NULL);
2297 vkFreeCommandBuffers(demo->device, demo->cmd_pool, 1, &demo->swapchain_image_resources[i].cmd);
2298 vkDestroyBuffer(demo->device, demo->swapchain_image_resources[i].uniform_buffer, NULL);
2299 vkFreeMemory(demo->device, demo->swapchain_image_resources[i].uniform_memory, NULL);
2301 free(demo->swapchain_image_resources);
2302 free(demo->queue_props);
2303 vkDestroyCommandPool(demo->device, demo->cmd_pool, NULL);
2305 if (demo->separate_present_queue) {
2306 vkDestroyCommandPool(demo->device, demo->present_cmd_pool, NULL);
2309 vkDeviceWaitIdle(demo->device);
2310 vkDestroyDevice(demo->device, NULL);
2311 if (demo->validate) {
2312 demo->DestroyDebugUtilsMessengerEXT(demo->inst, demo->dbg_messenger, NULL);
2314 vkDestroySurfaceKHR(demo->inst, demo->surface, NULL);
2316 #if defined(VK_USE_PLATFORM_XLIB_KHR)
2317 XDestroyWindow(demo->display, demo->xlib_window);
2318 XCloseDisplay(demo->display);
2319 #elif defined(VK_USE_PLATFORM_XCB_KHR)
2320 xcb_destroy_window(demo->connection, demo->xcb_window);
2321 xcb_disconnect(demo->connection);
2322 free(demo->atom_wm_delete_window);
2323 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2324 wl_keyboard_destroy(demo->keyboard);
2325 wl_pointer_destroy(demo->pointer);
2326 wl_seat_destroy(demo->seat);
2327 wl_shell_surface_destroy(demo->shell_surface);
2328 wl_surface_destroy(demo->window);
2329 wl_shell_destroy(demo->shell);
2330 wl_compositor_destroy(demo->compositor);
2331 wl_registry_destroy(demo->registry);
2332 wl_display_disconnect(demo->display);
2335 vkDestroyInstance(demo->inst, NULL);
2338 static void demo_resize(struct demo *demo) {
2341 // Don't react to resize until after first initialization.
2342 if (!demo->prepared) {
2343 if (demo->is_minimized) {
2348 // In order to properly resize the window, we must re-create the swapchain
2349 // AND redo the command buffers, etc.
2351 // First, perform part of the demo_cleanup() function:
2352 demo->prepared = false;
2353 vkDeviceWaitIdle(demo->device);
2355 for (i = 0; i < demo->swapchainImageCount; i++) {
2356 vkDestroyFramebuffer(demo->device, demo->swapchain_image_resources[i].framebuffer, NULL);
2358 vkDestroyDescriptorPool(demo->device, demo->desc_pool, NULL);
2360 vkDestroyPipeline(demo->device, demo->pipeline, NULL);
2361 vkDestroyPipelineCache(demo->device, demo->pipelineCache, NULL);
2362 vkDestroyRenderPass(demo->device, demo->render_pass, NULL);
2363 vkDestroyPipelineLayout(demo->device, demo->pipeline_layout, NULL);
2364 vkDestroyDescriptorSetLayout(demo->device, demo->desc_layout, NULL);
2366 for (i = 0; i < DEMO_TEXTURE_COUNT; i++) {
2367 vkDestroyImageView(demo->device, demo->textures[i].view, NULL);
2368 vkDestroyImage(demo->device, demo->textures[i].image, NULL);
2369 vkFreeMemory(demo->device, demo->textures[i].mem, NULL);
2370 vkDestroySampler(demo->device, demo->textures[i].sampler, NULL);
2373 vkDestroyImageView(demo->device, demo->depth.view, NULL);
2374 vkDestroyImage(demo->device, demo->depth.image, NULL);
2375 vkFreeMemory(demo->device, demo->depth.mem, NULL);
2377 for (i = 0; i < demo->swapchainImageCount; i++) {
2378 vkDestroyImageView(demo->device, demo->swapchain_image_resources[i].view, NULL);
2379 vkFreeCommandBuffers(demo->device, demo->cmd_pool, 1, &demo->swapchain_image_resources[i].cmd);
2380 vkDestroyBuffer(demo->device, demo->swapchain_image_resources[i].uniform_buffer, NULL);
2381 vkFreeMemory(demo->device, demo->swapchain_image_resources[i].uniform_memory, NULL);
2383 vkDestroyCommandPool(demo->device, demo->cmd_pool, NULL);
2384 demo->cmd_pool = VK_NULL_HANDLE;
2385 if (demo->separate_present_queue) {
2386 vkDestroyCommandPool(demo->device, demo->present_cmd_pool, NULL);
2388 free(demo->swapchain_image_resources);
2390 // Second, re-perform the demo_prepare() function, which will re-create the
2395 // On MS-Windows, make this a global, so it's available to WndProc()
2398 #if defined(VK_USE_PLATFORM_WIN32_KHR)
2399 static void demo_run(struct demo *demo) {
2400 if (!demo->prepared) return;
2404 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) {
2405 PostQuitMessage(validation_error);
2409 // MS-Windows event handling function:
2410 LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
2413 PostQuitMessage(validation_error);
2416 // The validation callback calls MessageBox which can generate paint
2417 // events - don't make more Vulkan calls if we got here from the
2423 case WM_GETMINMAXINFO: // set window's minimum size
2424 ((MINMAXINFO *)lParam)->ptMinTrackSize = demo.minsize;
2429 // Resize the application to the new window size, except when
2430 // it was minimized. Vulkan doesn't support images or swapchains
2431 // with width=0 and height=0.
2432 if (wParam != SIZE_MINIMIZED) {
2433 demo.width = lParam & 0xffff;
2434 demo.height = (lParam & 0xffff0000) >> 16;
2441 PostQuitMessage(validation_error);
2444 demo.spin_angle -= demo.spin_increment;
2447 demo.spin_angle += demo.spin_increment;
2450 demo.pause = !demo.pause;
2457 return (DefWindowProc(hWnd, uMsg, wParam, lParam));
2460 static void demo_create_window(struct demo *demo) {
2461 WNDCLASSEX win_class;
2463 // Initialize the window class structure:
2464 win_class.cbSize = sizeof(WNDCLASSEX);
2465 win_class.style = CS_HREDRAW | CS_VREDRAW;
2466 win_class.lpfnWndProc = WndProc;
2467 win_class.cbClsExtra = 0;
2468 win_class.cbWndExtra = 0;
2469 win_class.hInstance = demo->connection; // hInstance
2470 win_class.hIcon = LoadIcon(NULL, IDI_APPLICATION);
2471 win_class.hCursor = LoadCursor(NULL, IDC_ARROW);
2472 win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
2473 win_class.lpszMenuName = NULL;
2474 win_class.lpszClassName = demo->name;
2475 win_class.hIconSm = LoadIcon(NULL, IDI_WINLOGO);
2476 // Register window class:
2477 if (!RegisterClassEx(&win_class)) {
2478 // It didn't work, so try to give a useful error:
2479 printf("Unexpected error trying to start the application!\n");
2483 // Create window with the registered class:
2484 RECT wr = {0, 0, demo->width, demo->height};
2485 AdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
2486 demo->window = CreateWindowEx(0,
2487 demo->name, // class name
2488 demo->name, // app name
2489 WS_OVERLAPPEDWINDOW | // window style
2490 WS_VISIBLE | WS_SYSMENU,
2491 100, 100, // x/y coords
2492 wr.right - wr.left, // width
2493 wr.bottom - wr.top, // height
2494 NULL, // handle to parent
2495 NULL, // handle to menu
2496 demo->connection, // hInstance
2497 NULL); // no extra parameters
2498 if (!demo->window) {
2499 // It didn't work, so try to give a useful error:
2500 printf("Cannot create a window in which to draw!\n");
2504 // Window client area size must be at least 1 pixel high, to prevent crash.
2505 demo->minsize.x = GetSystemMetrics(SM_CXMINTRACK);
2506 demo->minsize.y = GetSystemMetrics(SM_CYMINTRACK) + 1;
2508 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
2509 static void demo_create_xlib_window(struct demo *demo) {
2510 const char *display_envar = getenv("DISPLAY");
2511 if (display_envar == NULL || display_envar[0] == '\0') {
2512 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
2518 demo->display = XOpenDisplay(NULL);
2519 long visualMask = VisualScreenMask;
2520 int numberOfVisuals;
2521 XVisualInfo vInfoTemplate = {};
2522 vInfoTemplate.screen = DefaultScreen(demo->display);
2523 XVisualInfo *visualInfo = XGetVisualInfo(demo->display, visualMask, &vInfoTemplate, &numberOfVisuals);
2526 XCreateColormap(demo->display, RootWindow(demo->display, vInfoTemplate.screen), visualInfo->visual, AllocNone);
2528 XSetWindowAttributes windowAttributes = {};
2529 windowAttributes.colormap = colormap;
2530 windowAttributes.background_pixel = 0xFFFFFFFF;
2531 windowAttributes.border_pixel = 0;
2532 windowAttributes.event_mask = KeyPressMask | KeyReleaseMask | StructureNotifyMask | ExposureMask;
2534 demo->xlib_window = XCreateWindow(demo->display, RootWindow(demo->display, vInfoTemplate.screen), 0, 0, demo->width,
2535 demo->height, 0, visualInfo->depth, InputOutput, visualInfo->visual,
2536 CWBackPixel | CWBorderPixel | CWEventMask | CWColormap, &windowAttributes);
2538 XSelectInput(demo->display, demo->xlib_window, ExposureMask | KeyPressMask);
2539 XMapWindow(demo->display, demo->xlib_window);
2540 XFlush(demo->display);
2541 demo->xlib_wm_delete_window = XInternAtom(demo->display, "WM_DELETE_WINDOW", False);
2543 static void demo_handle_xlib_event(struct demo *demo, const XEvent *event) {
2544 switch (event->type) {
2546 if ((Atom)event->xclient.data.l[0] == demo->xlib_wm_delete_window) demo->quit = true;
2549 switch (event->xkey.keycode) {
2553 case 0x71: // left arrow key
2554 demo->spin_angle -= demo->spin_increment;
2556 case 0x72: // right arrow key
2557 demo->spin_angle += demo->spin_increment;
2559 case 0x41: // space bar
2560 demo->pause = !demo->pause;
2564 case ConfigureNotify:
2565 if ((demo->width != event->xconfigure.width) || (demo->height != event->xconfigure.height)) {
2566 demo->width = event->xconfigure.width;
2567 demo->height = event->xconfigure.height;
2576 static void demo_run_xlib(struct demo *demo) {
2577 while (!demo->quit) {
2581 XNextEvent(demo->display, &event);
2582 demo_handle_xlib_event(demo, &event);
2584 while (XPending(demo->display) > 0) {
2585 XNextEvent(demo->display, &event);
2586 demo_handle_xlib_event(demo, &event);
2591 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) demo->quit = true;
2594 #elif defined(VK_USE_PLATFORM_XCB_KHR)
2595 static void demo_handle_xcb_event(struct demo *demo, const xcb_generic_event_t *event) {
2596 uint8_t event_code = event->response_type & 0x7f;
2597 switch (event_code) {
2599 // TODO: Resize window
2601 case XCB_CLIENT_MESSAGE:
2602 if ((*(xcb_client_message_event_t *)event).data.data32[0] == (*demo->atom_wm_delete_window).atom) {
2606 case XCB_KEY_RELEASE: {
2607 const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
2609 switch (key->detail) {
2613 case 0x71: // left arrow key
2614 demo->spin_angle -= demo->spin_increment;
2616 case 0x72: // right arrow key
2617 demo->spin_angle += demo->spin_increment;
2619 case 0x41: // space bar
2620 demo->pause = !demo->pause;
2624 case XCB_CONFIGURE_NOTIFY: {
2625 const xcb_configure_notify_event_t *cfg = (const xcb_configure_notify_event_t *)event;
2626 if ((demo->width != cfg->width) || (demo->height != cfg->height)) {
2627 demo->width = cfg->width;
2628 demo->height = cfg->height;
2637 static void demo_run_xcb(struct demo *demo) {
2638 xcb_flush(demo->connection);
2640 while (!demo->quit) {
2641 xcb_generic_event_t *event;
2644 event = xcb_wait_for_event(demo->connection);
2646 event = xcb_poll_for_event(demo->connection);
2649 demo_handle_xcb_event(demo, event);
2651 event = xcb_poll_for_event(demo->connection);
2656 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) demo->quit = true;
2660 static void demo_create_xcb_window(struct demo *demo) {
2661 uint32_t value_mask, value_list[32];
2663 demo->xcb_window = xcb_generate_id(demo->connection);
2665 value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
2666 value_list[0] = demo->screen->black_pixel;
2667 value_list[1] = XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
2669 xcb_create_window(demo->connection, XCB_COPY_FROM_PARENT, demo->xcb_window, demo->screen->root, 0, 0, demo->width, demo->height,
2670 0, XCB_WINDOW_CLASS_INPUT_OUTPUT, demo->screen->root_visual, value_mask, value_list);
2672 /* Magic code that will send notification when window is destroyed */
2673 xcb_intern_atom_cookie_t cookie = xcb_intern_atom(demo->connection, 1, 12, "WM_PROTOCOLS");
2674 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(demo->connection, cookie, 0);
2676 xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(demo->connection, 0, 16, "WM_DELETE_WINDOW");
2677 demo->atom_wm_delete_window = xcb_intern_atom_reply(demo->connection, cookie2, 0);
2679 xcb_change_property(demo->connection, XCB_PROP_MODE_REPLACE, demo->xcb_window, (*reply).atom, 4, 32, 1,
2680 &(*demo->atom_wm_delete_window).atom);
2683 xcb_map_window(demo->connection, demo->xcb_window);
2685 // Force the x/y coordinates to 100,100 results are identical in consecutive
2687 const uint32_t coords[] = {100, 100};
2688 xcb_configure_window(demo->connection, demo->xcb_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, coords);
2690 // VK_USE_PLATFORM_XCB_KHR
2691 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2692 static void demo_run(struct demo *demo) {
2693 while (!demo->quit) {
2695 wl_display_dispatch(demo->display); // block and wait for input
2697 wl_display_dispatch_pending(demo->display); // don't block
2700 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) demo->quit = true;
2705 static void handle_ping(void *data UNUSED, struct wl_shell_surface *shell_surface, uint32_t serial) {
2706 wl_shell_surface_pong(shell_surface, serial);
2709 static void handle_configure(void *data UNUSED, struct wl_shell_surface *shell_surface UNUSED, uint32_t edges UNUSED,
2710 int32_t width UNUSED, int32_t height UNUSED) {}
2712 static void handle_popup_done(void *data UNUSED, struct wl_shell_surface *shell_surface UNUSED) {}
2714 static const struct wl_shell_surface_listener shell_surface_listener = {handle_ping, handle_configure, handle_popup_done};
2716 static void demo_create_window(struct demo *demo) {
2717 demo->window = wl_compositor_create_surface(demo->compositor);
2718 if (!demo->window) {
2719 printf("Can not create wayland_surface from compositor!\n");
2724 demo->shell_surface = wl_shell_get_shell_surface(demo->shell, demo->window);
2725 if (!demo->shell_surface) {
2726 printf("Can not get shell_surface from wayland_surface!\n");
2730 wl_shell_surface_add_listener(demo->shell_surface, &shell_surface_listener, demo);
2731 wl_shell_surface_set_toplevel(demo->shell_surface);
2732 wl_shell_surface_set_title(demo->shell_surface, APP_SHORT_NAME);
2734 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
2735 static void demo_run(struct demo *demo) {
2736 if (!demo->prepared) return;
2741 #elif defined(VK_USE_PLATFORM_MACOS_MVK)
2742 static void demo_run(struct demo *demo) {
2745 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) {
2749 #elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2750 static VkResult demo_create_display_surface(struct demo *demo) {
2751 VkResult U_ASSERT_ONLY err;
2752 uint32_t display_count;
2753 uint32_t mode_count;
2754 uint32_t plane_count;
2755 VkDisplayPropertiesKHR display_props;
2756 VkDisplayKHR display;
2757 VkDisplayModePropertiesKHR mode_props;
2758 VkDisplayPlanePropertiesKHR *plane_props;
2759 VkBool32 found_plane = VK_FALSE;
2760 uint32_t plane_index;
2761 VkExtent2D image_extent;
2762 VkDisplaySurfaceCreateInfoKHR create_info;
2764 // Get the first display
2765 err = vkGetPhysicalDeviceDisplayPropertiesKHR(demo->gpu, &display_count, NULL);
2768 if (display_count == 0) {
2769 printf("Cannot find any display!\n");
2775 err = vkGetPhysicalDeviceDisplayPropertiesKHR(demo->gpu, &display_count, &display_props);
2776 assert(!err || (err == VK_INCOMPLETE));
2778 display = display_props.display;
2780 // Get the first mode of the display
2781 err = vkGetDisplayModePropertiesKHR(demo->gpu, display, &mode_count, NULL);
2784 if (mode_count == 0) {
2785 printf("Cannot find any mode for the display!\n");
2791 err = vkGetDisplayModePropertiesKHR(demo->gpu, display, &mode_count, &mode_props);
2792 assert(!err || (err == VK_INCOMPLETE));
2794 // Get the list of planes
2795 err = vkGetPhysicalDeviceDisplayPlanePropertiesKHR(demo->gpu, &plane_count, NULL);
2798 if (plane_count == 0) {
2799 printf("Cannot find any plane!\n");
2804 plane_props = malloc(sizeof(VkDisplayPlanePropertiesKHR) * plane_count);
2805 assert(plane_props);
2807 err = vkGetPhysicalDeviceDisplayPlanePropertiesKHR(demo->gpu, &plane_count, plane_props);
2810 // Find a plane compatible with the display
2811 for (plane_index = 0; plane_index < plane_count; plane_index++) {
2812 uint32_t supported_count;
2813 VkDisplayKHR *supported_displays;
2815 // Disqualify planes that are bound to a different display
2816 if ((plane_props[plane_index].currentDisplay != VK_NULL_HANDLE) && (plane_props[plane_index].currentDisplay != display)) {
2820 err = vkGetDisplayPlaneSupportedDisplaysKHR(demo->gpu, plane_index, &supported_count, NULL);
2823 if (supported_count == 0) {
2827 supported_displays = malloc(sizeof(VkDisplayKHR) * supported_count);
2828 assert(supported_displays);
2830 err = vkGetDisplayPlaneSupportedDisplaysKHR(demo->gpu, plane_index, &supported_count, supported_displays);
2833 for (uint32_t i = 0; i < supported_count; i++) {
2834 if (supported_displays[i] == display) {
2835 found_plane = VK_TRUE;
2840 free(supported_displays);
2848 printf("Cannot find a plane compatible with the display!\n");
2855 VkDisplayPlaneCapabilitiesKHR planeCaps;
2856 vkGetDisplayPlaneCapabilitiesKHR(demo->gpu, mode_props.displayMode, plane_index, &planeCaps);
2857 // Find a supported alpha mode
2858 VkCompositeAlphaFlagBitsKHR alphaMode = VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR;
2859 VkCompositeAlphaFlagBitsKHR alphaModes[4] = {
2860 VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR,
2861 VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR,
2862 VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR,
2863 VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR,
2865 for (uint32_t i = 0; i < sizeof(alphaModes); i++) {
2866 if (planeCaps.supportedAlpha & alphaModes[i]) {
2867 alphaMode = alphaModes[i];
2871 image_extent.width = mode_props.parameters.visibleRegion.width;
2872 image_extent.height = mode_props.parameters.visibleRegion.height;
2874 create_info.sType = VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR;
2875 create_info.pNext = NULL;
2876 create_info.flags = 0;
2877 create_info.displayMode = mode_props.displayMode;
2878 create_info.planeIndex = plane_index;
2879 create_info.planeStackIndex = plane_props[plane_index].currentStackIndex;
2880 create_info.transform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
2881 create_info.alphaMode = alphaMode;
2882 create_info.globalAlpha = 1.0f;
2883 create_info.imageExtent = image_extent;
2885 return vkCreateDisplayPlaneSurfaceKHR(demo->inst, &create_info, NULL, &demo->surface);
2888 static void demo_run_display(struct demo *demo) {
2889 while (!demo->quit) {
2893 if (demo->frameCount != INT32_MAX && demo->curFrame == demo->frameCount) {
2901 * Return 1 (true) if all layer names specified in check_names
2902 * can be found in given layer properties.
2904 static VkBool32 demo_check_layers(uint32_t check_count, char **check_names, uint32_t layer_count, VkLayerProperties *layers) {
2905 for (uint32_t i = 0; i < check_count; i++) {
2907 for (uint32_t j = 0; j < layer_count; j++) {
2908 if (!strcmp(check_names[i], layers[j].layerName)) {
2914 fprintf(stderr, "Cannot find layer: %s\n", check_names[i]);
2921 static void demo_init_vk(struct demo *demo) {
2923 uint32_t instance_extension_count = 0;
2924 uint32_t instance_layer_count = 0;
2925 char *instance_validation_layers[] = {"VK_LAYER_KHRONOS_validation"};
2926 demo->enabled_extension_count = 0;
2927 demo->enabled_layer_count = 0;
2928 demo->is_minimized = false;
2929 demo->cmd_pool = VK_NULL_HANDLE;
2931 // Look for validation layers
2932 VkBool32 validation_found = 0;
2933 if (demo->validate) {
2934 err = vkEnumerateInstanceLayerProperties(&instance_layer_count, NULL);
2937 if (instance_layer_count > 0) {
2938 VkLayerProperties *instance_layers = malloc(sizeof(VkLayerProperties) * instance_layer_count);
2939 err = vkEnumerateInstanceLayerProperties(&instance_layer_count, instance_layers);
2942 validation_found = demo_check_layers(ARRAY_SIZE(instance_validation_layers), instance_validation_layers,
2943 instance_layer_count, instance_layers);
2944 if (validation_found) {
2945 demo->enabled_layer_count = ARRAY_SIZE(instance_validation_layers);
2946 demo->enabled_layers[0] = "VK_LAYER_KHRONOS_validation";
2948 free(instance_layers);
2951 if (!validation_found) {
2953 "vkEnumerateInstanceLayerProperties failed to find required validation layer.\n\n"
2954 "Please look at the Getting Started guide for additional information.\n",
2955 "vkCreateInstance Failure");
2959 /* Look for instance extensions */
2960 VkBool32 surfaceExtFound = 0;
2961 VkBool32 platformSurfaceExtFound = 0;
2962 memset(demo->extension_names, 0, sizeof(demo->extension_names));
2964 err = vkEnumerateInstanceExtensionProperties(NULL, &instance_extension_count, NULL);
2967 if (instance_extension_count > 0) {
2968 VkExtensionProperties *instance_extensions = malloc(sizeof(VkExtensionProperties) * instance_extension_count);
2969 err = vkEnumerateInstanceExtensionProperties(NULL, &instance_extension_count, instance_extensions);
2971 for (uint32_t i = 0; i < instance_extension_count; i++) {
2972 if (!strcmp(VK_KHR_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2973 surfaceExtFound = 1;
2974 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_SURFACE_EXTENSION_NAME;
2976 #if defined(VK_USE_PLATFORM_WIN32_KHR)
2977 if (!strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2978 platformSurfaceExtFound = 1;
2979 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_WIN32_SURFACE_EXTENSION_NAME;
2981 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
2982 if (!strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2983 platformSurfaceExtFound = 1;
2984 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_XLIB_SURFACE_EXTENSION_NAME;
2986 #elif defined(VK_USE_PLATFORM_XCB_KHR)
2987 if (!strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2988 platformSurfaceExtFound = 1;
2989 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_XCB_SURFACE_EXTENSION_NAME;
2991 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2992 if (!strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2993 platformSurfaceExtFound = 1;
2994 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME;
2996 #elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2997 if (!strcmp(VK_KHR_DISPLAY_EXTENSION_NAME, instance_extensions[i].extensionName)) {
2998 platformSurfaceExtFound = 1;
2999 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_DISPLAY_EXTENSION_NAME;
3001 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
3002 if (!strcmp(VK_KHR_ANDROID_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
3003 platformSurfaceExtFound = 1;
3004 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_ANDROID_SURFACE_EXTENSION_NAME;
3006 #elif defined(VK_USE_PLATFORM_IOS_MVK)
3007 if (!strcmp(VK_MVK_IOS_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
3008 platformSurfaceExtFound = 1;
3009 demo->extension_names[demo->enabled_extension_count++] = VK_MVK_IOS_SURFACE_EXTENSION_NAME;
3011 #elif defined(VK_USE_PLATFORM_MACOS_MVK)
3012 if (!strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
3013 platformSurfaceExtFound = 1;
3014 demo->extension_names[demo->enabled_extension_count++] = VK_MVK_MACOS_SURFACE_EXTENSION_NAME;
3017 if (!strcmp(VK_EXT_DEBUG_UTILS_EXTENSION_NAME, instance_extensions[i].extensionName)) {
3018 if (demo->validate) {
3019 demo->extension_names[demo->enabled_extension_count++] = VK_EXT_DEBUG_UTILS_EXTENSION_NAME;
3022 assert(demo->enabled_extension_count < 64);
3025 free(instance_extensions);
3028 if (!surfaceExtFound) {
3029 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_SURFACE_EXTENSION_NAME
3031 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3032 "Please look at the Getting Started guide for additional information.\n",
3033 "vkCreateInstance Failure");
3035 if (!platformSurfaceExtFound) {
3036 #if defined(VK_USE_PLATFORM_WIN32_KHR)
3037 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WIN32_SURFACE_EXTENSION_NAME
3039 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3040 "Please look at the Getting Started guide for additional information.\n",
3041 "vkCreateInstance Failure");
3042 #elif defined(VK_USE_PLATFORM_IOS_MVK)
3043 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_MVK_IOS_SURFACE_EXTENSION_NAME
3045 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3046 "Please look at the Getting Started guide for additional information.\n",
3047 "vkCreateInstance Failure");
3048 #elif defined(VK_USE_PLATFORM_MACOS_MVK)
3049 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_MVK_MACOS_SURFACE_EXTENSION_NAME
3051 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3052 "Please look at the Getting Started guide for additional information.\n",
3053 "vkCreateInstance Failure");
3054 #elif defined(VK_USE_PLATFORM_XCB_KHR)
3055 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XCB_SURFACE_EXTENSION_NAME
3057 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3058 "Please look at the Getting Started guide for additional information.\n",
3059 "vkCreateInstance Failure");
3060 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
3061 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME
3063 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3064 "Please look at the Getting Started guide for additional information.\n",
3065 "vkCreateInstance Failure");
3066 #elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3067 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_DISPLAY_EXTENSION_NAME
3069 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3070 "Please look at the Getting Started guide for additional information.\n",
3071 "vkCreateInstance Failure");
3072 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
3073 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
3075 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3076 "Please look at the Getting Started guide for additional information.\n",
3077 "vkCreateInstance Failure");
3078 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
3079 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XLIB_SURFACE_EXTENSION_NAME
3081 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3082 "Please look at the Getting Started guide for additional information.\n",
3083 "vkCreateInstance Failure");
3086 const VkApplicationInfo app = {
3087 .sType = VK_STRUCTURE_TYPE_APPLICATION_INFO,
3089 .pApplicationName = APP_SHORT_NAME,
3090 .applicationVersion = 0,
3091 .pEngineName = APP_SHORT_NAME,
3093 .apiVersion = VK_API_VERSION_1_0,
3095 VkInstanceCreateInfo inst_info = {
3096 .sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
3098 .pApplicationInfo = &app,
3099 .enabledLayerCount = demo->enabled_layer_count,
3100 .ppEnabledLayerNames = (const char *const *)instance_validation_layers,
3101 .enabledExtensionCount = demo->enabled_extension_count,
3102 .ppEnabledExtensionNames = (const char *const *)demo->extension_names,
3106 * This is info for a temp callback to use during CreateInstance.
3107 * After the instance is created, we use the instance-based
3108 * function to register the final callback.
3110 VkDebugUtilsMessengerCreateInfoEXT dbg_messenger_create_info;
3111 if (demo->validate) {
3112 // VK_EXT_debug_utils style
3113 dbg_messenger_create_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
3114 dbg_messenger_create_info.pNext = NULL;
3115 dbg_messenger_create_info.flags = 0;
3116 dbg_messenger_create_info.messageSeverity =
3117 VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
3118 dbg_messenger_create_info.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
3119 VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
3120 VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
3121 dbg_messenger_create_info.pfnUserCallback = debug_messenger_callback;
3122 dbg_messenger_create_info.pUserData = demo;
3123 inst_info.pNext = &dbg_messenger_create_info;
3128 err = vkCreateInstance(&inst_info, NULL, &demo->inst);
3129 if (err == VK_ERROR_INCOMPATIBLE_DRIVER) {
3131 "Cannot find a compatible Vulkan installable client driver (ICD).\n\n"
3132 "Please look at the Getting Started guide for additional information.\n",
3133 "vkCreateInstance Failure");
3134 } else if (err == VK_ERROR_EXTENSION_NOT_PRESENT) {
3136 "Cannot find a specified extension library.\n"
3137 "Make sure your layers path is set appropriately.\n",
3138 "vkCreateInstance Failure");
3141 "vkCreateInstance failed.\n\n"
3142 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3143 "Please look at the Getting Started guide for additional information.\n",
3144 "vkCreateInstance Failure");
3147 /* Make initial call to query gpu_count, then second call for gpu info*/
3148 err = vkEnumeratePhysicalDevices(demo->inst, &gpu_count, NULL);
3151 if (gpu_count > 0) {
3152 VkPhysicalDevice *physical_devices = malloc(sizeof(VkPhysicalDevice) * gpu_count);
3153 err = vkEnumeratePhysicalDevices(demo->inst, &gpu_count, physical_devices);
3155 /* For cube demo we just grab the first physical device */
3156 demo->gpu = physical_devices[0];
3157 free(physical_devices);
3160 "vkEnumeratePhysicalDevices reported zero accessible devices.\n\n"
3161 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
3162 "Please look at the Getting Started guide for additional information.\n",
3163 "vkEnumeratePhysicalDevices Failure");
3166 /* Look for device extensions */
3167 uint32_t device_extension_count = 0;
3168 VkBool32 swapchainExtFound = 0;
3169 demo->enabled_extension_count = 0;
3170 memset(demo->extension_names, 0, sizeof(demo->extension_names));
3172 err = vkEnumerateDeviceExtensionProperties(demo->gpu, NULL, &device_extension_count, NULL);
3175 if (device_extension_count > 0) {
3176 VkExtensionProperties *device_extensions = malloc(sizeof(VkExtensionProperties) * device_extension_count);
3177 err = vkEnumerateDeviceExtensionProperties(demo->gpu, NULL, &device_extension_count, device_extensions);
3180 for (uint32_t i = 0; i < device_extension_count; i++) {
3181 if (!strcmp(VK_KHR_SWAPCHAIN_EXTENSION_NAME, device_extensions[i].extensionName)) {
3182 swapchainExtFound = 1;
3183 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_SWAPCHAIN_EXTENSION_NAME;
3185 assert(demo->enabled_extension_count < 64);
3188 if (demo->VK_KHR_incremental_present_enabled) {
3189 // Even though the user "enabled" the extension via the command
3190 // line, we must make sure that it's enumerated for use with the
3191 // device. Therefore, disable it here, and re-enable it again if
3193 demo->VK_KHR_incremental_present_enabled = false;
3194 for (uint32_t i = 0; i < device_extension_count; i++) {
3195 if (!strcmp(VK_KHR_INCREMENTAL_PRESENT_EXTENSION_NAME, device_extensions[i].extensionName)) {
3196 demo->extension_names[demo->enabled_extension_count++] = VK_KHR_INCREMENTAL_PRESENT_EXTENSION_NAME;
3197 demo->VK_KHR_incremental_present_enabled = true;
3198 DbgMsg("VK_KHR_incremental_present extension enabled\n");
3200 assert(demo->enabled_extension_count < 64);
3202 if (!demo->VK_KHR_incremental_present_enabled) {
3203 DbgMsg("VK_KHR_incremental_present extension NOT AVAILABLE\n");
3207 if (demo->VK_GOOGLE_display_timing_enabled) {
3208 // Even though the user "enabled" the extension via the command
3209 // line, we must make sure that it's enumerated for use with the
3210 // device. Therefore, disable it here, and re-enable it again if
3212 demo->VK_GOOGLE_display_timing_enabled = false;
3213 for (uint32_t i = 0; i < device_extension_count; i++) {
3214 if (!strcmp(VK_GOOGLE_DISPLAY_TIMING_EXTENSION_NAME, device_extensions[i].extensionName)) {
3215 demo->extension_names[demo->enabled_extension_count++] = VK_GOOGLE_DISPLAY_TIMING_EXTENSION_NAME;
3216 demo->VK_GOOGLE_display_timing_enabled = true;
3217 DbgMsg("VK_GOOGLE_display_timing extension enabled\n");
3219 assert(demo->enabled_extension_count < 64);
3221 if (!demo->VK_GOOGLE_display_timing_enabled) {
3222 DbgMsg("VK_GOOGLE_display_timing extension NOT AVAILABLE\n");
3226 free(device_extensions);
3229 if (!swapchainExtFound) {
3230 ERR_EXIT("vkEnumerateDeviceExtensionProperties failed to find the " VK_KHR_SWAPCHAIN_EXTENSION_NAME
3231 " extension.\n\nDo you have a compatible Vulkan installable client driver (ICD) installed?\n"
3232 "Please look at the Getting Started guide for additional information.\n",
3233 "vkCreateInstance Failure");
3236 if (demo->validate) {
3237 // Setup VK_EXT_debug_utils function pointers always (we use them for
3238 // debug labels and names).
3239 demo->CreateDebugUtilsMessengerEXT =
3240 (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(demo->inst, "vkCreateDebugUtilsMessengerEXT");
3241 demo->DestroyDebugUtilsMessengerEXT =
3242 (PFN_vkDestroyDebugUtilsMessengerEXT)vkGetInstanceProcAddr(demo->inst, "vkDestroyDebugUtilsMessengerEXT");
3243 demo->SubmitDebugUtilsMessageEXT =
3244 (PFN_vkSubmitDebugUtilsMessageEXT)vkGetInstanceProcAddr(demo->inst, "vkSubmitDebugUtilsMessageEXT");
3245 demo->CmdBeginDebugUtilsLabelEXT =
3246 (PFN_vkCmdBeginDebugUtilsLabelEXT)vkGetInstanceProcAddr(demo->inst, "vkCmdBeginDebugUtilsLabelEXT");
3247 demo->CmdEndDebugUtilsLabelEXT =
3248 (PFN_vkCmdEndDebugUtilsLabelEXT)vkGetInstanceProcAddr(demo->inst, "vkCmdEndDebugUtilsLabelEXT");
3249 demo->CmdInsertDebugUtilsLabelEXT =
3250 (PFN_vkCmdInsertDebugUtilsLabelEXT)vkGetInstanceProcAddr(demo->inst, "vkCmdInsertDebugUtilsLabelEXT");
3251 demo->SetDebugUtilsObjectNameEXT =
3252 (PFN_vkSetDebugUtilsObjectNameEXT)vkGetInstanceProcAddr(demo->inst, "vkSetDebugUtilsObjectNameEXT");
3253 if (NULL == demo->CreateDebugUtilsMessengerEXT || NULL == demo->DestroyDebugUtilsMessengerEXT ||
3254 NULL == demo->SubmitDebugUtilsMessageEXT || NULL == demo->CmdBeginDebugUtilsLabelEXT ||
3255 NULL == demo->CmdEndDebugUtilsLabelEXT || NULL == demo->CmdInsertDebugUtilsLabelEXT ||
3256 NULL == demo->SetDebugUtilsObjectNameEXT) {
3257 ERR_EXIT("GetProcAddr: Failed to init VK_EXT_debug_utils\n", "GetProcAddr: Failure");
3260 err = demo->CreateDebugUtilsMessengerEXT(demo->inst, &dbg_messenger_create_info, NULL, &demo->dbg_messenger);
3264 case VK_ERROR_OUT_OF_HOST_MEMORY:
3265 ERR_EXIT("CreateDebugUtilsMessengerEXT: out of host memory\n", "CreateDebugUtilsMessengerEXT Failure");
3268 ERR_EXIT("CreateDebugUtilsMessengerEXT: unknown failure\n", "CreateDebugUtilsMessengerEXT Failure");
3272 vkGetPhysicalDeviceProperties(demo->gpu, &demo->gpu_props);
3274 /* Call with NULL data to get count */
3275 vkGetPhysicalDeviceQueueFamilyProperties(demo->gpu, &demo->queue_family_count, NULL);
3276 assert(demo->queue_family_count >= 1);
3278 demo->queue_props = (VkQueueFamilyProperties *)malloc(demo->queue_family_count * sizeof(VkQueueFamilyProperties));
3279 vkGetPhysicalDeviceQueueFamilyProperties(demo->gpu, &demo->queue_family_count, demo->queue_props);
3281 // Query fine-grained feature support for this device.
3282 // If app has specific feature requirements it should check supported
3283 // features based on this query
3284 VkPhysicalDeviceFeatures physDevFeatures;
3285 vkGetPhysicalDeviceFeatures(demo->gpu, &physDevFeatures);
3287 GET_INSTANCE_PROC_ADDR(demo->inst, GetPhysicalDeviceSurfaceSupportKHR);
3288 GET_INSTANCE_PROC_ADDR(demo->inst, GetPhysicalDeviceSurfaceCapabilitiesKHR);
3289 GET_INSTANCE_PROC_ADDR(demo->inst, GetPhysicalDeviceSurfaceFormatsKHR);
3290 GET_INSTANCE_PROC_ADDR(demo->inst, GetPhysicalDeviceSurfacePresentModesKHR);
3291 GET_INSTANCE_PROC_ADDR(demo->inst, GetSwapchainImagesKHR);
3294 static void demo_create_device(struct demo *demo) {
3295 VkResult U_ASSERT_ONLY err;
3296 float queue_priorities[1] = {0.0};
3297 VkDeviceQueueCreateInfo queues[2];
3298 queues[0].sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO;
3299 queues[0].pNext = NULL;
3300 queues[0].queueFamilyIndex = demo->graphics_queue_family_index;
3301 queues[0].queueCount = 1;
3302 queues[0].pQueuePriorities = queue_priorities;
3303 queues[0].flags = 0;
3305 VkDeviceCreateInfo device = {
3306 .sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
3308 .queueCreateInfoCount = 1,
3309 .pQueueCreateInfos = queues,
3310 .enabledLayerCount = 0,
3311 .ppEnabledLayerNames = NULL,
3312 .enabledExtensionCount = demo->enabled_extension_count,
3313 .ppEnabledExtensionNames = (const char *const *)demo->extension_names,
3314 .pEnabledFeatures = NULL, // If specific features are required, pass them in here
3316 if (demo->separate_present_queue) {
3317 queues[1].sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO;
3318 queues[1].pNext = NULL;
3319 queues[1].queueFamilyIndex = demo->present_queue_family_index;
3320 queues[1].queueCount = 1;
3321 queues[1].pQueuePriorities = queue_priorities;
3322 queues[1].flags = 0;
3323 device.queueCreateInfoCount = 2;
3325 err = vkCreateDevice(demo->gpu, &device, NULL, &demo->device);
3329 static void demo_init_vk_swapchain(struct demo *demo) {
3330 VkResult U_ASSERT_ONLY err;
3332 // Create a WSI surface for the window:
3333 #if defined(VK_USE_PLATFORM_WIN32_KHR)
3334 VkWin32SurfaceCreateInfoKHR createInfo;
3335 createInfo.sType = VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR;
3336 createInfo.pNext = NULL;
3337 createInfo.flags = 0;
3338 createInfo.hinstance = demo->connection;
3339 createInfo.hwnd = demo->window;
3341 err = vkCreateWin32SurfaceKHR(demo->inst, &createInfo, NULL, &demo->surface);
3342 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
3343 VkWaylandSurfaceCreateInfoKHR createInfo;
3344 createInfo.sType = VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR;
3345 createInfo.pNext = NULL;
3346 createInfo.flags = 0;
3347 createInfo.display = demo->display;
3348 createInfo.surface = demo->window;
3350 err = vkCreateWaylandSurfaceKHR(demo->inst, &createInfo, NULL, &demo->surface);
3351 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
3352 VkAndroidSurfaceCreateInfoKHR createInfo;
3353 createInfo.sType = VK_STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR;
3354 createInfo.pNext = NULL;
3355 createInfo.flags = 0;
3356 createInfo.window = (struct ANativeWindow *)(demo->window);
3358 err = vkCreateAndroidSurfaceKHR(demo->inst, &createInfo, NULL, &demo->surface);
3359 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
3360 VkXlibSurfaceCreateInfoKHR createInfo;
3361 createInfo.sType = VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR;
3362 createInfo.pNext = NULL;
3363 createInfo.flags = 0;
3364 createInfo.dpy = demo->display;
3365 createInfo.window = demo->xlib_window;
3367 err = vkCreateXlibSurfaceKHR(demo->inst, &createInfo, NULL, &demo->surface);
3368 #elif defined(VK_USE_PLATFORM_XCB_KHR)
3369 VkXcbSurfaceCreateInfoKHR createInfo;
3370 createInfo.sType = VK_STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR;
3371 createInfo.pNext = NULL;
3372 createInfo.flags = 0;
3373 createInfo.connection = demo->connection;
3374 createInfo.window = demo->xcb_window;
3376 err = vkCreateXcbSurfaceKHR(demo->inst, &createInfo, NULL, &demo->surface);
3377 #elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3378 err = demo_create_display_surface(demo);
3379 #elif defined(VK_USE_PLATFORM_IOS_MVK)
3380 VkIOSSurfaceCreateInfoMVK surface;
3381 surface.sType = VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK;
3382 surface.pNext = NULL;
3384 surface.pView = demo->window;
3386 err = vkCreateIOSSurfaceMVK(demo->inst, &surface, NULL, &demo->surface);
3387 #elif defined(VK_USE_PLATFORM_MACOS_MVK)
3388 VkMacOSSurfaceCreateInfoMVK surface;
3389 surface.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
3390 surface.pNext = NULL;
3392 surface.pView = demo->window;
3394 err = vkCreateMacOSSurfaceMVK(demo->inst, &surface, NULL, &demo->surface);
3398 // Iterate over each queue to learn whether it supports presenting:
3399 VkBool32 *supportsPresent = (VkBool32 *)malloc(demo->queue_family_count * sizeof(VkBool32));
3400 for (uint32_t i = 0; i < demo->queue_family_count; i++) {
3401 demo->fpGetPhysicalDeviceSurfaceSupportKHR(demo->gpu, i, demo->surface, &supportsPresent[i]);
3404 // Search for a graphics and a present queue in the array of queue
3405 // families, try to find one that supports both
3406 uint32_t graphicsQueueFamilyIndex = UINT32_MAX;
3407 uint32_t presentQueueFamilyIndex = UINT32_MAX;
3408 for (uint32_t i = 0; i < demo->queue_family_count; i++) {
3409 if ((demo->queue_props[i].queueFlags & VK_QUEUE_GRAPHICS_BIT) != 0) {
3410 if (graphicsQueueFamilyIndex == UINT32_MAX) {
3411 graphicsQueueFamilyIndex = i;
3414 if (supportsPresent[i] == VK_TRUE) {
3415 graphicsQueueFamilyIndex = i;
3416 presentQueueFamilyIndex = i;
3422 if (presentQueueFamilyIndex == UINT32_MAX) {
3423 // If didn't find a queue that supports both graphics and present, then
3424 // find a separate present queue.
3425 for (uint32_t i = 0; i < demo->queue_family_count; ++i) {
3426 if (supportsPresent[i] == VK_TRUE) {
3427 presentQueueFamilyIndex = i;
3433 // Generate error if could not find both a graphics and a present queue
3434 if (graphicsQueueFamilyIndex == UINT32_MAX || presentQueueFamilyIndex == UINT32_MAX) {
3435 ERR_EXIT("Could not find both graphics and present queues\n", "Swapchain Initialization Failure");
3438 demo->graphics_queue_family_index = graphicsQueueFamilyIndex;
3439 demo->present_queue_family_index = presentQueueFamilyIndex;
3440 demo->separate_present_queue = (demo->graphics_queue_family_index != demo->present_queue_family_index);
3441 free(supportsPresent);
3443 demo_create_device(demo);
3445 GET_DEVICE_PROC_ADDR(demo->device, CreateSwapchainKHR);
3446 GET_DEVICE_PROC_ADDR(demo->device, DestroySwapchainKHR);
3447 GET_DEVICE_PROC_ADDR(demo->device, GetSwapchainImagesKHR);
3448 GET_DEVICE_PROC_ADDR(demo->device, AcquireNextImageKHR);
3449 GET_DEVICE_PROC_ADDR(demo->device, QueuePresentKHR);
3450 if (demo->VK_GOOGLE_display_timing_enabled) {
3451 GET_DEVICE_PROC_ADDR(demo->device, GetRefreshCycleDurationGOOGLE);
3452 GET_DEVICE_PROC_ADDR(demo->device, GetPastPresentationTimingGOOGLE);
3455 vkGetDeviceQueue(demo->device, demo->graphics_queue_family_index, 0, &demo->graphics_queue);
3457 if (!demo->separate_present_queue) {
3458 demo->present_queue = demo->graphics_queue;
3460 vkGetDeviceQueue(demo->device, demo->present_queue_family_index, 0, &demo->present_queue);
3463 // Get the list of VkFormat's that are supported:
3464 uint32_t formatCount;
3465 err = demo->fpGetPhysicalDeviceSurfaceFormatsKHR(demo->gpu, demo->surface, &formatCount, NULL);
3467 VkSurfaceFormatKHR *surfFormats = (VkSurfaceFormatKHR *)malloc(formatCount * sizeof(VkSurfaceFormatKHR));
3468 err = demo->fpGetPhysicalDeviceSurfaceFormatsKHR(demo->gpu, demo->surface, &formatCount, surfFormats);
3470 // If the format list includes just one entry of VK_FORMAT_UNDEFINED,
3471 // the surface has no preferred format. Otherwise, at least one
3472 // supported format will be returned.
3473 if (formatCount == 1 && surfFormats[0].format == VK_FORMAT_UNDEFINED) {
3474 demo->format = VK_FORMAT_B8G8R8A8_UNORM;
3476 assert(formatCount >= 1);
3477 demo->format = surfFormats[0].format;
3479 demo->color_space = surfFormats[0].colorSpace;
3485 // Create semaphores to synchronize acquiring presentable buffers before
3486 // rendering and waiting for drawing to be complete before presenting
3487 VkSemaphoreCreateInfo semaphoreCreateInfo = {
3488 .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO,
3493 // Create fences that we can use to throttle if we get too far
3494 // ahead of the image presents
3495 VkFenceCreateInfo fence_ci = {
3496 .sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO, .pNext = NULL, .flags = VK_FENCE_CREATE_SIGNALED_BIT};
3497 for (uint32_t i = 0; i < FRAME_LAG; i++) {
3498 err = vkCreateFence(demo->device, &fence_ci, NULL, &demo->fences[i]);
3501 err = vkCreateSemaphore(demo->device, &semaphoreCreateInfo, NULL, &demo->image_acquired_semaphores[i]);
3504 err = vkCreateSemaphore(demo->device, &semaphoreCreateInfo, NULL, &demo->draw_complete_semaphores[i]);
3507 if (demo->separate_present_queue) {
3508 err = vkCreateSemaphore(demo->device, &semaphoreCreateInfo, NULL, &demo->image_ownership_semaphores[i]);
3512 demo->frame_index = 0;
3514 // Get Memory information and properties
3515 vkGetPhysicalDeviceMemoryProperties(demo->gpu, &demo->memory_properties);
3518 #if defined(VK_USE_PLATFORM_WAYLAND_KHR)
3519 static void pointer_handle_enter(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t sx,
3522 static void pointer_handle_leave(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) {}
3524 static void pointer_handle_motion(void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) {}
3526 static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button,
3528 struct demo *demo = data;
3529 if (button == BTN_LEFT && state == WL_POINTER_BUTTON_STATE_PRESSED) {
3530 wl_shell_surface_move(demo->shell_surface, demo->seat, serial);
3534 static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {}
3536 static const struct wl_pointer_listener pointer_listener = {
3537 pointer_handle_enter, pointer_handle_leave, pointer_handle_motion, pointer_handle_button, pointer_handle_axis,
3540 static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) {}
3542 static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface,
3543 struct wl_array *keys) {}
3545 static void keyboard_handle_leave(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) {}
3547 static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key,
3549 if (state != WL_KEYBOARD_KEY_STATE_RELEASED) return;
3550 struct demo *demo = data;
3552 case KEY_ESC: // Escape
3555 case KEY_LEFT: // left arrow key
3556 demo->spin_angle -= demo->spin_increment;
3558 case KEY_RIGHT: // right arrow key
3559 demo->spin_angle += demo->spin_increment;
3561 case KEY_SPACE: // space bar
3562 demo->pause = !demo->pause;
3567 static void keyboard_handle_modifiers(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed,
3568 uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {}
3570 static const struct wl_keyboard_listener keyboard_listener = {
3571 keyboard_handle_keymap, keyboard_handle_enter, keyboard_handle_leave, keyboard_handle_key, keyboard_handle_modifiers,
3574 static void seat_handle_capabilities(void *data, struct wl_seat *seat, enum wl_seat_capability caps) {
3575 // Subscribe to pointer events
3576 struct demo *demo = data;
3577 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !demo->pointer) {
3578 demo->pointer = wl_seat_get_pointer(seat);
3579 wl_pointer_add_listener(demo->pointer, &pointer_listener, demo);
3580 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && demo->pointer) {
3581 wl_pointer_destroy(demo->pointer);
3582 demo->pointer = NULL;
3584 // Subscribe to keyboard events
3585 if (caps & WL_SEAT_CAPABILITY_KEYBOARD) {
3586 demo->keyboard = wl_seat_get_keyboard(seat);
3587 wl_keyboard_add_listener(demo->keyboard, &keyboard_listener, demo);
3588 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD)) {
3589 wl_keyboard_destroy(demo->keyboard);
3590 demo->keyboard = NULL;
3594 static const struct wl_seat_listener seat_listener = {
3595 seat_handle_capabilities,
3598 static void registry_handle_global(void *data, struct wl_registry *registry, uint32_t id, const char *interface,
3599 uint32_t version UNUSED) {
3600 struct demo *demo = data;
3601 // pickup wayland objects when they appear
3602 if (strcmp(interface, "wl_compositor") == 0) {
3603 demo->compositor = wl_registry_bind(registry, id, &wl_compositor_interface, 1);
3604 } else if (strcmp(interface, "wl_shell") == 0) {
3605 demo->shell = wl_registry_bind(registry, id, &wl_shell_interface, 1);
3606 } else if (strcmp(interface, "wl_seat") == 0) {
3607 demo->seat = wl_registry_bind(registry, id, &wl_seat_interface, 1);
3608 wl_seat_add_listener(demo->seat, &seat_listener, demo);
3612 static void registry_handle_global_remove(void *data UNUSED, struct wl_registry *registry UNUSED, uint32_t name UNUSED) {}
3614 static const struct wl_registry_listener registry_listener = {registry_handle_global, registry_handle_global_remove};
3617 static void demo_init_connection(struct demo *demo) {
3618 #if defined(VK_USE_PLATFORM_XCB_KHR)
3619 const xcb_setup_t *setup;
3620 xcb_screen_iterator_t iter;
3623 const char *display_envar = getenv("DISPLAY");
3624 if (display_envar == NULL || display_envar[0] == '\0') {
3625 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
3630 demo->connection = xcb_connect(NULL, &scr);
3631 if (xcb_connection_has_error(demo->connection) > 0) {
3632 printf("Cannot find a compatible Vulkan installable client driver (ICD).\nExiting ...\n");
3637 setup = xcb_get_setup(demo->connection);
3638 iter = xcb_setup_roots_iterator(setup);
3639 while (scr-- > 0) xcb_screen_next(&iter);
3641 demo->screen = iter.data;
3642 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
3643 demo->display = wl_display_connect(NULL);
3645 if (demo->display == NULL) {
3646 printf("Cannot find a compatible Vulkan installable client driver (ICD).\nExiting ...\n");
3651 demo->registry = wl_display_get_registry(demo->display);
3652 wl_registry_add_listener(demo->registry, ®istry_listener, demo);
3653 wl_display_dispatch(demo->display);
3657 static void demo_init(struct demo *demo, int argc, char **argv) {
3658 vec3 eye = {0.0f, 3.0f, 5.0f};
3659 vec3 origin = {0, 0, 0};
3660 vec3 up = {0.0f, 1.0f, 0.0};
3662 memset(demo, 0, sizeof(*demo));
3663 demo->presentMode = VK_PRESENT_MODE_FIFO_KHR;
3664 demo->frameCount = INT32_MAX;
3666 for (int i = 1; i < argc; i++) {
3667 if (strcmp(argv[i], "--use_staging") == 0) {
3668 demo->use_staging_buffer = true;
3671 if ((strcmp(argv[i], "--present_mode") == 0) && (i < argc - 1)) {
3672 demo->presentMode = atoi(argv[i + 1]);
3676 if (strcmp(argv[i], "--break") == 0) {
3677 demo->use_break = true;
3680 if (strcmp(argv[i], "--validate") == 0) {
3681 demo->validate = true;
3684 if (strcmp(argv[i], "--validate-checks-disabled") == 0) {
3685 demo->validate = true;
3686 demo->validate_checks_disabled = true;
3689 if (strcmp(argv[i], "--xlib") == 0) {
3690 fprintf(stderr, "--xlib is deprecated and no longer does anything");
3693 if (strcmp(argv[i], "--c") == 0 && demo->frameCount == INT32_MAX && i < argc - 1 &&
3694 sscanf(argv[i + 1], "%d", &demo->frameCount) == 1 && demo->frameCount >= 0) {
3698 if (strcmp(argv[i], "--suppress_popups") == 0) {
3699 demo->suppress_popups = true;
3702 if (strcmp(argv[i], "--display_timing") == 0) {
3703 demo->VK_GOOGLE_display_timing_enabled = true;
3706 if (strcmp(argv[i], "--incremental_present") == 0) {
3707 demo->VK_KHR_incremental_present_enabled = true;
3711 #if defined(ANDROID)
3712 ERR_EXIT("Usage: vkcube [--validate]\n", "Usage");
3715 "Usage:\n %s\t[--use_staging] [--validate] [--validate-checks-disabled]\n"
3716 "\t[--break] [--c <framecount>] [--suppress_popups]\n"
3717 "\t[--incremental_present] [--display_timing]\n"
3718 "\t[--present_mode <present mode enum>]\n"
3719 "\t<present_mode_enum>\n"
3720 "\t\tVK_PRESENT_MODE_IMMEDIATE_KHR = %d\n"
3721 "\t\tVK_PRESENT_MODE_MAILBOX_KHR = %d\n"
3722 "\t\tVK_PRESENT_MODE_FIFO_KHR = %d\n"
3723 "\t\tVK_PRESENT_MODE_FIFO_RELAXED_KHR = %d\n";
3724 int length = snprintf(NULL, 0, message, APP_SHORT_NAME, VK_PRESENT_MODE_IMMEDIATE_KHR, VK_PRESENT_MODE_MAILBOX_KHR,
3725 VK_PRESENT_MODE_FIFO_KHR, VK_PRESENT_MODE_FIFO_RELAXED_KHR);
3726 char *usage = (char *)malloc(length + 1);
3730 snprintf(usage, length + 1, message, APP_SHORT_NAME, VK_PRESENT_MODE_IMMEDIATE_KHR, VK_PRESENT_MODE_MAILBOX_KHR,
3731 VK_PRESENT_MODE_FIFO_KHR, VK_PRESENT_MODE_FIFO_RELAXED_KHR);
3733 if (!demo->suppress_popups) MessageBox(NULL, usage, "Usage Error", MB_OK);
3735 fprintf(stderr, usage);
3743 demo_init_connection(demo);
3750 demo->spin_angle = 4.0f;
3751 demo->spin_increment = 0.2f;
3752 demo->pause = false;
3754 mat4x4_perspective(demo->projection_matrix, (float)degreesToRadians(45.0f), 1.0f, 0.1f, 100.0f);
3755 mat4x4_look_at(demo->view_matrix, eye, origin, up);
3756 mat4x4_identity(demo->model_matrix);
3758 demo->projection_matrix[1][1] *= -1; // Flip projection matrix from GL to Vulkan orientation.
3761 #if defined(VK_USE_PLATFORM_WIN32_KHR)
3762 // Include header required for parsing the command line options.
3763 #include <shellapi.h>
3765 int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR pCmdLine, int nCmdShow) {
3767 bool done; // flag saying when app is complete
3771 // Ensure wParam is initialized.
3774 // Use the CommandLine functions to get the command line arguments.
3775 // Unfortunately, Microsoft outputs
3776 // this information as wide characters for Unicode, and we simply want the
3777 // Ascii version to be compatible
3778 // with the non-Windows side. So, we have to convert the information to
3779 // Ascii character strings.
3780 LPWSTR *commandLineArgs = CommandLineToArgvW(GetCommandLineW(), &argc);
3781 if (NULL == commandLineArgs) {
3786 argv = (char **)malloc(sizeof(char *) * argc);
3790 for (int iii = 0; iii < argc; iii++) {
3791 size_t wideCharLen = wcslen(commandLineArgs[iii]);
3792 size_t numConverted = 0;
3794 argv[iii] = (char *)malloc(sizeof(char) * (wideCharLen + 1));
3795 if (argv[iii] != NULL) {
3796 wcstombs_s(&numConverted, argv[iii], wideCharLen + 1, commandLineArgs[iii], wideCharLen + 1);
3804 demo_init(&demo, argc, argv);
3806 // Free up the items we had to allocate for the command line arguments.
3807 if (argc > 0 && argv != NULL) {
3808 for (int iii = 0; iii < argc; iii++) {
3809 if (argv[iii] != NULL) {
3816 demo.connection = hInstance;
3817 strncpy(demo.name, "Vulkan Cube", APP_NAME_STR_LEN);
3818 demo_create_window(&demo);
3819 demo_init_vk_swapchain(&demo);
3821 demo_prepare(&demo);
3823 done = false; // initialize loop condition variable
3825 // main message loop
3828 const BOOL succ = WaitMessage();
3831 struct demo *tmp = &demo;
3832 struct demo *demo = tmp;
3833 ERR_EXIT("WaitMessage() failed on paused demo", "event loop error");
3836 PeekMessage(&msg, NULL, 0, 0, PM_REMOVE);
3837 if (msg.message == WM_QUIT) // check for a quit message
3839 done = true; // if found, quit app
3841 /* Translate and dispatch to event queue*/
3842 TranslateMessage(&msg);
3843 DispatchMessage(&msg);
3845 RedrawWindow(demo.window, NULL, NULL, RDW_INTERNALPAINT);
3848 demo_cleanup(&demo);
3850 return (int)msg.wParam;
3853 #elif defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK)
3854 static void demo_main(struct demo *demo, void *view, int argc, const char *argv[]) {
3856 demo_init(demo, argc, (char **)argv);
3857 demo->window = view;
3858 demo_init_vk_swapchain(demo);
3860 demo->spin_angle = 0.4f;
3863 #elif defined(VK_USE_PLATFORM_ANDROID_KHR)
3864 #include <android/log.h>
3865 #include <android_native_app_glue.h>
3866 #include "android_util.h"
3868 static bool initialized = false;
3869 static bool active = false;
3872 static int32_t processInput(struct android_app *app, AInputEvent *event) { return 0; }
3874 static void processCommand(struct android_app *app, int32_t cmd) {
3876 case APP_CMD_INIT_WINDOW: {
3878 // We're getting a new window. If the app is starting up, we
3879 // need to initialize. If the app has already been
3880 // initialized, that means that we lost our previous window,
3881 // which means that we have a lot of work to do. At a minimum,
3882 // we need to destroy the swapchain and surface associated with
3883 // the old window, and create a new surface and swapchain.
3884 // However, since there are a lot of other objects/state that
3885 // is tied to the swapchain, it's easiest to simply cleanup and
3886 // start over (i.e. use a brute-force approach of re-starting
3888 if (demo.prepared) {
3889 demo_cleanup(&demo);
3892 // Parse Intents into argc, argv
3893 // Use the following key to send arguments, i.e.
3894 // --es args "--validate"
3895 const char key[] = "args";
3896 char *appTag = (char *)APP_SHORT_NAME;
3898 char **argv = get_args(app, key, appTag, &argc);
3900 __android_log_print(ANDROID_LOG_INFO, appTag, "argc = %i", argc);
3901 for (int i = 0; i < argc; i++) __android_log_print(ANDROID_LOG_INFO, appTag, "argv[%i] = %s", i, argv[i]);
3903 demo_init(&demo, argc, argv);
3905 // Free the argv malloc'd by get_args
3906 for (int i = 0; i < argc; i++) free(argv[i]);
3908 demo.window = (void *)app->window;
3909 demo_init_vk_swapchain(&demo);
3910 demo_prepare(&demo);
3915 case APP_CMD_GAINED_FOCUS: {
3919 case APP_CMD_LOST_FOCUS: {
3926 void android_main(struct android_app *app) {
3928 int vulkanSupport = InitVulkan();
3929 if (vulkanSupport == 0) return;
3932 demo.prepared = false;
3934 app->onAppCmd = processCommand;
3935 app->onInputEvent = processInput;
3939 struct android_poll_source *source;
3940 while (ALooper_pollAll(active ? 0 : -1, NULL, &events, (void **)&source) >= 0) {
3942 source->process(app, source);
3945 if (app->destroyRequested != 0) {
3946 demo_cleanup(&demo);
3950 if (initialized && active) {
3956 int main(int argc, char **argv) {
3959 demo_init(&demo, argc, argv);
3960 #if defined(VK_USE_PLATFORM_XCB_KHR)
3961 demo_create_xcb_window(&demo);
3962 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
3963 demo_create_xlib_window(&demo);
3964 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
3965 demo_create_window(&demo);
3968 demo_init_vk_swapchain(&demo);
3970 demo_prepare(&demo);
3972 #if defined(VK_USE_PLATFORM_XCB_KHR)
3973 demo_run_xcb(&demo);
3974 #elif defined(VK_USE_PLATFORM_XLIB_KHR)
3975 demo_run_xlib(&demo);
3976 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
3978 #elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3979 demo_run_display(&demo);
3982 demo_cleanup(&demo);
3984 return validation_error;