blob: 9b4ac1a306ef19519902167912f8639546210c2b [file] [log] [blame]
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001/*
Tony-LunarG495604b2019-06-13 15:32:05 -06002 * Copyright (c) 2015-2019 The Khronos Group Inc.
3 * Copyright (c) 2015-2019 Valve Corporation
4 * Copyright (c) 2015-2019 LunarG, Inc.
Dave Houlton5fa47912018-02-16 11:02:26 -07005 *
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
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
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.
17 *
18 * Author: Jeremy Hayes <jeremy@lunarg.com>
Charles Giessen74f007d2022-02-08 14:04:45 -070019 * Author: Charles Giessen <charles@lunarg.com>
Dave Houlton5fa47912018-02-16 11:02:26 -070020 */
Richard S. Wright Jra7825742021-01-06 16:02:12 -050021
Jeremy Hayesf56427a2016-09-07 15:55:11 -060022#if defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XCB_KHR)
23#include <X11/Xutil.h>
Joey Bzdek15eb0702017-06-07 09:40:36 -060024#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
25#include <linux/input.h>
Manuel Stoecklac939332019-06-26 20:55:53 -040026#include "xdg-shell-client-header.h"
27#include "xdg-decoration-client-header.h"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060028#endif
29
30#include <cassert>
Petr Krausbc0ab752017-12-09 00:22:39 +010031#include <cinttypes>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060032#include <cstdio>
33#include <cstdlib>
34#include <cstring>
35#include <csignal>
Charles Giessenc2f1a942022-02-06 23:38:39 -070036
Tony-LunarGd74734f2019-06-04 14:11:43 -060037#include <sstream>
Charles Giessenc2f1a942022-02-06 23:38:39 -070038#include <iostream>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060039#include <memory>
40
41#define VULKAN_HPP_NO_EXCEPTIONS
Shannon McPherson2abb6992019-04-05 10:46:16 -060042#define VULKAN_HPP_TYPESAFE_CONVERSION
Jeremy Hayesf56427a2016-09-07 15:55:11 -060043#include <vulkan/vulkan.hpp>
44#include <vulkan/vk_sdk_platform.h>
45
46#include "linmath.h"
47
48#ifndef NDEBUG
49#define VERIFY(x) assert(x)
50#else
51#define VERIFY(x) ((void)(x))
52#endif
53
Charles Giessen87dd88d2022-02-03 13:46:29 -070054#define APP_SHORT_NAME "vkcubepp"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060055
56// Allow a maximum of two outstanding presentation operations.
Charles Giessenc2f1a942022-02-06 23:38:39 -070057constexpr uint32_t FRAME_LAG = 2;
Jeremy Hayesf56427a2016-09-07 15:55:11 -060058
59#ifdef _WIN32
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070060#define ERR_EXIT(err_msg, err_class) \
61 do { \
62 if (!suppress_popups) MessageBox(nullptr, err_msg, err_class, MB_OK); \
63 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060064 } while (0)
65#else
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070066#define ERR_EXIT(err_msg, err_class) \
67 do { \
Robert Morell4ccc6522017-02-01 14:51:00 -080068 printf("%s\n", err_msg); \
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070069 fflush(stdout); \
70 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060071 } while (0)
72#endif
73
Charles Giessen74f007d2022-02-08 14:04:45 -070074// easier to use the C function for extension functions
75PFN_vkCreateDebugUtilsMessengerEXT pfnVkCreateDebugUtilsMessengerEXT;
76PFN_vkDestroyDebugUtilsMessengerEXT pfnVkDestroyDebugUtilsMessengerEXT;
77VKAPI_ATTR VkResult VKAPI_CALL vkCreateDebugUtilsMessengerEXT(VkInstance instance,
78 const VkDebugUtilsMessengerCreateInfoEXT *pCreateInfo,
79 const VkAllocationCallbacks *pAllocator,
80 VkDebugUtilsMessengerEXT *pMessenger) {
81 return pfnVkCreateDebugUtilsMessengerEXT(instance, pCreateInfo, pAllocator, pMessenger);
82}
83
84VKAPI_ATTR void VKAPI_CALL vkDestroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessengerEXT messenger,
85 VkAllocationCallbacks const *pAllocator) {
86 return pfnVkDestroyDebugUtilsMessengerEXT(instance, messenger, pAllocator);
87}
88
Jeremy Hayes9d304782016-10-09 11:48:12 -060089struct texture_object {
Jeremy Hayesf56427a2016-09-07 15:55:11 -060090 vk::Sampler sampler;
91
92 vk::Image image;
Tony-LunarGbc9fc052018-09-21 13:47:06 -060093 vk::Buffer buffer;
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -070094 vk::ImageLayout imageLayout{vk::ImageLayout::eUndefined};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060095
96 vk::MemoryAllocateInfo mem_alloc;
97 vk::DeviceMemory mem;
98 vk::ImageView view;
99
Charles Giessen3bcefe52022-02-21 11:57:16 -0700100 uint32_t tex_width{0};
101 uint32_t tex_height{0};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600102};
103
Jeremy Hayes9d304782016-10-09 11:48:12 -0600104static char const *const tex_files[] = {"lunarg.ppm"};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600105
106static int validation_error = 0;
107
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600108struct vktexcube_vs_uniform {
109 // Must start with MVP
110 float mvp[4][4];
111 float position[12 * 3][4];
112 float attr[12 * 3][4];
113};
114
115//--------------------------------------------------------------------------------------
116// Mesh and VertexFormat Data
117//--------------------------------------------------------------------------------------
118// clang-format off
119static const float g_vertex_buffer_data[] = {
120 -1.0f,-1.0f,-1.0f, // -X side
121 -1.0f,-1.0f, 1.0f,
122 -1.0f, 1.0f, 1.0f,
123 -1.0f, 1.0f, 1.0f,
124 -1.0f, 1.0f,-1.0f,
125 -1.0f,-1.0f,-1.0f,
126
127 -1.0f,-1.0f,-1.0f, // -Z side
128 1.0f, 1.0f,-1.0f,
129 1.0f,-1.0f,-1.0f,
130 -1.0f,-1.0f,-1.0f,
131 -1.0f, 1.0f,-1.0f,
132 1.0f, 1.0f,-1.0f,
133
134 -1.0f,-1.0f,-1.0f, // -Y side
135 1.0f,-1.0f,-1.0f,
136 1.0f,-1.0f, 1.0f,
137 -1.0f,-1.0f,-1.0f,
138 1.0f,-1.0f, 1.0f,
139 -1.0f,-1.0f, 1.0f,
140
141 -1.0f, 1.0f,-1.0f, // +Y side
142 -1.0f, 1.0f, 1.0f,
143 1.0f, 1.0f, 1.0f,
144 -1.0f, 1.0f,-1.0f,
145 1.0f, 1.0f, 1.0f,
146 1.0f, 1.0f,-1.0f,
147
148 1.0f, 1.0f,-1.0f, // +X side
149 1.0f, 1.0f, 1.0f,
150 1.0f,-1.0f, 1.0f,
151 1.0f,-1.0f, 1.0f,
152 1.0f,-1.0f,-1.0f,
153 1.0f, 1.0f,-1.0f,
154
155 -1.0f, 1.0f, 1.0f, // +Z side
156 -1.0f,-1.0f, 1.0f,
157 1.0f, 1.0f, 1.0f,
158 -1.0f,-1.0f, 1.0f,
159 1.0f,-1.0f, 1.0f,
160 1.0f, 1.0f, 1.0f,
161};
162
163static const float g_uv_buffer_data[] = {
164 0.0f, 1.0f, // -X side
165 1.0f, 1.0f,
166 1.0f, 0.0f,
167 1.0f, 0.0f,
168 0.0f, 0.0f,
169 0.0f, 1.0f,
170
171 1.0f, 1.0f, // -Z side
172 0.0f, 0.0f,
173 0.0f, 1.0f,
174 1.0f, 1.0f,
175 1.0f, 0.0f,
176 0.0f, 0.0f,
177
178 1.0f, 0.0f, // -Y side
179 1.0f, 1.0f,
180 0.0f, 1.0f,
181 1.0f, 0.0f,
182 0.0f, 1.0f,
183 0.0f, 0.0f,
184
185 1.0f, 0.0f, // +Y side
186 0.0f, 0.0f,
187 0.0f, 1.0f,
188 1.0f, 0.0f,
189 0.0f, 1.0f,
190 1.0f, 1.0f,
191
192 1.0f, 0.0f, // +X side
193 0.0f, 0.0f,
194 0.0f, 1.0f,
195 0.0f, 1.0f,
196 1.0f, 1.0f,
197 1.0f, 0.0f,
198
199 0.0f, 0.0f, // +Z side
200 0.0f, 1.0f,
201 1.0f, 0.0f,
202 0.0f, 1.0f,
203 1.0f, 1.0f,
204 1.0f, 0.0f,
205};
Jeremy Hayes9d304782016-10-09 11:48:12 -0600206// clang-format on
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600207
Charles Giessen87dd88d2022-02-03 13:46:29 -0700208struct SwapchainImageResources {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600209 vk::Image image;
210 vk::CommandBuffer cmd;
211 vk::CommandBuffer graphics_to_present_cmd;
212 vk::ImageView view;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600213 vk::Buffer uniform_buffer;
214 vk::DeviceMemory uniform_memory;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700215 void *uniform_memory_ptr = nullptr;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600216 vk::Framebuffer framebuffer;
217 vk::DescriptorSet descriptor_set;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700218};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600219
Joey Bzdekbaf66472017-06-07 09:37:37 -0600220struct Demo {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700221 void build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700222 vk::Bool32 check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600223 void cleanup();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700224 void destroy_swapchain_related_resources();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600225 void create_device();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700226 void destroy_texture(texture_object &tex_objs);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600227 void draw();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700228 void draw_build_cmd(const SwapchainImageResources &swapchain_image_resource);
229 void prepare_init_cmd();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600230 void flush_init_cmd();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700231 void init(int argc, char **argv);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600232 void init_connection();
233 void init_vk();
234 void init_vk_swapchain();
235 void prepare();
236 void prepare_buffers();
237 void prepare_cube_data_buffers();
238 void prepare_depth();
239 void prepare_descriptor_layout();
240 void prepare_descriptor_pool();
241 void prepare_descriptor_set();
242 void prepare_framebuffers();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700243 vk::ShaderModule prepare_shader_module(const uint32_t *code, size_t size);
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100244 vk::ShaderModule prepare_vs();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600245 vk::ShaderModule prepare_fs();
246 void prepare_pipeline();
247 void prepare_render_pass();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700248 void prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
249 vk::MemoryPropertyFlags required_props);
250 void prepare_texture_buffer(const char *filename, texture_object &tex_obj);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600251 void prepare_textures();
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100252
Joey Bzdekbaf66472017-06-07 09:37:37 -0600253 void resize();
Tony-LunarG6cebf142019-09-11 14:32:23 -0600254 void create_surface();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700255 void set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
256 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600257 void update_data_buffer();
Charles Giessen3bcefe52022-02-21 11:57:16 -0700258 bool loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout &layout, uint32_t &width, uint32_t &height);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700259 bool memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex);
Charles Giessen7dc2dd52022-02-03 13:55:48 -0700260 vk::SurfaceFormatKHR pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600261
Charles Giessen74f007d2022-02-08 14:04:45 -0700262 static VKAPI_ATTR VkBool32 VKAPI_CALL debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
263 VkDebugUtilsMessageTypeFlagsEXT messageType,
264 const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData,
265 void *pUserData);
266
Joey Bzdekbaf66472017-06-07 09:37:37 -0600267#if defined(VK_USE_PLATFORM_WIN32_KHR)
268 void run();
269 void create_window();
270#elif defined(VK_USE_PLATFORM_XLIB_KHR)
271 void create_xlib_window();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700272 void handle_xlib_event(const XEvent *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600273 void run_xlib();
274#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700275 void handle_xcb_event(const xcb_generic_event_t *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600276 void run_xcb();
277 void create_xcb_window();
278#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
279 void run();
280 void create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200281#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700282 void handle_directfb_event(const DFBInputEvent *event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200283 void run_directfb();
284 void create_directfb_window();
Bill Hollings0a0625a2019-07-15 17:39:18 -0400285#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -0600286 void run();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600287#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
288 vk::Result create_display_surface();
289 void run_display();
290#endif
291
Charles Giessenc2f1a942022-02-06 23:38:39 -0700292 std::string name = "vkcubepp"; // Name to put on the window/icon
Joey Bzdekbaf66472017-06-07 09:37:37 -0600293#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700294 HINSTANCE connection = nullptr; // hInstance - Windows Instance
295 HWND window = nullptr; // hWnd - window handle
296 POINT minsize = {0, 0}; // minimum window size
Joey Bzdekbaf66472017-06-07 09:37:37 -0600297#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700298 Window xlib_window = 0;
299 Atom xlib_wm_delete_window = 0;
300 Display *display = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600301#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700302 xcb_window_t xcb_window = 0;
303 xcb_screen_t *screen = nullptr;
304 xcb_connection_t *connection = nullptr;
305 xcb_intern_atom_reply_t *atom_wm_delete_window = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600306#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700307 wl_display *display = nullptr;
308 wl_registry *registry = nullptr;
309 wl_compositor *compositor = nullptr;
310 wl_surface *window = nullptr;
311 xdg_wm_base *wm_base = nullptr;
312 zxdg_decoration_manager_v1 *xdg_decoration_mgr = nullptr;
313 zxdg_toplevel_decoration_v1 *toplevel_decoration = nullptr;
314 xdg_surface *window_surface = nullptr;
315 bool xdg_surface_has_been_configured = false;
316 xdg_toplevel *window_toplevel = nullptr;
317 wl_seat *seat = nullptr;
318 wl_pointer *pointer = nullptr;
319 wl_keyboard *keyboard = nullptr;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200320#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700321 IDirectFB *dfb = nullptr;
322 IDirectFBSurface *window = nullptr;
323 IDirectFBEventBuffer *event_buffer = nullptr;
Bill Hollings0a0625a2019-07-15 17:39:18 -0400324#elif defined(VK_USE_PLATFORM_METAL_EXT)
325 void *caMetalLayer;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600326#endif
327
328 vk::SurfaceKHR surface;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700329 bool prepared = false;
330 bool use_staging_buffer = false;
331 bool use_xlib = false;
332 bool separate_present_queue = false;
333 int32_t gpu_number = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600334
335 vk::Instance inst;
Charles Giessen74f007d2022-02-08 14:04:45 -0700336 vk::DebugUtilsMessengerEXT debug_messenger;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600337 vk::PhysicalDevice gpu;
338 vk::Device device;
339 vk::Queue graphics_queue;
340 vk::Queue present_queue;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700341 uint32_t graphics_queue_family_index = 0;
342 uint32_t present_queue_family_index = 0;
343 std::array<vk::Semaphore, FRAME_LAG> image_acquired_semaphores;
344 std::array<vk::Semaphore, FRAME_LAG> draw_complete_semaphores;
345 std::array<vk::Semaphore, FRAME_LAG> image_ownership_semaphores;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600346 vk::PhysicalDeviceProperties gpu_props;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700347 std::vector<vk::QueueFamilyProperties> queue_props;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600348 vk::PhysicalDeviceMemoryProperties memory_properties;
349
Charles Giessen87dd88d2022-02-03 13:46:29 -0700350 std::vector<const char *> enabled_instance_extensions;
351 std::vector<const char *> enabled_layers;
352 std::vector<const char *> enabled_device_extensions;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600353
Charles Giessen3bcefe52022-02-21 11:57:16 -0700354 uint32_t width = 0;
355 uint32_t height = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600356 vk::Format format;
357 vk::ColorSpaceKHR color_space;
358
Joey Bzdekbaf66472017-06-07 09:37:37 -0600359 vk::SwapchainKHR swapchain;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700360 std::vector<SwapchainImageResources> swapchain_image_resources;
361 vk::PresentModeKHR presentMode = vk::PresentModeKHR::eFifo;
362 std::array<vk::Fence, FRAME_LAG> fences;
363 uint32_t frame_index = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600364
365 vk::CommandPool cmd_pool;
366 vk::CommandPool present_cmd_pool;
367
368 struct {
369 vk::Format format;
370 vk::Image image;
371 vk::MemoryAllocateInfo mem_alloc;
372 vk::DeviceMemory mem;
373 vk::ImageView view;
374 } depth;
375
376 static int32_t const texture_count = 1;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700377 std::array<texture_object, texture_count> textures;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600378 texture_object staging_texture;
379
380 struct {
381 vk::Buffer buf;
382 vk::MemoryAllocateInfo mem_alloc;
383 vk::DeviceMemory mem;
384 vk::DescriptorBufferInfo buffer_info;
385 } uniform_data;
386
387 vk::CommandBuffer cmd; // Buffer for initialization commands
388 vk::PipelineLayout pipeline_layout;
389 vk::DescriptorSetLayout desc_layout;
390 vk::PipelineCache pipelineCache;
391 vk::RenderPass render_pass;
392 vk::Pipeline pipeline;
393
Charles Giessenc2f1a942022-02-06 23:38:39 -0700394 mat4x4 projection_matrix = {};
395 mat4x4 view_matrix = {};
396 mat4x4 model_matrix = {};
Joey Bzdekbaf66472017-06-07 09:37:37 -0600397
Charles Giessen87dd88d2022-02-03 13:46:29 -0700398 float spin_angle = 0.0f;
399 float spin_increment = 0.0f;
400 bool pause = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600401
402 vk::ShaderModule vert_shader_module;
403 vk::ShaderModule frag_shader_module;
404
405 vk::DescriptorPool desc_pool;
406 vk::DescriptorSet desc_set;
407
Charles Giessen87dd88d2022-02-03 13:46:29 -0700408 std::vector<vk::Framebuffer> framebuffers;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600409
Charles Giessen87dd88d2022-02-03 13:46:29 -0700410 bool quit = false;
411 uint32_t curFrame = 0;
412 uint32_t frameCount = 0;
413 bool validate = false;
Charles Giessen74f007d2022-02-08 14:04:45 -0700414 bool in_callback = false;
415 bool use_debug_messenger = false;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700416 bool use_break = false;
417 bool suppress_popups = false;
418 bool force_errors = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600419
Charles Giessen87dd88d2022-02-03 13:46:29 -0700420 uint32_t current_buffer = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600421};
422
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600423#ifdef _WIN32
424// MS-Windows event handling function:
425LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
426#endif
427
Karl Schultz23cc2182016-11-23 17:15:17 -0700428#if defined(VK_USE_PLATFORM_WAYLAND_KHR)
Joey Bzdek15eb0702017-06-07 09:40:36 -0600429static void pointer_handle_enter(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t sx,
430 wl_fixed_t sy) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700431
Joey Bzdek15eb0702017-06-07 09:40:36 -0600432static void pointer_handle_leave(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700433
Joey Bzdek15eb0702017-06-07 09:40:36 -0600434static void pointer_handle_motion(void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) {}
435
436static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button,
437 uint32_t state) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700438 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600439 if (button == BTN_LEFT && state == WL_POINTER_BUTTON_STATE_PRESSED) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700440 xdg_toplevel_move(demo.window_toplevel, demo.seat, serial);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600441 }
442}
443
444static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {}
445
446static const struct wl_pointer_listener pointer_listener = {
447 pointer_handle_enter, pointer_handle_leave, pointer_handle_motion, pointer_handle_button, pointer_handle_axis,
448};
449
450static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) {}
451
452static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface,
453 struct wl_array *keys) {}
454
455static void keyboard_handle_leave(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) {}
456
457static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key,
458 uint32_t state) {
459 if (state != WL_KEYBOARD_KEY_STATE_RELEASED) return;
Charles Giessen3bcefe52022-02-21 11:57:16 -0700460 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600461 switch (key) {
462 case KEY_ESC: // Escape
Charles Giessen3bcefe52022-02-21 11:57:16 -0700463 demo.quit = true;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600464 break;
465 case KEY_LEFT: // left arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700466 demo.spin_angle -= demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600467 break;
468 case KEY_RIGHT: // right arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700469 demo.spin_angle += demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600470 break;
471 case KEY_SPACE: // space bar
Charles Giessen3bcefe52022-02-21 11:57:16 -0700472 demo.pause = !demo.pause;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600473 break;
474 }
475}
476
477static void keyboard_handle_modifiers(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed,
478 uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {}
479
480static const struct wl_keyboard_listener keyboard_listener = {
481 keyboard_handle_keymap, keyboard_handle_enter, keyboard_handle_leave, keyboard_handle_key, keyboard_handle_modifiers,
482};
483
484static void seat_handle_capabilities(void *data, wl_seat *seat, uint32_t caps) {
485 // Subscribe to pointer events
Charles Giessen3bcefe52022-02-21 11:57:16 -0700486 Demo &demo = *static_cast<Demo *>(data);
487 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !demo.pointer) {
488 demo.pointer = wl_seat_get_pointer(seat);
Charles Giessene494de72022-03-31 10:07:22 -0600489 wl_pointer_add_listener(demo.pointer, &pointer_listener, &demo);
Charles Giessen3bcefe52022-02-21 11:57:16 -0700490 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && demo.pointer) {
491 wl_pointer_destroy(demo.pointer);
492 demo.pointer = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600493 }
494 // Subscribe to keyboard events
495 if (caps & WL_SEAT_CAPABILITY_KEYBOARD) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700496 demo.keyboard = wl_seat_get_keyboard(seat);
Charles Giessene494de72022-03-31 10:07:22 -0600497 wl_keyboard_add_listener(demo.keyboard, &keyboard_listener, &demo);
shironeko689140c2022-05-19 10:21:07 -0400498 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD) && demo.keyboard) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700499 wl_keyboard_destroy(demo.keyboard);
500 demo.keyboard = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600501 }
502}
503
504static const wl_seat_listener seat_listener = {
505 seat_handle_capabilities,
506};
507
Manuel Stoecklac939332019-06-26 20:55:53 -0400508static void wm_base_ping(void *data, xdg_wm_base *xdg_wm_base, uint32_t serial) { xdg_wm_base_pong(xdg_wm_base, serial); }
509
510static const struct xdg_wm_base_listener wm_base_listener = {wm_base_ping};
511
Joey Bzdek15eb0702017-06-07 09:40:36 -0600512static void registry_handle_global(void *data, wl_registry *registry, uint32_t id, const char *interface, uint32_t version) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700513 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600514 // pickup wayland objects when they appear
Manuel Stoecklac939332019-06-26 20:55:53 -0400515 if (strcmp(interface, wl_compositor_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700516 demo.compositor = (wl_compositor *)wl_registry_bind(registry, id, &wl_compositor_interface, 1);
Manuel Stoecklac939332019-06-26 20:55:53 -0400517 } else if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700518 demo.wm_base = (xdg_wm_base *)wl_registry_bind(registry, id, &xdg_wm_base_interface, 1);
519 xdg_wm_base_add_listener(demo.wm_base, &wm_base_listener, nullptr);
Manuel Stoecklac939332019-06-26 20:55:53 -0400520 } else if (strcmp(interface, wl_seat_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700521 demo.seat = (wl_seat *)wl_registry_bind(registry, id, &wl_seat_interface, 1);
Charles Giessene494de72022-03-31 10:07:22 -0600522 wl_seat_add_listener(demo.seat, &seat_listener, &demo);
Manuel Stoecklac939332019-06-26 20:55:53 -0400523 } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700524 demo.xdg_decoration_mgr =
Manuel Stoecklac939332019-06-26 20:55:53 -0400525 (zxdg_decoration_manager_v1 *)wl_registry_bind(registry, id, &zxdg_decoration_manager_v1_interface, 1);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600526 }
527}
528
529static void registry_handle_global_remove(void *data, wl_registry *registry, uint32_t name) {}
530
531static const wl_registry_listener registry_listener = {registry_handle_global, registry_handle_global_remove};
Karl Schultz23cc2182016-11-23 17:15:17 -0700532#endif
533
Charles Giessenc2f1a942022-02-06 23:38:39 -0700534void Demo::build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700535 auto result = swapchain_image_resource.graphics_to_present_cmd.begin(
536 vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700537 VERIFY(result == vk::Result::eSuccess);
538
539 auto const image_ownership_barrier =
540 vk::ImageMemoryBarrier()
541 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600542 .setDstAccessMask(vk::AccessFlags())
Dave Houlton5fa47912018-02-16 11:02:26 -0700543 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
544 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
545 .setSrcQueueFamilyIndex(graphics_queue_family_index)
546 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700547 .setImage(swapchain_image_resource.image)
Dave Houlton5fa47912018-02-16 11:02:26 -0700548 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
549
Charles Giessen87dd88d2022-02-03 13:46:29 -0700550 swapchain_image_resource.graphics_to_present_cmd.pipelineBarrier(vk::PipelineStageFlagBits::eBottomOfPipe,
551 vk::PipelineStageFlagBits::eBottomOfPipe,
552 vk::DependencyFlagBits(), {}, {}, image_ownership_barrier);
Dave Houlton5fa47912018-02-16 11:02:26 -0700553
Charles Giessen87dd88d2022-02-03 13:46:29 -0700554 result = swapchain_image_resource.graphics_to_present_cmd.end();
Dave Houlton5fa47912018-02-16 11:02:26 -0700555 VERIFY(result == vk::Result::eSuccess);
556}
557
Charles Giessen87dd88d2022-02-03 13:46:29 -0700558vk::Bool32 Demo::check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers) {
559 for (const auto &name : check_names) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700560 vk::Bool32 found = VK_FALSE;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700561 for (const auto &layer : layers) {
562 if (!strcmp(name, layer.layerName)) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700563 found = VK_TRUE;
564 break;
565 }
566 }
567 if (!found) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700568 fprintf(stderr, "Cannot find layer: %s\n", name);
Dave Houlton5fa47912018-02-16 11:02:26 -0700569 return 0;
570 }
571 }
572 return VK_TRUE;
573}
574
575void Demo::cleanup() {
576 prepared = false;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700577 auto result = device.waitIdle();
578 VERIFY(result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700579
Charles Giessen87dd88d2022-02-03 13:46:29 -0700580 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -0700581 // Wait for fences from present operations
582 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700583 device.destroyFence(fences[i]);
584 device.destroySemaphore(image_acquired_semaphores[i]);
585 device.destroySemaphore(draw_complete_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700586 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700587 device.destroySemaphore(image_ownership_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700588 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600589 }
590
Charles Giessen87dd88d2022-02-03 13:46:29 -0700591 device.destroySwapchainKHR(swapchain);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600592
Charles Giessen87dd88d2022-02-03 13:46:29 -0700593 device.destroy();
594 inst.destroySurfaceKHR(surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700595
596#if defined(VK_USE_PLATFORM_XLIB_KHR)
597 XDestroyWindow(display, xlib_window);
598 XCloseDisplay(display);
599#elif defined(VK_USE_PLATFORM_XCB_KHR)
600 xcb_destroy_window(connection, xcb_window);
601 xcb_disconnect(connection);
602 free(atom_wm_delete_window);
603#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
shironeko689140c2022-05-19 10:21:07 -0400604 if (keyboard) wl_keyboard_destroy(keyboard);
605 if (pointer) wl_pointer_destroy(pointer);
606 if (seat) wl_seat_destroy(seat);
Manuel Stoecklac939332019-06-26 20:55:53 -0400607 xdg_toplevel_destroy(window_toplevel);
608 xdg_surface_destroy(window_surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700609 wl_surface_destroy(window);
Manuel Stoecklac939332019-06-26 20:55:53 -0400610 xdg_wm_base_destroy(wm_base);
611 if (xdg_decoration_mgr) {
612 zxdg_toplevel_decoration_v1_destroy(toplevel_decoration);
613 zxdg_decoration_manager_v1_destroy(xdg_decoration_mgr);
614 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700615 wl_compositor_destroy(compositor);
616 wl_registry_destroy(registry);
617 wl_display_disconnect(display);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200618#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
619 event_buffer->Release(event_buffer);
620 window->Release(window);
621 dfb->Release(dfb);
Dave Houlton5fa47912018-02-16 11:02:26 -0700622#endif
Charles Giessen74f007d2022-02-08 14:04:45 -0700623 if (use_debug_messenger) {
624 inst.destroyDebugUtilsMessengerEXT(debug_messenger);
625 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700626 inst.destroy();
Dave Houlton5fa47912018-02-16 11:02:26 -0700627}
628
629void Demo::create_device() {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700630 float priorities = 0.0;
Dave Houlton5fa47912018-02-16 11:02:26 -0700631
Charles Giessen87dd88d2022-02-03 13:46:29 -0700632 std::vector<vk::DeviceQueueCreateInfo> queues;
633 queues.push_back(vk::DeviceQueueCreateInfo().setQueueFamilyIndex(graphics_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700634
635 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700636 queues.push_back(
637 vk::DeviceQueueCreateInfo().setQueueFamilyIndex(present_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700638 }
639
Charles Giessen87dd88d2022-02-03 13:46:29 -0700640 auto deviceInfo = vk::DeviceCreateInfo().setQueueCreateInfos(queues).setPEnabledExtensionNames(enabled_device_extensions);
641 auto device_return = gpu.createDevice(deviceInfo);
642 VERIFY(device_return.result == vk::Result::eSuccess);
643 device = device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -0700644}
645
Charles Giessen87dd88d2022-02-03 13:46:29 -0700646void Demo::destroy_texture(texture_object &tex_objs) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700647 // clean up staging resources
Charles Giessen87dd88d2022-02-03 13:46:29 -0700648 device.freeMemory(tex_objs.mem);
649 if (tex_objs.image) device.destroyImage(tex_objs.image);
650 if (tex_objs.buffer) device.destroyBuffer(tex_objs.buffer);
Dave Houlton5fa47912018-02-16 11:02:26 -0700651}
652
653void Demo::draw() {
654 // Ensure no more than FRAME_LAG renderings are outstanding
Charles Giessen87dd88d2022-02-03 13:46:29 -0700655 device.waitForFences(fences[frame_index], VK_TRUE, UINT64_MAX);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -0700656 device.resetFences({fences[frame_index]});
Dave Houlton5fa47912018-02-16 11:02:26 -0700657
Charles Giessenc2f1a942022-02-06 23:38:39 -0700658 vk::Result acquire_result;
Dave Houlton5fa47912018-02-16 11:02:26 -0700659 do {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700660 acquire_result =
Dave Houlton5fa47912018-02-16 11:02:26 -0700661 device.acquireNextImageKHR(swapchain, UINT64_MAX, image_acquired_semaphores[frame_index], vk::Fence(), &current_buffer);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700662 if (acquire_result == vk::Result::eErrorOutOfDateKHR) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700663 // demo.swapchain is out of date (e.g. the window was resized) and
Dave Houlton5fa47912018-02-16 11:02:26 -0700664 // must be recreated:
665 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700666 } else if (acquire_result == vk::Result::eSuboptimalKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700667 // swapchain is not as optimal as it could be, but the platform's
668 // presentation engine will still present the image correctly.
669 break;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700670 } else if (acquire_result == vk::Result::eErrorSurfaceLostKHR) {
671 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600672 create_surface();
673 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700674 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700675 VERIFY(acquire_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700676 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700677 } while (acquire_result != vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700678
679 update_data_buffer();
680
681 // Wait for the image acquired semaphore to be signaled to ensure
682 // that the image won't be rendered to until the presentation
683 // engine has fully released ownership to the application, and it is
684 // okay to render to the image.
685 vk::PipelineStageFlags const pipe_stage_flags = vk::PipelineStageFlagBits::eColorAttachmentOutput;
Dave Houlton5fa47912018-02-16 11:02:26 -0700686
Charles Giessen87dd88d2022-02-03 13:46:29 -0700687 auto submit_result = graphics_queue.submit(vk::SubmitInfo()
688 .setWaitDstStageMask(pipe_stage_flags)
689 .setWaitSemaphores(image_acquired_semaphores[frame_index])
690 .setCommandBuffers(swapchain_image_resources[current_buffer].cmd)
691 .setSignalSemaphores(draw_complete_semaphores[frame_index]),
692 fences[frame_index]);
693 VERIFY(submit_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700694
695 if (separate_present_queue) {
696 // If we are using separate queues, change image ownership to the
697 // present queue before presenting, waiting for the draw complete
698 // semaphore and signalling the ownership released semaphore when
699 // finished
Charles Giessen87dd88d2022-02-03 13:46:29 -0700700 auto change_owner_result =
701 present_queue.submit(vk::SubmitInfo()
702 .setWaitDstStageMask(pipe_stage_flags)
703 .setWaitSemaphores(draw_complete_semaphores[frame_index])
704 .setCommandBuffers(swapchain_image_resources[current_buffer].graphics_to_present_cmd)
705 .setSignalSemaphores(image_ownership_semaphores[frame_index]));
706 VERIFY(change_owner_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700707 }
708
709 // If we are using separate queues we have to wait for image ownership,
710 // otherwise wait for draw complete
Charles Giessen87dd88d2022-02-03 13:46:29 -0700711 auto present_result =
712 present_queue.presentKHR(vk::PresentInfoKHR()
713 .setWaitSemaphores(separate_present_queue ? image_ownership_semaphores[frame_index]
714 : draw_complete_semaphores[frame_index])
715 .setSwapchains(swapchain)
716 .setImageIndices(current_buffer));
Dave Houlton5fa47912018-02-16 11:02:26 -0700717 frame_index += 1;
718 frame_index %= FRAME_LAG;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700719 if (present_result == vk::Result::eErrorOutOfDateKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700720 // swapchain is out of date (e.g. the window was resized) and
721 // must be recreated:
722 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700723 } else if (present_result == vk::Result::eSuboptimalKHR) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600724 // SUBOPTIMAL could be due to resize
725 vk::SurfaceCapabilitiesKHR surfCapabilities;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700726 auto caps_result = gpu.getSurfaceCapabilitiesKHR(surface, &surfCapabilities);
727 VERIFY(caps_result == vk::Result::eSuccess);
Charles Giessen3bcefe52022-02-21 11:57:16 -0700728 if (surfCapabilities.currentExtent.width != width || surfCapabilities.currentExtent.height != height) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600729 resize();
730 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700731 } else if (present_result == vk::Result::eErrorSurfaceLostKHR) {
732 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600733 create_surface();
734 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700735 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700736 VERIFY(present_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700737 }
738}
739
Charles Giessen87dd88d2022-02-03 13:46:29 -0700740void Demo::draw_build_cmd(const SwapchainImageResources &swapchain_image_resource) {
741 const auto commandBuffer = swapchain_image_resource.cmd;
Dave Houlton5fa47912018-02-16 11:02:26 -0700742 vk::ClearValue const clearValues[2] = {vk::ClearColorValue(std::array<float, 4>({{0.2f, 0.2f, 0.2f, 0.2f}})),
743 vk::ClearDepthStencilValue(1.0f, 0u)};
744
Charles Giessen87dd88d2022-02-03 13:46:29 -0700745 auto result = commandBuffer.begin(vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700746 VERIFY(result == vk::Result::eSuccess);
747
Charles Giessen87dd88d2022-02-03 13:46:29 -0700748 commandBuffer.beginRenderPass(vk::RenderPassBeginInfo()
749 .setRenderPass(render_pass)
750 .setFramebuffer(swapchain_image_resource.framebuffer)
Charles Giessen3bcefe52022-02-21 11:57:16 -0700751 .setRenderArea(vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)))
Charles Giessen87dd88d2022-02-03 13:46:29 -0700752 .setClearValueCount(2)
753 .setPClearValues(clearValues),
754 vk::SubpassContents::eInline);
755
Dave Houlton5fa47912018-02-16 11:02:26 -0700756 commandBuffer.bindPipeline(vk::PipelineBindPoint::eGraphics, pipeline);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700757 commandBuffer.bindDescriptorSets(vk::PipelineBindPoint::eGraphics, pipeline_layout, 0, swapchain_image_resource.descriptor_set,
Charles Giessenc2f1a942022-02-06 23:38:39 -0700758 {});
Jeremy Kniager979b5312019-11-22 14:55:57 -0700759 float viewport_dimension;
760 float viewport_x = 0.0f;
761 float viewport_y = 0.0f;
762 if (width < height) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700763 viewport_dimension = static_cast<float>(width);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700764 viewport_y = (height - width) / 2.0f;
765 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700766 viewport_dimension = static_cast<float>(height);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700767 viewport_x = (width - height) / 2.0f;
768 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700769
Charles Giessen87dd88d2022-02-03 13:46:29 -0700770 commandBuffer.setViewport(0, vk::Viewport()
771 .setX(viewport_x)
772 .setY(viewport_y)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700773 .setWidth(viewport_dimension)
774 .setHeight(viewport_dimension)
775 .setMinDepth(0.0f)
776 .setMaxDepth(1.0f));
Charles Giessen87dd88d2022-02-03 13:46:29 -0700777
Charles Giessen3bcefe52022-02-21 11:57:16 -0700778 commandBuffer.setScissor(0, vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)));
Dave Houlton5fa47912018-02-16 11:02:26 -0700779 commandBuffer.draw(12 * 3, 1, 0, 0);
780 // Note that ending the renderpass changes the image's layout from
781 // COLOR_ATTACHMENT_OPTIMAL to PRESENT_SRC_KHR
782 commandBuffer.endRenderPass();
783
784 if (separate_present_queue) {
785 // We have to transfer ownership from the graphics queue family to
786 // the
787 // present queue family to be able to present. Note that we don't
788 // have
789 // to transfer from present queue family back to graphics queue
790 // family at
791 // the start of the next frame because we don't care about the
792 // image's
793 // contents at that point.
Charles Giessen87dd88d2022-02-03 13:46:29 -0700794 commandBuffer.pipelineBarrier(
795 vk::PipelineStageFlagBits::eBottomOfPipe, vk::PipelineStageFlagBits::eBottomOfPipe, vk::DependencyFlagBits(), {}, {},
Jeremy Hayes9d304782016-10-09 11:48:12 -0600796 vk::ImageMemoryBarrier()
797 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600798 .setDstAccessMask(vk::AccessFlags())
Jeremy Hayes9d304782016-10-09 11:48:12 -0600799 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
800 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
801 .setSrcQueueFamilyIndex(graphics_queue_family_index)
802 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700803 .setImage(swapchain_image_resource.image)
804 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1)));
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600805 }
806
Dave Houlton5fa47912018-02-16 11:02:26 -0700807 result = commandBuffer.end();
808 VERIFY(result == vk::Result::eSuccess);
809}
810
Charles Giessen87dd88d2022-02-03 13:46:29 -0700811void Demo::prepare_init_cmd() {
812 auto cmd_pool_return = device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(graphics_queue_family_index));
813 VERIFY(cmd_pool_return.result == vk::Result::eSuccess);
814 cmd_pool = cmd_pool_return.value;
815
816 auto cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
817 .setCommandPool(cmd_pool)
818 .setLevel(vk::CommandBufferLevel::ePrimary)
819 .setCommandBufferCount(1));
820 VERIFY(cmd_return.result == vk::Result::eSuccess);
821 cmd = cmd_return.value[0];
822
823 auto result = cmd.begin(vk::CommandBufferBeginInfo());
824 VERIFY(result == vk::Result::eSuccess);
825}
826
Dave Houlton5fa47912018-02-16 11:02:26 -0700827void Demo::flush_init_cmd() {
Dave Houlton5fa47912018-02-16 11:02:26 -0700828 auto result = cmd.end();
829 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600830
Mark Young43c08f82021-11-30 16:38:25 -0700831 auto fenceInfo = vk::FenceCreateInfo();
832 if (force_errors) {
833 // Remove sType to intentionally force validation layer errors.
834 fenceInfo.sType = vk::StructureType::eRenderPassBeginInfo;
835 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700836 auto fence_return = device.createFence(fenceInfo);
837 VERIFY(fence_return.result == vk::Result::eSuccess);
838 auto fence = fence_return.value;
839
840 result = graphics_queue.submit(vk::SubmitInfo().setCommandBuffers(cmd), fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700841 VERIFY(result == vk::Result::eSuccess);
842
Charles Giessen87dd88d2022-02-03 13:46:29 -0700843 result = device.waitForFences(fence, VK_TRUE, UINT64_MAX);
Dave Houlton5fa47912018-02-16 11:02:26 -0700844 VERIFY(result == vk::Result::eSuccess);
845
Charles Giessen87dd88d2022-02-03 13:46:29 -0700846 device.freeCommandBuffers(cmd_pool, cmd);
847 device.destroyFence(fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700848}
849
850void Demo::init(int argc, char **argv) {
851 vec3 eye = {0.0f, 3.0f, 5.0f};
852 vec3 origin = {0, 0, 0};
853 vec3 up = {0.0f, 1.0f, 0.0};
854
855 presentMode = vk::PresentModeKHR::eFifo;
856 frameCount = UINT32_MAX;
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100857 width = 500;
858 height = 500;
Dave Houlton5fa47912018-02-16 11:02:26 -0700859 use_xlib = false;
Witold Baryluka3b988f2021-01-07 19:03:02 +0000860 /* Autodetect suitable / best GPU by default */
861 gpu_number = -1;
Tony-LunarG6cebf142019-09-11 14:32:23 -0600862
Dave Houlton5fa47912018-02-16 11:02:26 -0700863 for (int i = 1; i < argc; i++) {
864 if (strcmp(argv[i], "--use_staging") == 0) {
865 use_staging_buffer = true;
866 continue;
867 }
868 if ((strcmp(argv[i], "--present_mode") == 0) && (i < argc - 1)) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700869 presentMode = static_cast<vk::PresentModeKHR>(atoi(argv[i + 1]));
Dave Houlton5fa47912018-02-16 11:02:26 -0700870 i++;
871 continue;
872 }
873 if (strcmp(argv[i], "--break") == 0) {
874 use_break = true;
875 continue;
876 }
877 if (strcmp(argv[i], "--validate") == 0) {
878 validate = true;
879 continue;
880 }
881 if (strcmp(argv[i], "--xlib") == 0) {
882 fprintf(stderr, "--xlib is deprecated and no longer does anything");
883 continue;
884 }
885 if (strcmp(argv[i], "--c") == 0 && frameCount == UINT32_MAX && i < argc - 1 &&
886 sscanf(argv[i + 1], "%" SCNu32, &frameCount) == 1) {
887 i++;
888 continue;
889 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700890 if (strcmp(argv[i], "--width") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &width) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100891 i++;
892 continue;
893 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700894 if (strcmp(argv[i], "--height") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &height) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100895 i++;
896 continue;
897 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700898 if (strcmp(argv[i], "--suppress_popups") == 0) {
899 suppress_popups = true;
900 continue;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600901 }
Tony-LunarG50e737c2020-07-16 14:26:03 -0600902 if ((strcmp(argv[i], "--gpu_number") == 0) && (i < argc - 1)) {
903 gpu_number = atoi(argv[i + 1]);
Witold Baryluka3b988f2021-01-07 19:03:02 +0000904 assert(gpu_number >= 0);
Tony-LunarG50e737c2020-07-16 14:26:03 -0600905 i++;
906 continue;
907 }
Mark Young43c08f82021-11-30 16:38:25 -0700908 if (strcmp(argv[i], "--force_errors") == 0) {
909 force_errors = true;
910 continue;
911 }
Tony-LunarGd74734f2019-06-04 14:11:43 -0600912 std::stringstream usage;
913 usage << "Usage:\n " << APP_SHORT_NAME << "\t[--use_staging] [--validate]\n"
914 << "\t[--break] [--c <framecount>] [--suppress_popups]\n"
Tony-LunarG50e737c2020-07-16 14:26:03 -0600915 << "\t[--gpu_number <index of physical device>]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600916 << "\t[--present_mode <present mode enum>]\n"
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100917 << "\t[--width <width>] [--height <height>]\n"
Mark Young43c08f82021-11-30 16:38:25 -0700918 << "\t[--force_errors]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600919 << "\t<present_mode_enum>\n"
920 << "\t\tVK_PRESENT_MODE_IMMEDIATE_KHR = " << VK_PRESENT_MODE_IMMEDIATE_KHR << "\n"
921 << "\t\tVK_PRESENT_MODE_MAILBOX_KHR = " << VK_PRESENT_MODE_MAILBOX_KHR << "\n"
922 << "\t\tVK_PRESENT_MODE_FIFO_KHR = " << VK_PRESENT_MODE_FIFO_KHR << "\n"
Witold Baryluka3b988f2021-01-07 19:03:02 +0000923 << "\t\tVK_PRESENT_MODE_FIFO_RELAXED_KHR = " << VK_PRESENT_MODE_FIFO_RELAXED_KHR << "\n";
Tony-LunarGd74734f2019-06-04 14:11:43 -0600924
925#if defined(_WIN32)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700926 if (!suppress_popups) MessageBox(nullptr, usage.str().c_str(), "Usage Error", MB_OK);
Tony-LunarGd74734f2019-06-04 14:11:43 -0600927#else
928 std::cerr << usage.str();
929 std::cerr.flush();
930#endif
Dave Houlton5fa47912018-02-16 11:02:26 -0700931 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600932 }
933
Dave Houlton5fa47912018-02-16 11:02:26 -0700934 if (!use_xlib) {
935 init_connection();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600936 }
937
Dave Houlton5fa47912018-02-16 11:02:26 -0700938 init_vk();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600939
Dave Houlton5fa47912018-02-16 11:02:26 -0700940 spin_angle = 4.0f;
941 spin_increment = 0.2f;
942 pause = false;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600943
Charles Giessen87dd88d2022-02-03 13:46:29 -0700944 mat4x4_perspective(projection_matrix, static_cast<float>(degreesToRadians(45.0f)), 1.0f, 0.1f, 100.0f);
Dave Houlton5fa47912018-02-16 11:02:26 -0700945 mat4x4_look_at(view_matrix, eye, origin, up);
946 mat4x4_identity(model_matrix);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600947
Dave Houlton5fa47912018-02-16 11:02:26 -0700948 projection_matrix[1][1] *= -1; // Flip projection matrix from GL to Vulkan orientation.
949}
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600950
Dave Houlton5fa47912018-02-16 11:02:26 -0700951void Demo::init_connection() {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600952#if defined(VK_USE_PLATFORM_XCB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -0700953 const xcb_setup_t *setup;
954 xcb_screen_iterator_t iter;
955 int scr;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600956
Dave Houlton5fa47912018-02-16 11:02:26 -0700957 const char *display_envar = getenv("DISPLAY");
958 if (display_envar == nullptr || display_envar[0] == '\0') {
959 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
960 fflush(stdout);
961 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600962 }
963
Dave Houlton5fa47912018-02-16 11:02:26 -0700964 connection = xcb_connect(nullptr, &scr);
965 if (xcb_connection_has_error(connection) > 0) {
C Stout05c61712021-08-20 13:19:01 -0700966 printf("Cannot connect to XCB.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700967 fflush(stdout);
968 exit(1);
969 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600970
Dave Houlton5fa47912018-02-16 11:02:26 -0700971 setup = xcb_get_setup(connection);
972 iter = xcb_setup_roots_iterator(setup);
973 while (scr-- > 0) xcb_screen_next(&iter);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600974
Dave Houlton5fa47912018-02-16 11:02:26 -0700975 screen = iter.data;
976#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
977 display = wl_display_connect(nullptr);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600978
Dave Houlton5fa47912018-02-16 11:02:26 -0700979 if (display == nullptr) {
C Stout05c61712021-08-20 13:19:01 -0700980 printf("Cannot connect to wayland.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700981 fflush(stdout);
982 exit(1);
983 }
984
985 registry = wl_display_get_registry(display);
986 wl_registry_add_listener(registry, &registry_listener, this);
987 wl_display_dispatch(display);
Dave Houlton5fa47912018-02-16 11:02:26 -0700988#endif
989}
Tony-LunarG27c21242021-03-11 16:28:19 -0700990#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700991int find_display_gpu(int gpu_number, const std::vector<vk::PhysicalDevice> &physical_devices) {
Tony-LunarG27c21242021-03-11 16:28:19 -0700992 uint32_t display_count = 0;
Tony-LunarG27c21242021-03-11 16:28:19 -0700993 int gpu_return = gpu_number;
994 if (gpu_number >= 0) {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700995 auto display_props_return = physical_devices[gpu_number].getDisplayPropertiesKHR();
996 VERIFY(display_props_return.result == vk::Result::eSuccess);
Charles Giessen431f3b52022-03-30 16:17:29 -0600997 display_count = display_props_return.value.size();
Tony-LunarG27c21242021-03-11 16:28:19 -0700998 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700999 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001000 auto display_props_return = physical_devices[i].getDisplayPropertiesKHR();
1001 VERIFY(display_props_return.result == vk::Result::eSuccess);
1002 if (display_props_return.value.size() > 0) {
Charles Giessen431f3b52022-03-30 16:17:29 -06001003 display_count = display_props_return.value.size();
Tony-LunarG27c21242021-03-11 16:28:19 -07001004 gpu_return = i;
1005 break;
1006 }
1007 }
1008 }
1009 if (display_count > 0)
1010 return gpu_return;
1011 else
1012 return -1;
1013}
1014#endif
Charles Giessen74f007d2022-02-08 14:04:45 -07001015VKAPI_ATTR VkBool32 VKAPI_CALL Demo::debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
1016 VkDebugUtilsMessageTypeFlagsEXT messageType,
1017 const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData,
1018 void *pUserData) {
1019 std::ostringstream message;
1020 Demo &demo = *static_cast<Demo *>(pUserData);
1021
1022 if (demo.use_break) {
1023#ifndef WIN32
1024 raise(SIGTRAP);
1025#else
1026 DebugBreak();
1027#endif
1028 }
1029 message << vk::to_string(vk::DebugUtilsMessageSeverityFlagBitsEXT(messageSeverity));
1030 message << " : " + vk::to_string(vk::DebugUtilsMessageTypeFlagsEXT(messageType));
1031
1032 if (vk::DebugUtilsMessageTypeFlagsEXT(messageType) & vk::DebugUtilsMessageTypeFlagBitsEXT::eValidation) {
1033 validation_error = 1;
1034 }
1035
1036 message << " - Message Id Number: " << std::to_string(pCallbackData->messageIdNumber);
1037 message << " | Message Id Name: " << pCallbackData->pMessageIdName << "\n\t" << pCallbackData->pMessage << "\n";
1038
1039 if (pCallbackData->objectCount > 0) {
1040 message << "\n\tObjects - " << pCallbackData->objectCount << "\n";
1041 for (uint32_t object = 0; object < pCallbackData->objectCount; ++object) {
1042 if (NULL != pCallbackData->pObjects[object].pObjectName && strlen(pCallbackData->pObjects[object].pObjectName) > 0) {
1043 message << "\t\tObject[" << object << "] - "
1044 << vk::to_string(vk::ObjectType(pCallbackData->pObjects[object].objectType)) << ", Handle "
1045 << pCallbackData->pObjects[object].objectHandle << ", Name \""
1046 << pCallbackData->pObjects[object].pObjectName << "\"\n";
1047 } else {
1048 message << "\t\tObject[" << object << "] - "
1049 << vk::to_string(vk::ObjectType(pCallbackData->pObjects[object].objectType)) << ", Handle "
1050 << pCallbackData->pObjects[object].objectHandle << "\n";
1051 }
1052 }
1053 }
1054 if (pCallbackData->cmdBufLabelCount > 0) {
1055 message << "\n\tCommand Buffer Labels - " << pCallbackData->cmdBufLabelCount << "\n";
1056 for (uint32_t cmd_buf_label = 0; cmd_buf_label < pCallbackData->cmdBufLabelCount; ++cmd_buf_label) {
1057 message << "\t\tLabel[" << cmd_buf_label << "] - " << pCallbackData->pCmdBufLabels[cmd_buf_label].pLabelName << " { "
1058 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[0] << ", "
1059 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[1] << ", "
1060 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[2] << ", "
1061 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[2] << "}\n";
1062 }
1063 }
1064
1065#ifdef _WIN32
1066
1067 if (!demo.suppress_popups) {
1068 demo.in_callback = true;
1069 auto message_string = message.str();
1070 MessageBox(NULL, message_string.c_str(), "Alert", MB_OK);
1071 demo.in_callback = false;
1072 }
1073
1074#elif defined(ANDROID)
1075
1076 if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) {
1077 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message.str());
1078 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
1079 __android_log_print(ANDROID_LOG_WARN, APP_SHORT_NAME, "%s", message.str());
1080 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
1081 __android_log_print(ANDROID_LOG_ERROR, APP_SHORT_NAME, "%s", message.str());
1082 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) {
1083 __android_log_print(ANDROID_LOG_VERBOSE, APP_SHORT_NAME, "%s", message.str());
1084 } else {
1085 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message.str());
1086 }
1087
1088#else
1089 std::cout << message.str() << std::endl; // use endl to force a flush
1090#endif
1091 return false; // Don't bail out, but keep going.
1092}
1093
Dave Houlton5fa47912018-02-16 11:02:26 -07001094void Demo::init_vk() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001095 std::vector<char const *> instance_validation_layers = {"VK_LAYER_KHRONOS_validation"};
Dave Houlton5fa47912018-02-16 11:02:26 -07001096
Dave Houlton5fa47912018-02-16 11:02:26 -07001097 // Look for validation layers
1098 vk::Bool32 validation_found = VK_FALSE;
1099 if (validate) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001100 auto layers = vk::enumerateInstanceLayerProperties();
1101 VERIFY(layers.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001102
Charles Giessen87dd88d2022-02-03 13:46:29 -07001103 validation_found = check_layers(instance_validation_layers, layers.value);
1104 if (validation_found) {
1105 enabled_layers.push_back("VK_LAYER_KHRONOS_validation");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001106 }
1107
Charles Giessen87dd88d2022-02-03 13:46:29 -07001108 else {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001109 ERR_EXIT(
Dave Houlton5fa47912018-02-16 11:02:26 -07001110 "vkEnumerateInstanceLayerProperties failed to find required validation layer.\n\n"
1111 "Please look at the Getting Started guide for additional information.\n",
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001112 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001113 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001114 }
1115
Dave Houlton5fa47912018-02-16 11:02:26 -07001116 /* Look for instance extensions */
1117 vk::Bool32 surfaceExtFound = VK_FALSE;
1118 vk::Bool32 platformSurfaceExtFound = VK_FALSE;
Charles Giessen5f3ce242022-04-11 14:39:06 -06001119 bool portabilityEnumerationActive = false;
Dave Houlton5fa47912018-02-16 11:02:26 -07001120
Charles Giessen87dd88d2022-02-03 13:46:29 -07001121 auto instance_extensions_return = vk::enumerateInstanceExtensionProperties();
1122 VERIFY(instance_extensions_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001123
Charles Giessen87dd88d2022-02-03 13:46:29 -07001124 for (const auto &extension : instance_extensions_return.value) {
1125 if (!strcmp(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, extension.extensionName)) {
1126 enabled_instance_extensions.push_back(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME);
Charles Giessen74f007d2022-02-08 14:04:45 -07001127 } else if (!strcmp(VK_EXT_DEBUG_UTILS_EXTENSION_NAME, extension.extensionName)) {
1128 use_debug_messenger = true;
1129 enabled_instance_extensions.push_back(VK_EXT_DEBUG_UTILS_EXTENSION_NAME);
Charles Giessen5f3ce242022-04-11 14:39:06 -06001130 } else if (!strcmp(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME, extension.extensionName)) {
1131 // We want cube to be able to enumerate drivers that support the portability_subset extension, so we have to enable the
1132 // portability enumeration extension.
1133 portabilityEnumerationActive = true;
1134 enabled_instance_extensions.push_back(VK_EXT_DEBUG_UTILS_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001135 } else if (!strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001136 surfaceExtFound = 1;
1137 enabled_instance_extensions.push_back(VK_KHR_SURFACE_EXTENSION_NAME);
1138 }
1139#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001140 else if (!strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001141 platformSurfaceExtFound = 1;
1142 enabled_instance_extensions.push_back(VK_KHR_WIN32_SURFACE_EXTENSION_NAME);
1143 }
1144#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001145 else if (!strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001146 platformSurfaceExtFound = 1;
1147 enabled_instance_extensions.push_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME);
1148 }
1149#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001150 else if (!strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001151 platformSurfaceExtFound = 1;
1152 enabled_instance_extensions.push_back(VK_KHR_XCB_SURFACE_EXTENSION_NAME);
1153 }
1154#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001155 else if (!strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001156 platformSurfaceExtFound = 1;
1157 enabled_instance_extensions.push_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME);
1158 }
1159#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001160 else if (!strcmp(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001161 platformSurfaceExtFound = 1;
1162 enabled_instance_extensions.push_back(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME);
1163 }
1164#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001165 else if (!strcmp(VK_KHR_DISPLAY_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001166 platformSurfaceExtFound = 1;
1167 enabled_instance_extensions.push_back(VK_KHR_DISPLAY_EXTENSION_NAME);
1168 }
1169#elif defined(VK_USE_PLATFORM_METAL_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001170 else if (!strcmp(VK_EXT_METAL_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001171 platformSurfaceExtFound = 1;
1172 enabled_instance_extensions.push_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
1173 }
1174#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001175 }
1176
1177 if (!surfaceExtFound) {
1178 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_SURFACE_EXTENSION_NAME
1179 " extension.\n\n"
1180 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1181 "Please look at the Getting Started guide for additional information.\n",
1182 "vkCreateInstance Failure");
1183 }
1184
1185 if (!platformSurfaceExtFound) {
1186#if defined(VK_USE_PLATFORM_WIN32_KHR)
1187 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WIN32_SURFACE_EXTENSION_NAME
1188 " extension.\n\n"
1189 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1190 "Please look at the Getting Started guide for additional information.\n",
1191 "vkCreateInstance Failure");
1192#elif defined(VK_USE_PLATFORM_XCB_KHR)
1193 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XCB_SURFACE_EXTENSION_NAME
1194 " extension.\n\n"
1195 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1196 "Please look at the Getting Started guide for additional information.\n",
1197 "vkCreateInstance Failure");
1198#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1199 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME
1200 " extension.\n\n"
1201 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1202 "Please look at the Getting Started guide for additional information.\n",
1203 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001204#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001205 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XLIB_SURFACE_EXTENSION_NAME
1206 " extension.\n\n"
1207 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1208 "Please look at the Getting Started guide for additional information.\n",
1209 "vkCreateInstance Failure");
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001210#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1211 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME
1212 " extension.\n\n"
1213 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1214 "Please look at the Getting Started guide for additional information.\n",
1215 "vkCreateInstance Failure");
Damien Leone600c3052017-01-31 10:26:07 -07001216#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001217 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_DISPLAY_EXTENSION_NAME
1218 " extension.\n\n"
1219 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1220 "Please look at the Getting Started guide for additional information.\n",
1221 "vkCreateInstance Failure");
Bill Hollings0a0625a2019-07-15 17:39:18 -04001222#elif defined(VK_USE_PLATFORM_METAL_EXT)
1223 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_METAL_SURFACE_EXTENSION_NAME
Karl Schultz9ceac062017-12-12 10:33:01 -05001224 " extension.\n\nDo you have a compatible "
1225 "Vulkan installable client driver (ICD) installed?\nPlease "
1226 "look at the Getting Started guide for additional "
1227 "information.\n",
1228 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001229#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001230 }
Charles Giessen74f007d2022-02-08 14:04:45 -07001231
1232 vk::DebugUtilsMessageSeverityFlagsEXT severityFlags(vk::DebugUtilsMessageSeverityFlagBitsEXT::eWarning |
1233 vk::DebugUtilsMessageSeverityFlagBitsEXT::eError);
1234 vk::DebugUtilsMessageTypeFlagsEXT messageTypeFlags(vk::DebugUtilsMessageTypeFlagBitsEXT::eGeneral |
1235 vk::DebugUtilsMessageTypeFlagBitsEXT::ePerformance |
1236 vk::DebugUtilsMessageTypeFlagBitsEXT::eValidation);
1237 auto debug_utils_create_info = vk::DebugUtilsMessengerCreateInfoEXT({}, severityFlags, messageTypeFlags,
1238 &debug_messenger_callback, static_cast<void *>(this));
1239
Dave Houlton5fa47912018-02-16 11:02:26 -07001240 auto const app = vk::ApplicationInfo()
1241 .setPApplicationName(APP_SHORT_NAME)
1242 .setApplicationVersion(0)
1243 .setPEngineName(APP_SHORT_NAME)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001244 .setEngineVersion(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001245 auto const inst_info = vk::InstanceCreateInfo()
Charles Giessen5f3ce242022-04-11 14:39:06 -06001246 .setFlags(portabilityEnumerationActive ? vk::InstanceCreateFlagBits::eEnumeratePortabilityKHR
1247 : static_cast<vk::InstanceCreateFlagBits>(0))
Charles Giessen74f007d2022-02-08 14:04:45 -07001248 .setPNext((use_debug_messenger && validate) ? &debug_utils_create_info : nullptr)
Dave Houlton5fa47912018-02-16 11:02:26 -07001249 .setPApplicationInfo(&app)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001250 .setPEnabledLayerNames(enabled_layers)
1251 .setPEnabledExtensionNames(enabled_instance_extensions);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001252
Charles Giessen87dd88d2022-02-03 13:46:29 -07001253 auto instance_result = vk::createInstance(inst_info);
1254 if (instance_result.result == vk::Result::eErrorIncompatibleDriver) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001255 ERR_EXIT(
1256 "Cannot find a compatible Vulkan installable client driver (ICD).\n\n"
1257 "Please look at the Getting Started guide for additional information.\n",
1258 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001259 } else if (instance_result.result == vk::Result::eErrorExtensionNotPresent) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001260 ERR_EXIT(
1261 "Cannot find a specified extension library.\n"
1262 "Make sure your layers path is set appropriately.\n",
1263 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001264 } else if (instance_result.result != vk::Result::eSuccess) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001265 ERR_EXIT(
1266 "vkCreateInstance failed.\n\n"
1267 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1268 "Please look at the Getting Started guide for additional information.\n",
1269 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001270 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07001271 inst = instance_result.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001272
Charles Giessen74f007d2022-02-08 14:04:45 -07001273 if (use_debug_messenger) {
1274 pfnVkCreateDebugUtilsMessengerEXT =
1275 reinterpret_cast<PFN_vkCreateDebugUtilsMessengerEXT>(inst.getProcAddr("vkCreateDebugUtilsMessengerEXT"));
1276 pfnVkDestroyDebugUtilsMessengerEXT =
1277 reinterpret_cast<PFN_vkDestroyDebugUtilsMessengerEXT>(inst.getProcAddr("vkDestroyDebugUtilsMessengerEXT"));
1278 VERIFY(pfnVkCreateDebugUtilsMessengerEXT != nullptr && pfnVkDestroyDebugUtilsMessengerEXT != nullptr);
1279 auto create_debug_messenger_return = inst.createDebugUtilsMessengerEXT(debug_utils_create_info);
1280 VERIFY(create_debug_messenger_return.result == vk::Result::eSuccess);
1281 debug_messenger = create_debug_messenger_return.value;
1282 }
1283
Charles Giessen87dd88d2022-02-03 13:46:29 -07001284 auto physical_device_return = inst.enumeratePhysicalDevices();
1285 VERIFY(physical_device_return.result == vk::Result::eSuccess);
1286 auto physical_devices = physical_device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001287
Charles Giessen87dd88d2022-02-03 13:46:29 -07001288 if (physical_devices.size() <= 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001289 ERR_EXIT(
1290 "vkEnumeratePhysicalDevices reported zero accessible devices.\n\n"
1291 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1292 "Please look at the Getting Started guide for additional information.\n",
1293 "vkEnumeratePhysicalDevices Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001294 }
1295
Charles Giessen87dd88d2022-02-03 13:46:29 -07001296 if (gpu_number >= 0 && !(static_cast<uint32_t>(gpu_number) < physical_devices.size())) {
1297 fprintf(stderr, "GPU %d specified is not present, GPU count = %zu\n", gpu_number, physical_devices.size());
Witold Baryluka3b988f2021-01-07 19:03:02 +00001298 ERR_EXIT("Specified GPU number is not present", "User Error");
1299 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001300#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001301 gpu_number = find_display_gpu(gpu_number, physical_devices);
Tony-LunarG27c21242021-03-11 16:28:19 -07001302 if (gpu_number < 0) {
1303 printf("Cannot find any display!\n");
1304 fflush(stdout);
1305 exit(1);
1306 }
1307#else
Witold Baryluka3b988f2021-01-07 19:03:02 +00001308 /* Try to auto select most suitable device */
1309 if (gpu_number == -1) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001310 constexpr uint32_t device_type_count = static_cast<uint32_t>(vk::PhysicalDeviceType::eCpu) + 1;
1311 std::array<uint32_t, device_type_count> count_device_type{};
Witold Baryluka3b988f2021-01-07 19:03:02 +00001312
Charles Giessen87dd88d2022-02-03 13:46:29 -07001313 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001314 const auto physicalDeviceProperties = physical_devices[i].getProperties();
Charles Giessen87dd88d2022-02-03 13:46:29 -07001315 assert(physicalDeviceProperties.deviceType <= vk::PhysicalDeviceType::eCpu);
Witold Baryluka3b988f2021-01-07 19:03:02 +00001316 count_device_type[static_cast<int>(physicalDeviceProperties.deviceType)]++;
1317 }
1318
Charles Giessen87dd88d2022-02-03 13:46:29 -07001319 std::array<vk::PhysicalDeviceType, device_type_count> const device_type_preference = {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001320 vk::PhysicalDeviceType::eDiscreteGpu, vk::PhysicalDeviceType::eIntegratedGpu, vk::PhysicalDeviceType::eVirtualGpu,
1321 vk::PhysicalDeviceType::eCpu, vk::PhysicalDeviceType::eOther};
Charles Giessen87dd88d2022-02-03 13:46:29 -07001322
Witold Baryluka3b988f2021-01-07 19:03:02 +00001323 vk::PhysicalDeviceType search_for_device_type = vk::PhysicalDeviceType::eDiscreteGpu;
1324 for (uint32_t i = 0; i < sizeof(device_type_preference) / sizeof(vk::PhysicalDeviceType); i++) {
1325 if (count_device_type[static_cast<int>(device_type_preference[i])]) {
1326 search_for_device_type = device_type_preference[i];
1327 break;
1328 }
1329 }
1330
Charles Giessen87dd88d2022-02-03 13:46:29 -07001331 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001332 const auto physicalDeviceProperties = physical_devices[i].getProperties();
1333 if (physicalDeviceProperties.deviceType == search_for_device_type) {
1334 gpu_number = i;
1335 break;
1336 }
1337 }
1338 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001339#endif
Witold Baryluka3b988f2021-01-07 19:03:02 +00001340 assert(gpu_number >= 0);
1341 gpu = physical_devices[gpu_number];
1342 {
1343 auto physicalDeviceProperties = gpu.getProperties();
1344 fprintf(stderr, "Selected GPU %d: %s, type: %s\n", gpu_number, physicalDeviceProperties.deviceName.data(),
1345 to_string(physicalDeviceProperties.deviceType).c_str());
1346 }
Witold Baryluka3b988f2021-01-07 19:03:02 +00001347
Dave Houlton5fa47912018-02-16 11:02:26 -07001348 /* Look for device extensions */
Dave Houlton5fa47912018-02-16 11:02:26 -07001349 vk::Bool32 swapchainExtFound = VK_FALSE;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001350
Charles Giessen87dd88d2022-02-03 13:46:29 -07001351 auto device_extension_return = gpu.enumerateDeviceExtensionProperties();
1352 VERIFY(device_extension_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001353
Charles Giessen87dd88d2022-02-03 13:46:29 -07001354 for (const auto &extension : device_extension_return.value) {
1355 if (!strcmp(VK_KHR_SWAPCHAIN_EXTENSION_NAME, extension.extensionName)) {
1356 swapchainExtFound = 1;
1357 enabled_device_extensions.push_back(VK_KHR_SWAPCHAIN_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001358 } else if (!strcmp("VK_KHR_portability_subset", extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001359 enabled_device_extensions.push_back("VK_KHR_portability_subset");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001360 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001361 }
Jeremy Hayes6ae1f8a2016-11-16 14:47:13 -07001362
Dave Houlton5fa47912018-02-16 11:02:26 -07001363 if (!swapchainExtFound) {
1364 ERR_EXIT("vkEnumerateDeviceExtensionProperties failed to find the " VK_KHR_SWAPCHAIN_EXTENSION_NAME
1365 " extension.\n\n"
1366 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1367 "Please look at the Getting Started guide for additional information.\n",
1368 "vkCreateInstance Failure");
1369 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001370
Dave Houlton5fa47912018-02-16 11:02:26 -07001371 gpu.getProperties(&gpu_props);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001372
Dave Houlton5fa47912018-02-16 11:02:26 -07001373 /* Call with nullptr data to get count */
Charles Giessen87dd88d2022-02-03 13:46:29 -07001374 queue_props = gpu.getQueueFamilyProperties();
1375 assert(queue_props.size() >= 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001376
Dave Houlton5fa47912018-02-16 11:02:26 -07001377 // Query fine-grained feature support for this device.
1378 // If app has specific feature requirements it should check supported
1379 // features based on this query
1380 vk::PhysicalDeviceFeatures physDevFeatures;
1381 gpu.getFeatures(&physDevFeatures);
1382}
1383
Tony-LunarG6cebf142019-09-11 14:32:23 -06001384void Demo::create_surface() {
Dave Houlton5fa47912018-02-16 11:02:26 -07001385// Create a WSI surface for the window:
1386#if defined(VK_USE_PLATFORM_WIN32_KHR)
1387 {
1388 auto const createInfo = vk::Win32SurfaceCreateInfoKHR().setHinstance(connection).setHwnd(window);
1389
1390 auto result = inst.createWin32SurfaceKHR(&createInfo, nullptr, &surface);
1391 VERIFY(result == vk::Result::eSuccess);
1392 }
1393#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1394 {
1395 auto const createInfo = vk::WaylandSurfaceCreateInfoKHR().setDisplay(display).setSurface(window);
1396
1397 auto result = inst.createWaylandSurfaceKHR(&createInfo, nullptr, &surface);
1398 VERIFY(result == vk::Result::eSuccess);
1399 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001400#elif defined(VK_USE_PLATFORM_XLIB_KHR)
1401 {
1402 auto const createInfo = vk::XlibSurfaceCreateInfoKHR().setDpy(display).setWindow(xlib_window);
1403
1404 auto result = inst.createXlibSurfaceKHR(&createInfo, nullptr, &surface);
1405 VERIFY(result == vk::Result::eSuccess);
1406 }
1407#elif defined(VK_USE_PLATFORM_XCB_KHR)
1408 {
1409 auto const createInfo = vk::XcbSurfaceCreateInfoKHR().setConnection(connection).setWindow(xcb_window);
1410
1411 auto result = inst.createXcbSurfaceKHR(&createInfo, nullptr, &surface);
1412 VERIFY(result == vk::Result::eSuccess);
1413 }
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001414#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1415 {
1416 auto const createInfo = vk::DirectFBSurfaceCreateInfoEXT().setDfb(dfb).setSurface(window);
1417
1418 auto result = inst.createDirectFBSurfaceEXT(&createInfo, nullptr, &surface);
1419 VERIFY(result == vk::Result::eSuccess);
1420 }
Bill Hollings0a0625a2019-07-15 17:39:18 -04001421#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05001422 {
Bill Hollings0a0625a2019-07-15 17:39:18 -04001423 auto const createInfo = vk::MetalSurfaceCreateInfoEXT().setPLayer(static_cast<CAMetalLayer *>(caMetalLayer));
Karl Schultz9ceac062017-12-12 10:33:01 -05001424
Bill Hollings0a0625a2019-07-15 17:39:18 -04001425 auto result = inst.createMetalSurfaceEXT(&createInfo, nullptr, &surface);
Karl Schultz9ceac062017-12-12 10:33:01 -05001426 VERIFY(result == vk::Result::eSuccess);
1427 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001428#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
1429 {
1430 auto result = create_display_surface();
1431 VERIFY(result == vk::Result::eSuccess);
1432 }
1433#endif
Tony-LunarG6cebf142019-09-11 14:32:23 -06001434}
1435
1436void Demo::init_vk_swapchain() {
1437 create_surface();
Dave Houlton5fa47912018-02-16 11:02:26 -07001438 // Iterate over each queue to learn whether it supports presenting:
Charles Giessenc2f1a942022-02-06 23:38:39 -07001439 std::vector<vk::Bool32> supportsPresent;
1440 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
1441 auto supports = gpu.getSurfaceSupportKHR(i, surface);
1442 VERIFY(supports.result == vk::Result::eSuccess);
1443 supportsPresent.push_back(supports.value);
Dave Houlton5fa47912018-02-16 11:02:26 -07001444 }
1445
1446 uint32_t graphicsQueueFamilyIndex = UINT32_MAX;
1447 uint32_t presentQueueFamilyIndex = UINT32_MAX;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001448 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001449 if (queue_props[i].queueFlags & vk::QueueFlagBits::eGraphics) {
1450 if (graphicsQueueFamilyIndex == UINT32_MAX) {
1451 graphicsQueueFamilyIndex = i;
1452 }
1453
1454 if (supportsPresent[i] == VK_TRUE) {
1455 graphicsQueueFamilyIndex = i;
1456 presentQueueFamilyIndex = i;
Jeremy Hayes00399e32017-06-14 15:07:32 -06001457 break;
1458 }
1459 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001460 }
Jeremy Hayes00399e32017-06-14 15:07:32 -06001461
Dave Houlton5fa47912018-02-16 11:02:26 -07001462 if (presentQueueFamilyIndex == UINT32_MAX) {
1463 // If didn't find a queue that supports both graphics and present,
1464 // then
1465 // find a separate present queue.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001466 for (uint32_t i = 0; i < queue_props.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001467 if (supportsPresent[i] == VK_TRUE) {
1468 presentQueueFamilyIndex = i;
1469 break;
1470 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001471 }
1472 }
1473
Dave Houlton5fa47912018-02-16 11:02:26 -07001474 // Generate error if could not find both a graphics and a present queue
1475 if (graphicsQueueFamilyIndex == UINT32_MAX || presentQueueFamilyIndex == UINT32_MAX) {
1476 ERR_EXIT("Could not find both graphics and present queues\n", "Swapchain Initialization Failure");
1477 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001478
Dave Houlton5fa47912018-02-16 11:02:26 -07001479 graphics_queue_family_index = graphicsQueueFamilyIndex;
1480 present_queue_family_index = presentQueueFamilyIndex;
1481 separate_present_queue = (graphics_queue_family_index != present_queue_family_index);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001482
Dave Houlton5fa47912018-02-16 11:02:26 -07001483 create_device();
Jeremy Hayes00399e32017-06-14 15:07:32 -06001484
Charles Giessenc2f1a942022-02-06 23:38:39 -07001485 graphics_queue = device.getQueue(graphics_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001486 if (!separate_present_queue) {
1487 present_queue = graphics_queue;
1488 } else {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001489 present_queue = device.getQueue(present_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001490 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001491
Dave Houlton5fa47912018-02-16 11:02:26 -07001492 // Get the list of VkFormat's that are supported:
Charles Giessen87dd88d2022-02-03 13:46:29 -07001493 auto surface_formats_return = gpu.getSurfaceFormatsKHR(surface);
1494 VERIFY(surface_formats_return.result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001495
Charles Giessen7dc2dd52022-02-03 13:55:48 -07001496 vk::SurfaceFormatKHR surfaceFormat = pick_surface_format(surface_formats_return.value);
1497 format = surfaceFormat.format;
1498 color_space = surfaceFormat.colorSpace;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001499
Dave Houlton5fa47912018-02-16 11:02:26 -07001500 quit = false;
1501 curFrame = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001502
Dave Houlton5fa47912018-02-16 11:02:26 -07001503 // Create semaphores to synchronize acquiring presentable buffers before
1504 // rendering and waiting for drawing to be complete before presenting
1505 auto const semaphoreCreateInfo = vk::SemaphoreCreateInfo();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001506
Dave Houlton5fa47912018-02-16 11:02:26 -07001507 // Create fences that we can use to throttle if we get too far
1508 // ahead of the image presents
1509 auto const fence_ci = vk::FenceCreateInfo().setFlags(vk::FenceCreateFlagBits::eSignaled);
1510 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001511 vk::Result result = device.createFence(&fence_ci, nullptr, &fences[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -07001512 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001513
Dave Houlton5fa47912018-02-16 11:02:26 -07001514 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_acquired_semaphores[i]);
1515 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001516
Dave Houlton5fa47912018-02-16 11:02:26 -07001517 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &draw_complete_semaphores[i]);
1518 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001519
Dave Houlton5fa47912018-02-16 11:02:26 -07001520 if (separate_present_queue) {
1521 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_ownership_semaphores[i]);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001522 VERIFY(result == vk::Result::eSuccess);
1523 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001524 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001525 frame_index = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001526
Dave Houlton5fa47912018-02-16 11:02:26 -07001527 // Get Memory information and properties
Charles Giessen87dd88d2022-02-03 13:46:29 -07001528 memory_properties = gpu.getMemoryProperties();
Dave Houlton5fa47912018-02-16 11:02:26 -07001529}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001530
Dave Houlton5fa47912018-02-16 11:02:26 -07001531void Demo::prepare() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001532 prepare_init_cmd();
Dave Houlton5fa47912018-02-16 11:02:26 -07001533
1534 prepare_buffers();
1535 prepare_depth();
1536 prepare_textures();
1537 prepare_cube_data_buffers();
1538
1539 prepare_descriptor_layout();
1540 prepare_render_pass();
1541 prepare_pipeline();
1542
Charles Giessen87dd88d2022-02-03 13:46:29 -07001543 for (auto &swapchain_image_resource : swapchain_image_resources) {
1544 auto alloc_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1545 .setCommandPool(cmd_pool)
1546 .setLevel(vk::CommandBufferLevel::ePrimary)
1547 .setCommandBufferCount(1));
1548 VERIFY(alloc_return.result == vk::Result::eSuccess);
1549 swapchain_image_resource.cmd = alloc_return.value[0];
Dave Houlton5fa47912018-02-16 11:02:26 -07001550 }
1551
1552 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001553 auto present_cmd_pool_return =
1554 device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(present_queue_family_index));
1555 VERIFY(present_cmd_pool_return.result == vk::Result::eSuccess);
1556 present_cmd_pool = present_cmd_pool_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001557
Charles Giessen87dd88d2022-02-03 13:46:29 -07001558 for (auto &swapchain_image_resource : swapchain_image_resources) {
1559 auto alloc_cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1560 .setCommandPool(present_cmd_pool)
1561 .setLevel(vk::CommandBufferLevel::ePrimary)
1562 .setCommandBufferCount(1));
1563 VERIFY(alloc_cmd_return.result == vk::Result::eSuccess);
1564 swapchain_image_resource.graphics_to_present_cmd = alloc_cmd_return.value[0];
1565 build_image_ownership_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001566 }
1567 }
1568
1569 prepare_descriptor_pool();
1570 prepare_descriptor_set();
1571
1572 prepare_framebuffers();
1573
Charles Giessen87dd88d2022-02-03 13:46:29 -07001574 for (const auto &swapchain_image_resource : swapchain_image_resources) {
1575 draw_build_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001576 }
1577
1578 /*
1579 * Prepare functions above may generate pipeline commands
1580 * that need to be flushed before beginning the render loop.
1581 */
1582 flush_init_cmd();
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001583 if (staging_texture.buffer) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001584 destroy_texture(staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07001585 }
1586
1587 current_buffer = 0;
1588 prepared = true;
1589}
1590
1591void Demo::prepare_buffers() {
1592 vk::SwapchainKHR oldSwapchain = swapchain;
1593
1594 // Check the surface capabilities and formats
Charles Giessen87dd88d2022-02-03 13:46:29 -07001595 auto surface_capabilities_return = gpu.getSurfaceCapabilitiesKHR(surface);
1596 VERIFY(surface_capabilities_return.result == vk::Result::eSuccess);
1597 auto surfCapabilities = surface_capabilities_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001598
Charles Giessen87dd88d2022-02-03 13:46:29 -07001599 auto present_modes_return = gpu.getSurfacePresentModesKHR(surface);
1600 VERIFY(present_modes_return.result == vk::Result::eSuccess);
1601 auto present_modes = present_modes_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001602
1603 vk::Extent2D swapchainExtent;
1604 // width and height are either both -1, or both not -1.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001605 if (surfCapabilities.currentExtent.width == static_cast<uint32_t>(-1)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001606 // If the surface size is undefined, the size is set to
1607 // the size of the images requested.
1608 swapchainExtent.width = width;
1609 swapchainExtent.height = height;
1610 } else {
1611 // If the surface size is defined, the swap chain size must match
1612 swapchainExtent = surfCapabilities.currentExtent;
1613 width = surfCapabilities.currentExtent.width;
1614 height = surfCapabilities.currentExtent.height;
1615 }
1616
1617 // The FIFO present mode is guaranteed by the spec to be supported
1618 // and to have no tearing. It's a great default present mode to use.
1619 vk::PresentModeKHR swapchainPresentMode = vk::PresentModeKHR::eFifo;
1620
1621 // There are times when you may wish to use another present mode. The
1622 // following code shows how to select them, and the comments provide some
1623 // reasons you may wish to use them.
1624 //
1625 // It should be noted that Vulkan 1.0 doesn't provide a method for
1626 // synchronizing rendering with the presentation engine's display. There
1627 // is a method provided for throttling rendering with the display, but
1628 // there are some presentation engines for which this method will not work.
1629 // If an application doesn't throttle its rendering, and if it renders much
1630 // faster than the refresh rate of the display, this can waste power on
1631 // mobile devices. That is because power is being spent rendering images
1632 // that may never be seen.
1633
1634 // VK_PRESENT_MODE_IMMEDIATE_KHR is for applications that don't care
1635 // about
1636 // tearing, or have some way of synchronizing their rendering with the
1637 // display.
1638 // VK_PRESENT_MODE_MAILBOX_KHR may be useful for applications that
1639 // generally render a new presentable image every refresh cycle, but are
1640 // occasionally early. In this case, the application wants the new
1641 // image
1642 // to be displayed instead of the previously-queued-for-presentation
1643 // image
1644 // that has not yet been displayed.
1645 // VK_PRESENT_MODE_FIFO_RELAXED_KHR is for applications that generally
1646 // render a new presentable image every refresh cycle, but are
1647 // occasionally
1648 // late. In this case (perhaps because of stuttering/latency concerns),
1649 // the application wants the late image to be immediately displayed,
1650 // even
1651 // though that may mean some tearing.
1652
1653 if (presentMode != swapchainPresentMode) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001654 for (const auto &mode : present_modes) {
1655 if (mode == presentMode) {
1656 swapchainPresentMode = mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07001657 break;
1658 }
1659 }
1660 }
1661
1662 if (swapchainPresentMode != presentMode) {
1663 ERR_EXIT("Present mode specified is not supported\n", "Present mode unsupported");
1664 }
1665
1666 // Determine the number of VkImages to use in the swap chain.
1667 // Application desires to acquire 3 images at a time for triple
1668 // buffering
1669 uint32_t desiredNumOfSwapchainImages = 3;
1670 if (desiredNumOfSwapchainImages < surfCapabilities.minImageCount) {
1671 desiredNumOfSwapchainImages = surfCapabilities.minImageCount;
1672 }
1673
1674 // If maxImageCount is 0, we can ask for as many images as we want,
1675 // otherwise
1676 // we're limited to maxImageCount
1677 if ((surfCapabilities.maxImageCount > 0) && (desiredNumOfSwapchainImages > surfCapabilities.maxImageCount)) {
1678 // Application must settle for fewer images than desired:
1679 desiredNumOfSwapchainImages = surfCapabilities.maxImageCount;
1680 }
1681
1682 vk::SurfaceTransformFlagBitsKHR preTransform;
1683 if (surfCapabilities.supportedTransforms & vk::SurfaceTransformFlagBitsKHR::eIdentity) {
1684 preTransform = vk::SurfaceTransformFlagBitsKHR::eIdentity;
1685 } else {
1686 preTransform = surfCapabilities.currentTransform;
1687 }
1688
1689 // Find a supported composite alpha mode - one of these is guaranteed to be set
1690 vk::CompositeAlphaFlagBitsKHR compositeAlpha = vk::CompositeAlphaFlagBitsKHR::eOpaque;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001691 std::array<vk::CompositeAlphaFlagBitsKHR, 4> compositeAlphaFlags = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001692 vk::CompositeAlphaFlagBitsKHR::eOpaque,
1693 vk::CompositeAlphaFlagBitsKHR::ePreMultiplied,
1694 vk::CompositeAlphaFlagBitsKHR::ePostMultiplied,
1695 vk::CompositeAlphaFlagBitsKHR::eInherit,
1696 };
Charles Giessenc2f1a942022-02-06 23:38:39 -07001697 for (const auto &compositeAlphaFlag : compositeAlphaFlags) {
1698 if (surfCapabilities.supportedCompositeAlpha & compositeAlphaFlag) {
1699 compositeAlpha = compositeAlphaFlag;
Dave Houlton5fa47912018-02-16 11:02:26 -07001700 break;
1701 }
1702 }
1703
Charles Giessen87dd88d2022-02-03 13:46:29 -07001704 auto swapchain_return = device.createSwapchainKHR(vk::SwapchainCreateInfoKHR()
1705 .setSurface(surface)
1706 .setMinImageCount(desiredNumOfSwapchainImages)
1707 .setImageFormat(format)
1708 .setImageColorSpace(color_space)
1709 .setImageExtent({swapchainExtent.width, swapchainExtent.height})
1710 .setImageArrayLayers(1)
1711 .setImageUsage(vk::ImageUsageFlagBits::eColorAttachment)
1712 .setImageSharingMode(vk::SharingMode::eExclusive)
1713 .setPreTransform(preTransform)
1714 .setCompositeAlpha(compositeAlpha)
1715 .setPresentMode(swapchainPresentMode)
1716 .setClipped(true)
1717 .setOldSwapchain(oldSwapchain));
1718 VERIFY(swapchain_return.result == vk::Result::eSuccess);
1719 swapchain = swapchain_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001720
1721 // If we just re-created an existing swapchain, we should destroy the
1722 // old
1723 // swapchain at this point.
1724 // Note: destroying the swapchain also cleans up all its associated
1725 // presentable images once the platform is done with them.
1726 if (oldSwapchain) {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001727 device.destroySwapchainKHR(oldSwapchain);
Dave Houlton5fa47912018-02-16 11:02:26 -07001728 }
1729
Charles Giessen87dd88d2022-02-03 13:46:29 -07001730 auto swapchain_images_return = device.getSwapchainImagesKHR(swapchain);
1731 VERIFY(swapchain_images_return.result == vk::Result::eSuccess);
1732 swapchain_image_resources.resize(swapchain_images_return.value.size());
Dave Houlton5fa47912018-02-16 11:02:26 -07001733
Charles Giessen87dd88d2022-02-03 13:46:29 -07001734 for (uint32_t i = 0; i < swapchain_image_resources.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001735 auto color_image_view = vk::ImageViewCreateInfo()
1736 .setViewType(vk::ImageViewType::e2D)
1737 .setFormat(format)
1738 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
1739
Charles Giessen87dd88d2022-02-03 13:46:29 -07001740 swapchain_image_resources[i].image = swapchain_images_return.value[i];
Dave Houlton5fa47912018-02-16 11:02:26 -07001741
1742 color_image_view.image = swapchain_image_resources[i].image;
1743
Charles Giessen87dd88d2022-02-03 13:46:29 -07001744 auto image_view_return = device.createImageView(color_image_view);
1745 VERIFY(image_view_return.result == vk::Result::eSuccess);
1746 swapchain_image_resources[i].view = image_view_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001747 }
1748}
1749
1750void Demo::prepare_cube_data_buffers() {
1751 mat4x4 VP;
1752 mat4x4_mul(VP, projection_matrix, view_matrix);
1753
1754 mat4x4 MVP;
1755 mat4x4_mul(MVP, VP, model_matrix);
1756
1757 vktexcube_vs_uniform data;
1758 memcpy(data.mvp, MVP, sizeof(MVP));
1759 // dumpMatrix("MVP", MVP)
1760
1761 for (int32_t i = 0; i < 12 * 3; i++) {
1762 data.position[i][0] = g_vertex_buffer_data[i * 3];
1763 data.position[i][1] = g_vertex_buffer_data[i * 3 + 1];
1764 data.position[i][2] = g_vertex_buffer_data[i * 3 + 2];
1765 data.position[i][3] = 1.0f;
1766 data.attr[i][0] = g_uv_buffer_data[2 * i];
1767 data.attr[i][1] = g_uv_buffer_data[2 * i + 1];
1768 data.attr[i][2] = 0;
1769 data.attr[i][3] = 0;
1770 }
1771
1772 auto const buf_info = vk::BufferCreateInfo().setSize(sizeof(data)).setUsage(vk::BufferUsageFlagBits::eUniformBuffer);
1773
Charles Giessen87dd88d2022-02-03 13:46:29 -07001774 for (auto &swapchain_image_resource : swapchain_image_resources) {
1775 auto result = device.createBuffer(&buf_info, nullptr, &swapchain_image_resource.uniform_buffer);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001776 VERIFY(result == vk::Result::eSuccess);
1777
1778 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001779 device.getBufferMemoryRequirements(swapchain_image_resource.uniform_buffer, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001780
Dave Houlton5fa47912018-02-16 11:02:26 -07001781 auto mem_alloc = vk::MemoryAllocateInfo().setAllocationSize(mem_reqs.size).setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001782
Dave Houlton5fa47912018-02-16 11:02:26 -07001783 bool const pass = memory_type_from_properties(
1784 mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001785 mem_alloc.memoryTypeIndex);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001786 VERIFY(pass);
1787
Charles Giessen87dd88d2022-02-03 13:46:29 -07001788 result = device.allocateMemory(&mem_alloc, nullptr, &swapchain_image_resource.uniform_memory);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001789 VERIFY(result == vk::Result::eSuccess);
1790
Charles Giessen87dd88d2022-02-03 13:46:29 -07001791 result = device.mapMemory(swapchain_image_resource.uniform_memory, 0, VK_WHOLE_SIZE, vk::MemoryMapFlags(),
1792 &swapchain_image_resource.uniform_memory_ptr);
Tony-LunarG37af49f2019-12-19 12:04:19 -07001793 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001794
Charles Giessen87dd88d2022-02-03 13:46:29 -07001795 memcpy(swapchain_image_resource.uniform_memory_ptr, &data, sizeof data);
Dave Houlton5fa47912018-02-16 11:02:26 -07001796
Charles Giessen87dd88d2022-02-03 13:46:29 -07001797 result = device.bindBufferMemory(swapchain_image_resource.uniform_buffer, swapchain_image_resource.uniform_memory, 0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001798 VERIFY(result == vk::Result::eSuccess);
1799 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001800}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001801
Dave Houlton5fa47912018-02-16 11:02:26 -07001802void Demo::prepare_depth() {
1803 depth.format = vk::Format::eD16Unorm;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001804
Dave Houlton5fa47912018-02-16 11:02:26 -07001805 auto const image = vk::ImageCreateInfo()
1806 .setImageType(vk::ImageType::e2D)
1807 .setFormat(depth.format)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001808 .setExtent({width, height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07001809 .setMipLevels(1)
1810 .setArrayLayers(1)
1811 .setSamples(vk::SampleCountFlagBits::e1)
1812 .setTiling(vk::ImageTiling::eOptimal)
1813 .setUsage(vk::ImageUsageFlagBits::eDepthStencilAttachment)
1814 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07001815 .setInitialLayout(vk::ImageLayout::eUndefined);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001816
Dave Houlton5fa47912018-02-16 11:02:26 -07001817 auto result = device.createImage(&image, nullptr, &depth.image);
1818 VERIFY(result == vk::Result::eSuccess);
1819
1820 vk::MemoryRequirements mem_reqs;
1821 device.getImageMemoryRequirements(depth.image, &mem_reqs);
1822
1823 depth.mem_alloc.setAllocationSize(mem_reqs.size);
1824 depth.mem_alloc.setMemoryTypeIndex(0);
1825
1826 auto const pass = memory_type_from_properties(mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eDeviceLocal,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001827 depth.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07001828 VERIFY(pass);
1829
1830 result = device.allocateMemory(&depth.mem_alloc, nullptr, &depth.mem);
1831 VERIFY(result == vk::Result::eSuccess);
1832
1833 result = device.bindImageMemory(depth.image, depth.mem, 0);
1834 VERIFY(result == vk::Result::eSuccess);
1835
Mark Young43c08f82021-11-30 16:38:25 -07001836 auto view = vk::ImageViewCreateInfo()
Charles Giessen87dd88d2022-02-03 13:46:29 -07001837 .setImage(depth.image)
1838 .setViewType(vk::ImageViewType::e2D)
1839 .setFormat(depth.format)
1840 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eDepth, 0, 1, 0, 1));
Mark Young43c08f82021-11-30 16:38:25 -07001841 if (force_errors) {
1842 // Intentionally force a bad pNext value to generate a validation layer error
1843 view.pNext = &image;
1844 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001845 result = device.createImageView(&view, nullptr, &depth.view);
1846 VERIFY(result == vk::Result::eSuccess);
1847}
1848
1849void Demo::prepare_descriptor_layout() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001850 std::array<vk::DescriptorSetLayoutBinding, 2> const layout_bindings = {
1851 vk::DescriptorSetLayoutBinding()
1852 .setBinding(0)
1853 .setDescriptorType(vk::DescriptorType::eUniformBuffer)
1854 .setDescriptorCount(1)
1855 .setStageFlags(vk::ShaderStageFlagBits::eVertex)
1856 .setPImmutableSamplers(nullptr),
1857 vk::DescriptorSetLayoutBinding()
1858 .setBinding(1)
1859 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1860 .setDescriptorCount(texture_count)
1861 .setStageFlags(vk::ShaderStageFlagBits::eFragment)
1862 .setPImmutableSamplers(nullptr)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001863
Charles Giessen87dd88d2022-02-03 13:46:29 -07001864 auto const descriptor_layout = vk::DescriptorSetLayoutCreateInfo().setBindings(layout_bindings);
Dave Houlton5fa47912018-02-16 11:02:26 -07001865
1866 auto result = device.createDescriptorSetLayout(&descriptor_layout, nullptr, &desc_layout);
1867 VERIFY(result == vk::Result::eSuccess);
1868
Charles Giessen87dd88d2022-02-03 13:46:29 -07001869 auto const pPipelineLayoutCreateInfo = vk::PipelineLayoutCreateInfo().setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001870
1871 result = device.createPipelineLayout(&pPipelineLayoutCreateInfo, nullptr, &pipeline_layout);
1872 VERIFY(result == vk::Result::eSuccess);
1873}
1874
1875void Demo::prepare_descriptor_pool() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001876 std::array<vk::DescriptorPoolSize, 2> const poolSizes = {
1877 vk::DescriptorPoolSize()
1878 .setType(vk::DescriptorType::eUniformBuffer)
1879 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size())),
Dave Houlton5fa47912018-02-16 11:02:26 -07001880 vk::DescriptorPoolSize()
1881 .setType(vk::DescriptorType::eCombinedImageSampler)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001882 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size()) * texture_count)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001883
1884 auto const descriptor_pool =
Charles Giessen87dd88d2022-02-03 13:46:29 -07001885 vk::DescriptorPoolCreateInfo().setMaxSets(static_cast<uint32_t>(swapchain_image_resources.size())).setPoolSizes(poolSizes);
Dave Houlton5fa47912018-02-16 11:02:26 -07001886
1887 auto result = device.createDescriptorPool(&descriptor_pool, nullptr, &desc_pool);
1888 VERIFY(result == vk::Result::eSuccess);
1889}
1890
1891void Demo::prepare_descriptor_set() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001892 auto const alloc_info = vk::DescriptorSetAllocateInfo().setDescriptorPool(desc_pool).setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001893
Charles Giessen87dd88d2022-02-03 13:46:29 -07001894 auto buffer_info = vk::DescriptorBufferInfo().setOffset(0).setRange(sizeof(vktexcube_vs_uniform));
Dave Houlton5fa47912018-02-16 11:02:26 -07001895
Charles Giessen87dd88d2022-02-03 13:46:29 -07001896 std::array<vk::DescriptorImageInfo, texture_count> tex_descs;
Dave Houlton5fa47912018-02-16 11:02:26 -07001897 for (uint32_t i = 0; i < texture_count; i++) {
1898 tex_descs[i].setSampler(textures[i].sampler);
1899 tex_descs[i].setImageView(textures[i].view);
Karl Schultze88bc842018-09-11 16:23:14 -06001900 tex_descs[i].setImageLayout(vk::ImageLayout::eShaderReadOnlyOptimal);
Dave Houlton5fa47912018-02-16 11:02:26 -07001901 }
1902
Charles Giessenc2f1a942022-02-06 23:38:39 -07001903 std::array<vk::WriteDescriptorSet, 2> writes;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001904 writes[0].setDescriptorCount(1).setDescriptorType(vk::DescriptorType::eUniformBuffer).setPBufferInfo(&buffer_info);
Charles Giessen87dd88d2022-02-03 13:46:29 -07001905 writes[1]
1906 .setDstBinding(1)
1907 .setDescriptorCount(texture_count)
1908 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1909 .setImageInfo(tex_descs);
Dave Houlton5fa47912018-02-16 11:02:26 -07001910
Charles Giessen87dd88d2022-02-03 13:46:29 -07001911 for (auto &swapchain_image_resource : swapchain_image_resources) {
1912 auto result = device.allocateDescriptorSets(&alloc_info, &swapchain_image_resource.descriptor_set);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001913 VERIFY(result == vk::Result::eSuccess);
1914
Charles Giessen87dd88d2022-02-03 13:46:29 -07001915 buffer_info.setBuffer(swapchain_image_resource.uniform_buffer);
1916 writes[0].setDstSet(swapchain_image_resource.descriptor_set);
1917 writes[1].setDstSet(swapchain_image_resource.descriptor_set);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001918 device.updateDescriptorSets(writes, {});
Dave Houlton5fa47912018-02-16 11:02:26 -07001919 }
1920}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001921
Dave Houlton5fa47912018-02-16 11:02:26 -07001922void Demo::prepare_framebuffers() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001923 std::array<vk::ImageView, 2> attachments;
Dave Houlton5fa47912018-02-16 11:02:26 -07001924 attachments[1] = depth.view;
1925
Charles Giessen87dd88d2022-02-03 13:46:29 -07001926 for (auto &swapchain_image_resource : swapchain_image_resources) {
1927 attachments[0] = swapchain_image_resource.view;
1928 auto const framebuffer_return = device.createFramebuffer(vk::FramebufferCreateInfo()
1929 .setRenderPass(render_pass)
1930 .setAttachments(attachments)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001931 .setWidth(width)
1932 .setHeight(height)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001933 .setLayers(1));
1934 VERIFY(framebuffer_return.result == vk::Result::eSuccess);
1935 swapchain_image_resource.framebuffer = framebuffer_return.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001936 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001937}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001938
Dave Houlton5fa47912018-02-16 11:02:26 -07001939vk::ShaderModule Demo::prepare_fs() {
1940 const uint32_t fragShaderCode[] = {
Petr Kraus9a4eb6a2017-11-30 14:49:20 +01001941#include "cube.frag.inc"
Dave Houlton5fa47912018-02-16 11:02:26 -07001942 };
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001943
Dave Houlton5fa47912018-02-16 11:02:26 -07001944 frag_shader_module = prepare_shader_module(fragShaderCode, sizeof(fragShaderCode));
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001945
Dave Houlton5fa47912018-02-16 11:02:26 -07001946 return frag_shader_module;
1947}
1948
1949void Demo::prepare_pipeline() {
1950 vk::PipelineCacheCreateInfo const pipelineCacheInfo;
1951 auto result = device.createPipelineCache(&pipelineCacheInfo, nullptr, &pipelineCache);
1952 VERIFY(result == vk::Result::eSuccess);
1953
Charles Giessen87dd88d2022-02-03 13:46:29 -07001954 std::array<vk::PipelineShaderStageCreateInfo, 2> const shaderStageInfo = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001955 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eVertex).setModule(prepare_vs()).setPName("main"),
1956 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eFragment).setModule(prepare_fs()).setPName("main")};
1957
1958 vk::PipelineVertexInputStateCreateInfo const vertexInputInfo;
1959
1960 auto const inputAssemblyInfo = vk::PipelineInputAssemblyStateCreateInfo().setTopology(vk::PrimitiveTopology::eTriangleList);
1961
1962 // TODO: Where are pViewports and pScissors set?
1963 auto const viewportInfo = vk::PipelineViewportStateCreateInfo().setViewportCount(1).setScissorCount(1);
1964
1965 auto const rasterizationInfo = vk::PipelineRasterizationStateCreateInfo()
1966 .setDepthClampEnable(VK_FALSE)
1967 .setRasterizerDiscardEnable(VK_FALSE)
1968 .setPolygonMode(vk::PolygonMode::eFill)
1969 .setCullMode(vk::CullModeFlagBits::eBack)
1970 .setFrontFace(vk::FrontFace::eCounterClockwise)
1971 .setDepthBiasEnable(VK_FALSE)
1972 .setLineWidth(1.0f);
1973
1974 auto const multisampleInfo = vk::PipelineMultisampleStateCreateInfo();
1975
1976 auto const stencilOp =
1977 vk::StencilOpState().setFailOp(vk::StencilOp::eKeep).setPassOp(vk::StencilOp::eKeep).setCompareOp(vk::CompareOp::eAlways);
1978
1979 auto const depthStencilInfo = vk::PipelineDepthStencilStateCreateInfo()
1980 .setDepthTestEnable(VK_TRUE)
1981 .setDepthWriteEnable(VK_TRUE)
1982 .setDepthCompareOp(vk::CompareOp::eLessOrEqual)
1983 .setDepthBoundsTestEnable(VK_FALSE)
1984 .setStencilTestEnable(VK_FALSE)
1985 .setFront(stencilOp)
1986 .setBack(stencilOp);
1987
Charles Giessen87dd88d2022-02-03 13:46:29 -07001988 std::array<vk::PipelineColorBlendAttachmentState, 1> const colorBlendAttachments = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001989 vk::PipelineColorBlendAttachmentState().setColorWriteMask(vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG |
1990 vk::ColorComponentFlagBits::eB | vk::ColorComponentFlagBits::eA)};
1991
Charles Giessen87dd88d2022-02-03 13:46:29 -07001992 auto const colorBlendInfo = vk::PipelineColorBlendStateCreateInfo().setAttachments(colorBlendAttachments);
Dave Houlton5fa47912018-02-16 11:02:26 -07001993
Charles Giessen87dd88d2022-02-03 13:46:29 -07001994 std::array<vk::DynamicState, 2> const dynamicStates = {vk::DynamicState::eViewport, vk::DynamicState::eScissor};
Dave Houlton5fa47912018-02-16 11:02:26 -07001995
Charles Giessen87dd88d2022-02-03 13:46:29 -07001996 auto const dynamicStateInfo = vk::PipelineDynamicStateCreateInfo().setDynamicStates(dynamicStates);
Dave Houlton5fa47912018-02-16 11:02:26 -07001997
Charles Giessenc2f1a942022-02-06 23:38:39 -07001998 auto pipline_return = device.createGraphicsPipelines(pipelineCache, vk::GraphicsPipelineCreateInfo()
1999 .setStages(shaderStageInfo)
2000 .setPVertexInputState(&vertexInputInfo)
2001 .setPInputAssemblyState(&inputAssemblyInfo)
2002 .setPViewportState(&viewportInfo)
2003 .setPRasterizationState(&rasterizationInfo)
2004 .setPMultisampleState(&multisampleInfo)
2005 .setPDepthStencilState(&depthStencilInfo)
2006 .setPColorBlendState(&colorBlendInfo)
2007 .setPDynamicState(&dynamicStateInfo)
2008 .setLayout(pipeline_layout)
2009 .setRenderPass(render_pass));
Dave Houlton5fa47912018-02-16 11:02:26 -07002010 VERIFY(result == vk::Result::eSuccess);
Charles Giessenc2f1a942022-02-06 23:38:39 -07002011 pipeline = pipline_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002012
Charles Giessenc2f1a942022-02-06 23:38:39 -07002013 device.destroyShaderModule(frag_shader_module);
2014 device.destroyShaderModule(vert_shader_module);
Dave Houlton5fa47912018-02-16 11:02:26 -07002015}
2016
2017void Demo::prepare_render_pass() {
2018 // The initial layout for the color and depth attachments will be LAYOUT_UNDEFINED
2019 // because at the start of the renderpass, we don't care about their contents.
2020 // At the start of the subpass, the color attachment's layout will be transitioned
2021 // to LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth stencil attachment's layout
2022 // will be transitioned to LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL. At the end of
2023 // the renderpass, the color attachment's layout will be transitioned to
2024 // LAYOUT_PRESENT_SRC_KHR to be ready to present. This is all done as part of
2025 // the renderpass, no barriers are necessary.
Charles Giessen87dd88d2022-02-03 13:46:29 -07002026 std::array<vk::AttachmentDescription, 2> const attachments = {
2027 vk::AttachmentDescription()
2028 .setFormat(format)
2029 .setSamples(vk::SampleCountFlagBits::e1)
2030 .setLoadOp(vk::AttachmentLoadOp::eClear)
2031 .setStoreOp(vk::AttachmentStoreOp::eStore)
2032 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2033 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2034 .setInitialLayout(vk::ImageLayout::eUndefined)
2035 .setFinalLayout(vk::ImageLayout::ePresentSrcKHR),
2036 vk::AttachmentDescription()
2037 .setFormat(depth.format)
2038 .setSamples(vk::SampleCountFlagBits::e1)
2039 .setLoadOp(vk::AttachmentLoadOp::eClear)
2040 .setStoreOp(vk::AttachmentStoreOp::eDontCare)
2041 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2042 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2043 .setInitialLayout(vk::ImageLayout::eUndefined)
2044 .setFinalLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal)};
Dave Houlton5fa47912018-02-16 11:02:26 -07002045
2046 auto const color_reference = vk::AttachmentReference().setAttachment(0).setLayout(vk::ImageLayout::eColorAttachmentOptimal);
2047
2048 auto const depth_reference =
2049 vk::AttachmentReference().setAttachment(1).setLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal);
2050
2051 auto const subpass = vk::SubpassDescription()
2052 .setPipelineBindPoint(vk::PipelineBindPoint::eGraphics)
Charles Giessen87dd88d2022-02-03 13:46:29 -07002053 .setColorAttachments(color_reference)
2054 .setPDepthStencilAttachment(&depth_reference);
Dave Houlton5fa47912018-02-16 11:02:26 -07002055
Tony-LunarG495604b2019-06-13 15:32:05 -06002056 vk::PipelineStageFlags stages = vk::PipelineStageFlagBits::eEarlyFragmentTests | vk::PipelineStageFlagBits::eLateFragmentTests;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002057 std::array<vk::SubpassDependency, 2> const dependencies = {
Tony-LunarG495604b2019-06-13 15:32:05 -06002058 vk::SubpassDependency() // Depth buffer is shared between swapchain images
2059 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2060 .setDstSubpass(0)
2061 .setSrcStageMask(stages)
2062 .setDstStageMask(stages)
2063 .setSrcAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2064 .setDstAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentRead | vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2065 .setDependencyFlags(vk::DependencyFlags()),
2066 vk::SubpassDependency() // Image layout transition
2067 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2068 .setDstSubpass(0)
2069 .setSrcStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2070 .setDstStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2071 .setSrcAccessMask(vk::AccessFlagBits())
2072 .setDstAccessMask(vk::AccessFlagBits::eColorAttachmentWrite | vk::AccessFlagBits::eColorAttachmentRead)
2073 .setDependencyFlags(vk::DependencyFlags()),
2074 };
2075
Charles Giessen87dd88d2022-02-03 13:46:29 -07002076 const auto render_pass_result = device.createRenderPass(
2077 vk::RenderPassCreateInfo().setAttachments(attachments).setSubpasses(subpass).setDependencies(dependencies));
2078 VERIFY(render_pass_result.result == vk::Result::eSuccess);
2079 render_pass = render_pass_result.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002080}
2081
2082vk::ShaderModule Demo::prepare_shader_module(const uint32_t *code, size_t size) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002083 const auto shader_module_return = device.createShaderModule(vk::ShaderModuleCreateInfo().setCodeSize(size).setPCode(code));
2084 VERIFY(shader_module_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002085
Charles Giessen87dd88d2022-02-03 13:46:29 -07002086 return shader_module_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002087}
2088
Charles Giessen87dd88d2022-02-03 13:46:29 -07002089void Demo::prepare_texture_buffer(const char *filename, texture_object &tex_obj) {
2090 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002091
2092 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002093 ERR_EXIT("Failed to load textures", "Load Texture Failure");
2094 }
2095
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002096 auto const buffer_create_info = vk::BufferCreateInfo()
Charles Giessen3bcefe52022-02-21 11:57:16 -07002097 .setSize(tex_obj.tex_width * tex_obj.tex_height * 4)
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002098 .setUsage(vk::BufferUsageFlagBits::eTransferSrc)
Charles Giessen87dd88d2022-02-03 13:46:29 -07002099 .setSharingMode(vk::SharingMode::eExclusive);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002100
Charles Giessen87dd88d2022-02-03 13:46:29 -07002101 auto result = device.createBuffer(&buffer_create_info, nullptr, &tex_obj.buffer);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002102 VERIFY(result == vk::Result::eSuccess);
2103
2104 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002105 device.getBufferMemoryRequirements(tex_obj.buffer, &mem_reqs);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002106
Charles Giessen87dd88d2022-02-03 13:46:29 -07002107 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
2108 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002109
2110 vk::MemoryPropertyFlags requirements = vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002111 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, requirements, tex_obj.mem_alloc.memoryTypeIndex);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002112 VERIFY(pass == true);
2113
Charles Giessen87dd88d2022-02-03 13:46:29 -07002114 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &(tex_obj.mem));
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002115 VERIFY(result == vk::Result::eSuccess);
2116
Charles Giessen87dd88d2022-02-03 13:46:29 -07002117 result = device.bindBufferMemory(tex_obj.buffer, tex_obj.mem, 0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002118 VERIFY(result == vk::Result::eSuccess);
2119
2120 vk::SubresourceLayout layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002121 layout.rowPitch = tex_obj.tex_width * 4;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002122 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002123 VERIFY(data.result == vk::Result::eSuccess);
2124
Charles Giessen3bcefe52022-02-21 11:57:16 -07002125 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002126 fprintf(stderr, "Error loading texture: %s\n", filename);
2127 }
2128
Charles Giessen87dd88d2022-02-03 13:46:29 -07002129 device.unmapMemory(tex_obj.mem);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002130}
2131
Charles Giessen87dd88d2022-02-03 13:46:29 -07002132void Demo::prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
Dave Houlton5fa47912018-02-16 11:02:26 -07002133 vk::MemoryPropertyFlags required_props) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002134 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002135 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002136 ERR_EXIT("Failed to load textures", "Load Texture Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002137 }
2138
Dave Houlton5fa47912018-02-16 11:02:26 -07002139 auto const image_create_info = vk::ImageCreateInfo()
2140 .setImageType(vk::ImageType::e2D)
2141 .setFormat(vk::Format::eR8G8B8A8Unorm)
Charles Giessen3bcefe52022-02-21 11:57:16 -07002142 .setExtent({tex_obj.tex_width, tex_obj.tex_height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07002143 .setMipLevels(1)
2144 .setArrayLayers(1)
2145 .setSamples(vk::SampleCountFlagBits::e1)
2146 .setTiling(tiling)
2147 .setUsage(usage)
2148 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07002149 .setInitialLayout(vk::ImageLayout::ePreinitialized);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002150
Charles Giessen87dd88d2022-02-03 13:46:29 -07002151 auto result = device.createImage(&image_create_info, nullptr, &tex_obj.image);
Dave Houlton5fa47912018-02-16 11:02:26 -07002152 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002153
Dave Houlton5fa47912018-02-16 11:02:26 -07002154 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002155 device.getImageMemoryRequirements(tex_obj.image, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002156
Charles Giessen87dd88d2022-02-03 13:46:29 -07002157 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
2158 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002159
Charles Giessen87dd88d2022-02-03 13:46:29 -07002160 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, required_props, tex_obj.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07002161 VERIFY(pass == true);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002162
Charles Giessen87dd88d2022-02-03 13:46:29 -07002163 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &tex_obj.mem);
Dave Houlton5fa47912018-02-16 11:02:26 -07002164 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002165
Charles Giessen87dd88d2022-02-03 13:46:29 -07002166 result = device.bindImageMemory(tex_obj.image, tex_obj.mem, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002167 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002168
Dave Houlton5fa47912018-02-16 11:02:26 -07002169 if (required_props & vk::MemoryPropertyFlagBits::eHostVisible) {
2170 auto const subres = vk::ImageSubresource().setAspectMask(vk::ImageAspectFlagBits::eColor).setMipLevel(0).setArrayLayer(0);
2171 vk::SubresourceLayout layout;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002172 device.getImageSubresourceLayout(tex_obj.image, &subres, &layout);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002173
Charles Giessen87dd88d2022-02-03 13:46:29 -07002174 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002175 VERIFY(data.result == vk::Result::eSuccess);
2176
Charles Giessen3bcefe52022-02-21 11:57:16 -07002177 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002178 fprintf(stderr, "Error loading texture: %s\n", filename);
2179 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002180
Charles Giessen87dd88d2022-02-03 13:46:29 -07002181 device.unmapMemory(tex_obj.mem);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002182 }
2183
Charles Giessen87dd88d2022-02-03 13:46:29 -07002184 tex_obj.imageLayout = vk::ImageLayout::eShaderReadOnlyOptimal;
Dave Houlton5fa47912018-02-16 11:02:26 -07002185}
2186
2187void Demo::prepare_textures() {
2188 vk::Format const tex_format = vk::Format::eR8G8B8A8Unorm;
2189 vk::FormatProperties props;
2190 gpu.getFormatProperties(tex_format, &props);
2191
2192 for (uint32_t i = 0; i < texture_count; i++) {
2193 if ((props.linearTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) && !use_staging_buffer) {
2194 /* Device can texture using linear textures */
Charles Giessen87dd88d2022-02-03 13:46:29 -07002195 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eLinear, vk::ImageUsageFlagBits::eSampled,
Dave Houlton5fa47912018-02-16 11:02:26 -07002196 vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent);
2197 // Nothing in the pipeline needs to be complete to start, and don't allow fragment
2198 // shader to run until layout transition completes
2199 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2200 textures[i].imageLayout, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2201 vk::PipelineStageFlagBits::eFragmentShader);
2202 staging_texture.image = vk::Image();
2203 } else if (props.optimalTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) {
2204 /* Must use staging buffer to copy linear texture to optimized */
2205
Charles Giessen87dd88d2022-02-03 13:46:29 -07002206 prepare_texture_buffer(tex_files[i], staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07002207
Charles Giessen87dd88d2022-02-03 13:46:29 -07002208 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eOptimal,
Dave Houlton5fa47912018-02-16 11:02:26 -07002209 vk::ImageUsageFlagBits::eTransferDst | vk::ImageUsageFlagBits::eSampled,
2210 vk::MemoryPropertyFlagBits::eDeviceLocal);
2211
Dave Houlton5fa47912018-02-16 11:02:26 -07002212 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2213 vk::ImageLayout::eTransferDstOptimal, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2214 vk::PipelineStageFlagBits::eTransfer);
2215
2216 auto const subresource = vk::ImageSubresourceLayers()
2217 .setAspectMask(vk::ImageAspectFlagBits::eColor)
2218 .setMipLevel(0)
2219 .setBaseArrayLayer(0)
2220 .setLayerCount(1);
2221
Charles Giessen87dd88d2022-02-03 13:46:29 -07002222 auto const copy_region = vk::BufferImageCopy()
2223 .setBufferOffset(0)
2224 .setBufferRowLength(staging_texture.tex_width)
2225 .setBufferImageHeight(staging_texture.tex_height)
2226 .setImageSubresource(subresource)
2227 .setImageOffset({0, 0, 0})
Charles Giessen3bcefe52022-02-21 11:57:16 -07002228 .setImageExtent({staging_texture.tex_width, staging_texture.tex_height, 1});
Dave Houlton5fa47912018-02-16 11:02:26 -07002229
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002230 cmd.copyBufferToImage(staging_texture.buffer, textures[i].image, vk::ImageLayout::eTransferDstOptimal, 1, &copy_region);
Dave Houlton5fa47912018-02-16 11:02:26 -07002231
2232 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::eTransferDstOptimal,
2233 textures[i].imageLayout, vk::AccessFlagBits::eTransferWrite, vk::PipelineStageFlagBits::eTransfer,
2234 vk::PipelineStageFlagBits::eFragmentShader);
2235 } else {
2236 assert(!"No support for R8G8B8A8_UNORM as texture image format");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002237 }
2238
Dave Houlton5fa47912018-02-16 11:02:26 -07002239 auto const samplerInfo = vk::SamplerCreateInfo()
2240 .setMagFilter(vk::Filter::eNearest)
2241 .setMinFilter(vk::Filter::eNearest)
2242 .setMipmapMode(vk::SamplerMipmapMode::eNearest)
2243 .setAddressModeU(vk::SamplerAddressMode::eClampToEdge)
2244 .setAddressModeV(vk::SamplerAddressMode::eClampToEdge)
2245 .setAddressModeW(vk::SamplerAddressMode::eClampToEdge)
2246 .setMipLodBias(0.0f)
2247 .setAnisotropyEnable(VK_FALSE)
2248 .setMaxAnisotropy(1)
2249 .setCompareEnable(VK_FALSE)
2250 .setCompareOp(vk::CompareOp::eNever)
2251 .setMinLod(0.0f)
2252 .setMaxLod(0.0f)
2253 .setBorderColor(vk::BorderColor::eFloatOpaqueWhite)
2254 .setUnnormalizedCoordinates(VK_FALSE);
2255
2256 auto result = device.createSampler(&samplerInfo, nullptr, &textures[i].sampler);
2257 VERIFY(result == vk::Result::eSuccess);
2258
2259 auto const viewInfo = vk::ImageViewCreateInfo()
2260 .setImage(textures[i].image)
2261 .setViewType(vk::ImageViewType::e2D)
2262 .setFormat(tex_format)
2263 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
2264
2265 result = device.createImageView(&viewInfo, nullptr, &textures[i].view);
2266 VERIFY(result == vk::Result::eSuccess);
2267 }
2268}
2269
2270vk::ShaderModule Demo::prepare_vs() {
2271 const uint32_t vertShaderCode[] = {
2272#include "cube.vert.inc"
2273 };
2274
2275 vert_shader_module = prepare_shader_module(vertShaderCode, sizeof(vertShaderCode));
2276
2277 return vert_shader_module;
2278}
2279
Charles Giessen87dd88d2022-02-03 13:46:29 -07002280void Demo::destroy_swapchain_related_resources() {
2281 device.destroyDescriptorPool(desc_pool);
Dave Houlton5fa47912018-02-16 11:02:26 -07002282
Charles Giessen87dd88d2022-02-03 13:46:29 -07002283 device.destroyPipeline(pipeline);
2284 device.destroyPipelineCache(pipelineCache);
2285 device.destroyRenderPass(render_pass);
2286 device.destroyPipelineLayout(pipeline_layout);
2287 device.destroyDescriptorSetLayout(desc_layout);
2288
2289 for (const auto &tex : textures) {
2290 device.destroyImageView(tex.view);
2291 device.destroyImage(tex.image);
2292 device.freeMemory(tex.mem);
2293 device.destroySampler(tex.sampler);
2294 }
2295
2296 device.destroyImageView(depth.view);
2297 device.destroyImage(depth.image);
2298 device.freeMemory(depth.mem);
2299
2300 for (const auto &resource : swapchain_image_resources) {
2301 device.destroyFramebuffer(resource.framebuffer);
2302 device.destroyImageView(resource.view);
2303 device.freeCommandBuffers(cmd_pool, {resource.cmd});
2304 device.destroyBuffer(resource.uniform_buffer);
2305 device.unmapMemory(resource.uniform_memory);
2306 device.freeMemory(resource.uniform_memory);
2307 }
2308
2309 device.destroyCommandPool(cmd_pool);
2310 if (separate_present_queue) {
2311 device.destroyCommandPool(present_cmd_pool);
2312 }
2313}
2314
2315void Demo::resize() {
Dave Houlton5fa47912018-02-16 11:02:26 -07002316 // Don't react to resize until after first initialization.
2317 if (!prepared) {
2318 return;
2319 }
2320
2321 // In order to properly resize the window, we must re-create the
2322 // swapchain
2323 // AND redo the command buffers, etc.
2324 //
2325 // First, perform part of the cleanup() function:
2326 prepared = false;
2327 auto result = device.waitIdle();
2328 VERIFY(result == vk::Result::eSuccess);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002329 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -07002330
2331 // Second, re-perform the prepare() function, which will re-create the
2332 // swapchain.
2333 prepare();
2334}
2335
2336void Demo::set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
2337 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages) {
2338 assert(cmd);
2339
2340 auto DstAccessMask = [](vk::ImageLayout const &layout) {
2341 vk::AccessFlags flags;
2342
2343 switch (layout) {
2344 case vk::ImageLayout::eTransferDstOptimal:
2345 // Make sure anything that was copying from this image has
2346 // completed
2347 flags = vk::AccessFlagBits::eTransferWrite;
2348 break;
2349 case vk::ImageLayout::eColorAttachmentOptimal:
2350 flags = vk::AccessFlagBits::eColorAttachmentWrite;
2351 break;
2352 case vk::ImageLayout::eDepthStencilAttachmentOptimal:
2353 flags = vk::AccessFlagBits::eDepthStencilAttachmentWrite;
2354 break;
2355 case vk::ImageLayout::eShaderReadOnlyOptimal:
2356 // Make sure any Copy or CPU writes to image are flushed
2357 flags = vk::AccessFlagBits::eShaderRead | vk::AccessFlagBits::eInputAttachmentRead;
2358 break;
2359 case vk::ImageLayout::eTransferSrcOptimal:
2360 flags = vk::AccessFlagBits::eTransferRead;
2361 break;
2362 case vk::ImageLayout::ePresentSrcKHR:
2363 flags = vk::AccessFlagBits::eMemoryRead;
2364 break;
2365 default:
2366 break;
2367 }
2368
2369 return flags;
2370 };
2371
Charles Giessen87dd88d2022-02-03 13:46:29 -07002372 cmd.pipelineBarrier(src_stages, dest_stages, vk::DependencyFlagBits(), {}, {},
2373 vk::ImageMemoryBarrier()
2374 .setSrcAccessMask(srcAccessMask)
2375 .setDstAccessMask(DstAccessMask(newLayout))
2376 .setOldLayout(oldLayout)
2377 .setNewLayout(newLayout)
2378 .setSrcQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2379 .setDstQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2380 .setImage(image)
2381 .setSubresourceRange(vk::ImageSubresourceRange(aspectMask, 0, 1, 0, 1)));
Dave Houlton5fa47912018-02-16 11:02:26 -07002382}
2383
2384void Demo::update_data_buffer() {
2385 mat4x4 VP;
2386 mat4x4_mul(VP, projection_matrix, view_matrix);
2387
2388 // Rotate around the Y axis
2389 mat4x4 Model;
2390 mat4x4_dup(Model, model_matrix);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002391 mat4x4_rotate_Y(model_matrix, Model, static_cast<float>(degreesToRadians(spin_angle)));
Arman Uguray3ae08892021-05-25 00:07:24 -07002392 mat4x4_orthonormalize(model_matrix, model_matrix);
Dave Houlton5fa47912018-02-16 11:02:26 -07002393
2394 mat4x4 MVP;
2395 mat4x4_mul(MVP, VP, model_matrix);
2396
Tony-LunarG37af49f2019-12-19 12:04:19 -07002397 memcpy(swapchain_image_resources[current_buffer].uniform_memory_ptr, (const void *)&MVP[0][0], sizeof(MVP));
Dave Houlton5fa47912018-02-16 11:02:26 -07002398}
2399
Karl Schultzb7940402018-05-29 13:09:22 -06002400/* Convert ppm image data from header file into RGBA texture image */
2401#include "lunarg.ppm.h"
Charles Giessen3bcefe52022-02-21 11:57:16 -07002402bool Demo::loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout &layout, uint32_t &width, uint32_t &height) {
Karl Schultzb7940402018-05-29 13:09:22 -06002403 (void)filename;
2404 char *cPtr;
2405 cPtr = (char *)lunarg_ppm;
2406 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "P6\n", 3)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002407 return false;
2408 }
Karl Schultzb7940402018-05-29 13:09:22 -06002409 while (strncmp(cPtr++, "\n", 1))
2410 ;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002411 sscanf(cPtr, "%u %u", &width, &height);
Charles Giessenc2f1a942022-02-06 23:38:39 -07002412 if (rgba_data == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002413 return true;
2414 }
Karl Schultzb7940402018-05-29 13:09:22 -06002415 while (strncmp(cPtr++, "\n", 1))
2416 ;
2417 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "255\n", 4)) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002418 return false;
2419 }
Karl Schultzb7940402018-05-29 13:09:22 -06002420 while (strncmp(cPtr++, "\n", 1))
2421 ;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002422 for (uint32_t y = 0; y < height; y++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002423 uint8_t *rowPtr = rgba_data;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002424 for (uint32_t x = 0; x < width; x++) {
Karl Schultzb7940402018-05-29 13:09:22 -06002425 memcpy(rowPtr, cPtr, 3);
Dave Houlton5fa47912018-02-16 11:02:26 -07002426 rowPtr[3] = 255; /* Alpha of 1 */
2427 rowPtr += 4;
Karl Schultzb7940402018-05-29 13:09:22 -06002428 cPtr += 3;
Dave Houlton5fa47912018-02-16 11:02:26 -07002429 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07002430 rgba_data += layout.rowPitch;
Dave Houlton5fa47912018-02-16 11:02:26 -07002431 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002432 return true;
2433}
2434
Charles Giessen87dd88d2022-02-03 13:46:29 -07002435bool Demo::memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002436 // Search memtypes to find first index with those properties
2437 for (uint32_t i = 0; i < VK_MAX_MEMORY_TYPES; i++) {
2438 if ((typeBits & 1) == 1) {
2439 // Type is available, does it match user properties?
2440 if ((memory_properties.memoryTypes[i].propertyFlags & requirements_mask) == requirements_mask) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002441 typeIndex = i;
Dave Houlton5fa47912018-02-16 11:02:26 -07002442 return true;
2443 }
2444 }
2445 typeBits >>= 1;
2446 }
2447
2448 // No memory types matched, return failure
2449 return false;
2450}
2451
Charles Giessen7dc2dd52022-02-03 13:55:48 -07002452vk::SurfaceFormatKHR Demo::pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats) {
2453 // Prefer non-SRGB formats...
2454 for (const auto &surface_format : surface_formats) {
2455 const vk::Format format = surface_format.format;
2456
2457 if (format == vk::Format::eR8G8B8A8Unorm || format == vk::Format::eB8G8R8A8Unorm ||
2458 format == vk::Format::eA2B10G10R10UnormPack32 || format == vk::Format::eA2R10G10B10UnormPack32 ||
2459 format == vk::Format::eR16G16B16A16Sfloat) {
2460 return surface_format;
2461 }
2462 }
2463
2464 printf("Can't find our preferred formats... Falling back to first exposed format. Rendering may be incorrect.\n");
2465
2466 assert(surface_formats.size() >= 1);
2467 return surface_formats[0];
2468}
2469
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002470#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07002471void Demo::run() {
2472 if (!prepared) {
2473 return;
2474 }
2475
2476 draw();
2477 curFrame++;
2478
Petr Krausd88e4e52019-01-23 18:45:04 +01002479 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002480 PostQuitMessage(validation_error);
2481 }
2482}
2483
2484void Demo::create_window() {
2485 WNDCLASSEX win_class;
2486
2487 // Initialize the window class structure:
2488 win_class.cbSize = sizeof(WNDCLASSEX);
2489 win_class.style = CS_HREDRAW | CS_VREDRAW;
2490 win_class.lpfnWndProc = WndProc;
2491 win_class.cbClsExtra = 0;
2492 win_class.cbWndExtra = 0;
2493 win_class.hInstance = connection; // hInstance
2494 win_class.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
2495 win_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
2496 win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
2497 win_class.lpszMenuName = nullptr;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002498 win_class.lpszClassName = name.c_str();
Dave Houlton5fa47912018-02-16 11:02:26 -07002499 win_class.hIconSm = LoadIcon(nullptr, IDI_WINLOGO);
2500
2501 // Register window class:
2502 if (!RegisterClassEx(&win_class)) {
2503 // It didn't work, so try to give a useful error:
2504 printf("Unexpected error trying to start the application!\n");
2505 fflush(stdout);
2506 exit(1);
2507 }
2508
2509 // Create window with the registered class:
2510 RECT wr = {0, 0, static_cast<LONG>(width), static_cast<LONG>(height)};
2511 AdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
2512 window = CreateWindowEx(0,
Charles Giessen87dd88d2022-02-03 13:46:29 -07002513 name.c_str(), // class name
2514 name.c_str(), // app name
Dave Houlton5fa47912018-02-16 11:02:26 -07002515 WS_OVERLAPPEDWINDOW | // window style
2516 WS_VISIBLE | WS_SYSMENU,
2517 100, 100, // x/y coords
2518 wr.right - wr.left, // width
2519 wr.bottom - wr.top, // height
2520 nullptr, // handle to parent
2521 nullptr, // handle to menu
2522 connection, // hInstance
2523 nullptr); // no extra parameters
2524
2525 if (!window) {
2526 // It didn't work, so try to give a useful error:
2527 printf("Cannot create a window in which to draw!\n");
2528 fflush(stdout);
2529 exit(1);
2530 }
2531
2532 // Window client area size must be at least 1 pixel high, to prevent
2533 // crash.
2534 minsize.x = GetSystemMetrics(SM_CXMINTRACK);
2535 minsize.y = GetSystemMetrics(SM_CYMINTRACK) + 1;
2536}
2537#elif defined(VK_USE_PLATFORM_XLIB_KHR)
2538
2539void Demo::create_xlib_window() {
2540 const char *display_envar = getenv("DISPLAY");
2541 if (display_envar == nullptr || display_envar[0] == '\0') {
2542 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
2543 fflush(stdout);
2544 exit(1);
2545 }
2546
2547 XInitThreads();
2548 display = XOpenDisplay(nullptr);
2549 long visualMask = VisualScreenMask;
2550 int numberOfVisuals;
2551 XVisualInfo vInfoTemplate = {};
2552 vInfoTemplate.screen = DefaultScreen(display);
2553 XVisualInfo *visualInfo = XGetVisualInfo(display, visualMask, &vInfoTemplate, &numberOfVisuals);
2554
2555 Colormap colormap = XCreateColormap(display, RootWindow(display, vInfoTemplate.screen), visualInfo->visual, AllocNone);
2556
2557 XSetWindowAttributes windowAttributes = {};
2558 windowAttributes.colormap = colormap;
2559 windowAttributes.background_pixel = 0xFFFFFFFF;
2560 windowAttributes.border_pixel = 0;
2561 windowAttributes.event_mask = KeyPressMask | KeyReleaseMask | StructureNotifyMask | ExposureMask;
2562
2563 xlib_window =
2564 XCreateWindow(display, RootWindow(display, vInfoTemplate.screen), 0, 0, width, height, 0, visualInfo->depth, InputOutput,
2565 visualInfo->visual, CWBackPixel | CWBorderPixel | CWEventMask | CWColormap, &windowAttributes);
2566
2567 XSelectInput(display, xlib_window, ExposureMask | KeyPressMask);
2568 XMapWindow(display, xlib_window);
2569 XFlush(display);
2570 xlib_wm_delete_window = XInternAtom(display, "WM_DELETE_WINDOW", False);
2571}
2572
2573void Demo::handle_xlib_event(const XEvent *event) {
2574 switch (event->type) {
2575 case ClientMessage:
2576 if ((Atom)event->xclient.data.l[0] == xlib_wm_delete_window) {
2577 quit = true;
2578 }
2579 break;
2580 case KeyPress:
2581 switch (event->xkey.keycode) {
2582 case 0x9: // Escape
2583 quit = true;
2584 break;
2585 case 0x71: // left arrow key
2586 spin_angle -= spin_increment;
2587 break;
2588 case 0x72: // right arrow key
2589 spin_angle += spin_increment;
2590 break;
2591 case 0x41: // space bar
2592 pause = !pause;
2593 break;
2594 }
2595 break;
2596 case ConfigureNotify:
2597 if (((int32_t)width != event->xconfigure.width) || ((int32_t)height != event->xconfigure.height)) {
2598 width = event->xconfigure.width;
2599 height = event->xconfigure.height;
2600 resize();
2601 }
2602 break;
2603 default:
2604 break;
2605 }
2606}
2607
2608void Demo::run_xlib() {
2609 while (!quit) {
2610 XEvent event;
2611
2612 if (pause) {
2613 XNextEvent(display, &event);
2614 handle_xlib_event(&event);
2615 }
2616 while (XPending(display) > 0) {
2617 XNextEvent(display, &event);
2618 handle_xlib_event(&event);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002619 }
2620
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002621 draw();
2622 curFrame++;
2623
Dave Houlton5fa47912018-02-16 11:02:26 -07002624 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2625 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002626 }
2627 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002628}
Tony Barbour153cb062016-12-07 13:43:36 -07002629#elif defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002630
Dave Houlton5fa47912018-02-16 11:02:26 -07002631void Demo::handle_xcb_event(const xcb_generic_event_t *event) {
2632 uint8_t event_code = event->response_type & 0x7f;
2633 switch (event_code) {
2634 case XCB_EXPOSE:
2635 // TODO: Resize window
2636 break;
2637 case XCB_CLIENT_MESSAGE:
2638 if ((*(xcb_client_message_event_t *)event).data.data32[0] == (*atom_wm_delete_window).atom) {
2639 quit = true;
2640 }
2641 break;
2642 case XCB_KEY_RELEASE: {
2643 const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002644
Dave Houlton5fa47912018-02-16 11:02:26 -07002645 switch (key->detail) {
2646 case 0x9: // Escape
2647 quit = true;
2648 break;
2649 case 0x71: // left arrow key
2650 spin_angle -= spin_increment;
2651 break;
2652 case 0x72: // right arrow key
2653 spin_angle += spin_increment;
2654 break;
2655 case 0x41: // space bar
2656 pause = !pause;
2657 break;
2658 }
2659 } break;
2660 case XCB_CONFIGURE_NOTIFY: {
2661 const xcb_configure_notify_event_t *cfg = (const xcb_configure_notify_event_t *)event;
2662 if ((width != cfg->width) || (height != cfg->height)) {
2663 width = cfg->width;
2664 height = cfg->height;
2665 resize();
2666 }
2667 } break;
2668 default:
2669 break;
2670 }
2671}
2672
2673void Demo::run_xcb() {
2674 xcb_flush(connection);
2675
2676 while (!quit) {
2677 xcb_generic_event_t *event;
2678
2679 if (pause) {
2680 event = xcb_wait_for_event(connection);
2681 } else {
2682 event = xcb_poll_for_event(connection);
2683 }
2684 while (event) {
2685 handle_xcb_event(event);
2686 free(event);
2687 event = xcb_poll_for_event(connection);
2688 }
2689
2690 draw();
2691 curFrame++;
2692 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2693 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002694 }
2695 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002696}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002697
Dave Houlton5fa47912018-02-16 11:02:26 -07002698void Demo::create_xcb_window() {
2699 uint32_t value_mask, value_list[32];
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002700
Dave Houlton5fa47912018-02-16 11:02:26 -07002701 xcb_window = xcb_generate_id(connection);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002702
Dave Houlton5fa47912018-02-16 11:02:26 -07002703 value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
2704 value_list[0] = screen->black_pixel;
2705 value_list[1] = XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002706
Dave Houlton5fa47912018-02-16 11:02:26 -07002707 xcb_create_window(connection, XCB_COPY_FROM_PARENT, xcb_window, screen->root, 0, 0, width, height, 0,
2708 XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
2709
2710 /* Magic code that will send notification when window is destroyed */
2711 xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
2712 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
2713
2714 xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
2715 atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
2716
2717 xcb_change_property(connection, XCB_PROP_MODE_REPLACE, xcb_window, (*reply).atom, 4, 32, 1, &(*atom_wm_delete_window).atom);
2718
2719 free(reply);
2720
2721 xcb_map_window(connection, xcb_window);
2722
2723 // Force the x/y coordinates to 100,100 results are identical in
2724 // consecutive
2725 // runs
Charles Giessen87dd88d2022-02-03 13:46:29 -07002726 std::array<uint32_t, 2> const coords = {100, 100};
2727 xcb_configure_window(connection, xcb_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, coords.data());
Dave Houlton5fa47912018-02-16 11:02:26 -07002728}
2729#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2730
2731void Demo::run() {
2732 while (!quit) {
2733 if (pause) {
2734 wl_display_dispatch(display);
2735 } else {
2736 wl_display_dispatch_pending(display);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002737 draw();
2738 curFrame++;
Jeremy Hayes9d304782016-10-09 11:48:12 -06002739 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002740 quit = true;
2741 }
2742 }
2743 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002744}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002745
Manuel Stoecklac939332019-06-26 20:55:53 -04002746static void handle_surface_configure(void *data, xdg_surface *xdg_surface, uint32_t serial) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002747 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002748 xdg_surface_ack_configure(xdg_surface, serial);
Charles Giessen3bcefe52022-02-21 11:57:16 -07002749 if (demo.xdg_surface_has_been_configured) {
2750 demo.resize();
Manuel Stoecklac939332019-06-26 20:55:53 -04002751 }
Charles Giessen3bcefe52022-02-21 11:57:16 -07002752 demo.xdg_surface_has_been_configured = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002753}
2754
2755static const xdg_surface_listener surface_listener = {handle_surface_configure};
2756
2757static void handle_toplevel_configure(void *data, xdg_toplevel *xdg_toplevel, int32_t width, int32_t height,
2758 struct wl_array *states) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002759 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002760 /* zero values imply the program may choose its own size, so in that case
2761 * stay with the existing value (which on startup is the default) */
2762 if (width > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002763 demo.width = static_cast<uint32_t>(width);
Manuel Stoecklac939332019-06-26 20:55:53 -04002764 }
2765 if (height > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002766 demo.height = static_cast<uint32_t>(height);
Manuel Stoecklac939332019-06-26 20:55:53 -04002767 }
2768 // This will be followed by a surface configure
2769}
2770
2771static void handle_toplevel_close(void *data, xdg_toplevel *xdg_toplevel) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002772 Demo &demo = *static_cast<Demo *>(data);
2773 demo.quit = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002774}
2775
2776static const xdg_toplevel_listener toplevel_listener = {handle_toplevel_configure, handle_toplevel_close};
2777
Dave Houlton5fa47912018-02-16 11:02:26 -07002778void Demo::create_window() {
Manuel Stoecklac939332019-06-26 20:55:53 -04002779 if (!wm_base) {
2780 printf("Compositor did not provide the standard protocol xdg-wm-base\n");
2781 fflush(stdout);
2782 exit(1);
2783 }
2784
Dave Houlton5fa47912018-02-16 11:02:26 -07002785 window = wl_compositor_create_surface(compositor);
2786 if (!window) {
2787 printf("Can not create wayland_surface from compositor!\n");
2788 fflush(stdout);
2789 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002790 }
2791
Manuel Stoecklac939332019-06-26 20:55:53 -04002792 window_surface = xdg_wm_base_get_xdg_surface(wm_base, window);
2793 if (!window_surface) {
2794 printf("Can not get xdg_surface from wayland_surface!\n");
Dave Houlton5fa47912018-02-16 11:02:26 -07002795 fflush(stdout);
2796 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002797 }
Manuel Stoecklac939332019-06-26 20:55:53 -04002798 window_toplevel = xdg_surface_get_toplevel(window_surface);
2799 if (!window_toplevel) {
2800 printf("Can not allocate xdg_toplevel for xdg_surface!\n");
2801 fflush(stdout);
2802 exit(1);
2803 }
2804 xdg_surface_add_listener(window_surface, &surface_listener, this);
2805 xdg_toplevel_add_listener(window_toplevel, &toplevel_listener, this);
2806 xdg_toplevel_set_title(window_toplevel, APP_SHORT_NAME);
2807 if (xdg_decoration_mgr) {
2808 // if supported, let the compositor render titlebars for us
2809 toplevel_decoration = zxdg_decoration_manager_v1_get_toplevel_decoration(xdg_decoration_mgr, window_toplevel);
2810 zxdg_toplevel_decoration_v1_set_mode(toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
2811 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002812
Manuel Stoecklac939332019-06-26 20:55:53 -04002813 wl_surface_commit(window);
Dave Houlton5fa47912018-02-16 11:02:26 -07002814}
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002815#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
2816
2817void Demo::handle_directfb_event(const DFBInputEvent *event) {
2818 if (event->type != DIET_KEYPRESS) return;
2819 switch (event->key_symbol) {
2820 case DIKS_ESCAPE: // Escape
2821 quit = true;
2822 break;
2823 case DIKS_CURSOR_LEFT: // left arrow key
2824 spin_angle -= spin_increment;
2825 break;
2826 case DIKS_CURSOR_RIGHT: // right arrow key
2827 spin_angle += spin_increment;
2828 break;
2829 case DIKS_SPACE: // space bar
2830 pause = !pause;
2831 break;
2832 default:
2833 break;
2834 }
2835}
2836
2837void Demo::run_directfb() {
2838 while (!quit) {
2839 DFBInputEvent event;
2840
2841 if (pause) {
2842 event_buffer->WaitForEvent(event_buffer);
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002843 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002844 } else {
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002845 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002846
2847 draw();
2848 curFrame++;
2849 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2850 quit = true;
2851 }
2852 }
2853 }
2854}
2855
2856void Demo::create_directfb_window() {
2857 DFBResult ret;
2858
Charles Giessenc2f1a942022-02-06 23:38:39 -07002859 ret = DirectFBInit(nullptr, nullptr);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002860 if (ret) {
2861 printf("DirectFBInit failed to initialize DirectFB!\n");
2862 fflush(stdout);
2863 exit(1);
2864 }
2865
2866 ret = DirectFBCreate(&dfb);
2867 if (ret) {
2868 printf("DirectFBCreate failed to create main interface of DirectFB!\n");
2869 fflush(stdout);
2870 exit(1);
2871 }
2872
2873 DFBSurfaceDescription desc;
2874 desc.flags = (DFBSurfaceDescriptionFlags)(DSDESC_CAPS | DSDESC_WIDTH | DSDESC_HEIGHT);
2875 desc.caps = DSCAPS_PRIMARY;
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002876 desc.width = width;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002877 desc.height = height;
2878 ret = dfb->CreateSurface(dfb, &desc, &window);
2879 if (ret) {
2880 printf("CreateSurface failed to create DirectFB surface interface!\n");
2881 fflush(stdout);
2882 exit(1);
2883 }
2884
2885 ret = dfb->CreateInputEventBuffer(dfb, DICAPS_KEYS, DFB_FALSE, &event_buffer);
2886 if (ret) {
2887 printf("CreateInputEventBuffer failed to create DirectFB event buffer interface!\n");
2888 fflush(stdout);
2889 exit(1);
2890 }
2891}
Bill Hollings0a0625a2019-07-15 17:39:18 -04002892#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -06002893void Demo::run() {
2894 draw();
2895 curFrame++;
2896 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2897 quit = true;
2898 }
2899}
Damien Leone600c3052017-01-31 10:26:07 -07002900#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2901
Dave Houlton5fa47912018-02-16 11:02:26 -07002902vk::Result Demo::create_display_surface() {
Charles Giessenc2f1a942022-02-06 23:38:39 -07002903 auto display_properties_return = gpu.getDisplayPropertiesKHR();
2904 VERIFY((display_properties_return.result == vk::Result::eSuccess) ||
2905 (display_properties_return.result == vk::Result::eIncomplete));
Damien Leone600c3052017-01-31 10:26:07 -07002906
Charles Giessenc2f1a942022-02-06 23:38:39 -07002907 auto display = display_properties_return.value.at(0).display;
Dave Houlton5fa47912018-02-16 11:02:26 -07002908
Charles Giessenc2f1a942022-02-06 23:38:39 -07002909 auto display_mode_props_return = gpu.getDisplayModePropertiesKHR(display);
2910 VERIFY(display_mode_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002911
Charles Giessenc2f1a942022-02-06 23:38:39 -07002912 if (display_mode_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002913 printf("Cannot find any mode for the display!\n");
2914 fflush(stdout);
2915 exit(1);
2916 }
Charles Giessenc2f1a942022-02-06 23:38:39 -07002917 auto display_mode_prop = display_mode_props_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002918
2919 // Get the list of planes
Charles Giessenc2f1a942022-02-06 23:38:39 -07002920 auto display_plane_props_return = gpu.getDisplayPlanePropertiesKHR();
2921 VERIFY(display_plane_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002922
Charles Giessenc2f1a942022-02-06 23:38:39 -07002923 if (display_plane_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002924 printf("Cannot find any plane!\n");
2925 fflush(stdout);
2926 exit(1);
2927 }
Charles Giessen431f3b52022-03-30 16:17:29 -06002928 auto display_plane_props = display_plane_props_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002929
Charles Giessenc2f1a942022-02-06 23:38:39 -07002930 vk::Bool32 found_plane = VK_FALSE;
Charles Giessen431f3b52022-03-30 16:17:29 -06002931 uint32_t plane_found = 0;
Dave Houlton5fa47912018-02-16 11:02:26 -07002932 // Find a plane compatible with the display
Charles Giessen431f3b52022-03-30 16:17:29 -06002933 for (uint32_t plane_index = 0; plane_index < display_plane_props.size(); plane_index++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002934 // Disqualify planes that are bound to a different display
Charles Giessen431f3b52022-03-30 16:17:29 -06002935 if (display_plane_props[plane_index].currentDisplay && (display_plane_props[plane_index].currentDisplay != display)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002936 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002937 }
2938
Charles Giessenc2f1a942022-02-06 23:38:39 -07002939 auto display_plane_supported_displays_return = gpu.getDisplayPlaneSupportedDisplaysKHR(plane_index);
2940 VERIFY(display_plane_supported_displays_return.result == vk::Result::eSuccess);
Damien Leone600c3052017-01-31 10:26:07 -07002941
Charles Giessenc2f1a942022-02-06 23:38:39 -07002942 if (display_plane_supported_displays_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002943 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002944 }
2945
Charles Giessenc2f1a942022-02-06 23:38:39 -07002946 for (const auto &supported_display : display_plane_supported_displays_return.value) {
2947 if (supported_display == display) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002948 found_plane = VK_TRUE;
Charles Giessen431f3b52022-03-30 16:17:29 -06002949 plane_found = plane_index;
Damien Leone600c3052017-01-31 10:26:07 -07002950 break;
2951 }
2952 }
2953
Dave Houlton5fa47912018-02-16 11:02:26 -07002954 if (found_plane) {
2955 break;
Damien Leone600c3052017-01-31 10:26:07 -07002956 }
2957 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002958
2959 if (!found_plane) {
2960 printf("Cannot find a plane compatible with the display!\n");
2961 fflush(stdout);
2962 exit(1);
2963 }
2964
Mike Schuchardtfbb14742022-05-11 15:43:28 -07002965 vk::DisplayPlaneCapabilitiesKHR planeCaps = gpu.getDisplayPlaneCapabilitiesKHR(display_mode_prop.displayMode, plane_found).value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002966 // Find a supported alpha mode
2967 vk::DisplayPlaneAlphaFlagBitsKHR alphaMode = vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002968 std::array<vk::DisplayPlaneAlphaFlagBitsKHR, 4> alphaModes = {
Dave Houlton5fa47912018-02-16 11:02:26 -07002969 vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque,
2970 vk::DisplayPlaneAlphaFlagBitsKHR::eGlobal,
2971 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixel,
2972 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixelPremultiplied,
2973 };
Charles Giessen87dd88d2022-02-03 13:46:29 -07002974 for (const auto &alpha_mode : alphaModes) {
2975 if (planeCaps.supportedAlpha & alpha_mode) {
2976 alphaMode = alpha_mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07002977 break;
2978 }
2979 }
2980
Charles Giessenc2f1a942022-02-06 23:38:39 -07002981 vk::Extent2D image_extent{};
Charles Giessen431f3b52022-03-30 16:17:29 -06002982 image_extent.setWidth(display_mode_prop.parameters.visibleRegion.width)
2983 .setHeight(display_mode_prop.parameters.visibleRegion.height);
Dave Houlton5fa47912018-02-16 11:02:26 -07002984
2985 auto const createInfo = vk::DisplaySurfaceCreateInfoKHR()
Charles Giessen431f3b52022-03-30 16:17:29 -06002986 .setDisplayMode(display_mode_prop.displayMode)
2987 .setPlaneIndex(plane_found)
2988 .setPlaneStackIndex(display_plane_props[plane_found].currentStackIndex)
Dave Houlton5fa47912018-02-16 11:02:26 -07002989 .setGlobalAlpha(1.0f)
2990 .setAlphaMode(alphaMode)
2991 .setImageExtent(image_extent);
2992
2993 return inst.createDisplayPlaneSurfaceKHR(&createInfo, nullptr, &surface);
2994}
2995
2996void Demo::run_display() {
2997 while (!quit) {
2998 draw();
2999 curFrame++;
3000
Petr Krausd88e4e52019-01-23 18:45:04 +01003001 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07003002 quit = true;
3003 }
3004 }
3005}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003006#endif
3007
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003008#if _WIN32
3009// Include header required for parsing the command line options.
3010#include <shellapi.h>
3011
3012Demo demo;
3013
3014// MS-Windows event handling function:
Jeremy Hayes9d304782016-10-09 11:48:12 -06003015LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
3016 switch (uMsg) {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003017 case WM_CLOSE:
3018 PostQuitMessage(validation_error);
3019 break;
3020 case WM_PAINT:
Charles Giessen74f007d2022-02-08 14:04:45 -07003021 if (!demo.in_callback) {
3022 demo.run();
3023 }
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003024 break;
3025 case WM_GETMINMAXINFO: // set window's minimum size
3026 ((MINMAXINFO *)lParam)->ptMinTrackSize = demo.minsize;
3027 return 0;
Aaron Hagan500b9c32018-10-03 21:56:29 -04003028 case WM_ERASEBKGND:
3029 return 1;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003030 case WM_SIZE:
3031 // Resize the application to the new window size, except when
3032 // it was minimized. Vulkan doesn't support images or swapchains
3033 // with width=0 and height=0.
3034 if (wParam != SIZE_MINIMIZED) {
3035 demo.width = lParam & 0xffff;
3036 demo.height = (lParam & 0xffff0000) >> 16;
3037 demo.resize();
3038 }
3039 break;
Petr Krausd88e4e52019-01-23 18:45:04 +01003040 case WM_KEYDOWN:
3041 switch (wParam) {
3042 case VK_ESCAPE:
3043 PostQuitMessage(validation_error);
3044 break;
3045 case VK_LEFT:
3046 demo.spin_angle -= demo.spin_increment;
3047 break;
3048 case VK_RIGHT:
3049 demo.spin_angle += demo.spin_increment;
3050 break;
3051 case VK_SPACE:
3052 demo.pause = !demo.pause;
3053 break;
3054 }
3055 return 0;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003056 default:
3057 break;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003058 }
3059
3060 return (DefWindowProc(hWnd, uMsg, wParam, lParam));
3061}
3062
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003063int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR pCmdLine, int nCmdShow) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003064 // TODO: Gah.. refactor. This isn't 1989.
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003065 MSG msg; // message
3066 bool done; // flag saying when app is complete
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003067 int argc;
3068 char **argv;
3069
Jamie Madillb2ff6502017-03-15 16:17:46 -04003070 // Ensure wParam is initialized.
3071 msg.wParam = 0;
3072
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003073 // Use the CommandLine functions to get the command line arguments.
3074 // Unfortunately, Microsoft outputs
3075 // this information as wide characters for Unicode, and we simply want the
3076 // Ascii version to be compatible
3077 // with the non-Windows side. So, we have to convert the information to
3078 // Ascii character strings.
3079 LPWSTR *commandLineArgs = CommandLineToArgvW(GetCommandLineW(), &argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003080 if (nullptr == commandLineArgs) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003081 argc = 0;
3082 }
3083
Jeremy Hayes9d304782016-10-09 11:48:12 -06003084 if (argc > 0) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003085 argv = (char **)malloc(sizeof(char *) * argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003086 if (argv == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003087 argc = 0;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003088 } else {
3089 for (int iii = 0; iii < argc; iii++) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003090 size_t wideCharLen = wcslen(commandLineArgs[iii]);
3091 size_t numConverted = 0;
3092
3093 argv[iii] = (char *)malloc(sizeof(char) * (wideCharLen + 1));
Jeremy Hayes9d304782016-10-09 11:48:12 -06003094 if (argv[iii] != nullptr) {
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003095 wcstombs_s(&numConverted, argv[iii], wideCharLen + 1, commandLineArgs[iii], wideCharLen + 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003096 }
3097 }
3098 }
Jeremy Hayes9d304782016-10-09 11:48:12 -06003099 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003100 argv = nullptr;
3101 }
3102
3103 demo.init(argc, argv);
3104
3105 // Free up the items we had to allocate for the command line arguments.
Jeremy Hayes9d304782016-10-09 11:48:12 -06003106 if (argc > 0 && argv != nullptr) {
3107 for (int iii = 0; iii < argc; iii++) {
3108 if (argv[iii] != nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003109 free(argv[iii]);
3110 }
3111 }
3112 free(argv);
3113 }
3114
3115 demo.connection = hInstance;
Charles Giessen87dd88d2022-02-03 13:46:29 -07003116 demo.name = "Vulkan Cube";
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003117 demo.create_window();
3118 demo.init_vk_swapchain();
3119
3120 demo.prepare();
3121
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003122 done = false; // initialize loop condition variable
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003123
3124 // main message loop
Jeremy Hayes9d304782016-10-09 11:48:12 -06003125 while (!done) {
Petr Krausd88e4e52019-01-23 18:45:04 +01003126 if (demo.pause) {
3127 const BOOL succ = WaitMessage();
3128
3129 if (!succ) {
3130 const auto &suppress_popups = demo.suppress_popups;
3131 ERR_EXIT("WaitMessage() failed on paused demo", "event loop error");
3132 }
3133 }
3134
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003135 PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE);
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003136 if (msg.message == WM_QUIT) // check for a quit message
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003137 {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003138 done = true; // if found, quit app
Jeremy Hayes9d304782016-10-09 11:48:12 -06003139 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003140 /* Translate and dispatch to event queue*/
3141 TranslateMessage(&msg);
3142 DispatchMessage(&msg);
3143 }
3144 RedrawWindow(demo.window, nullptr, nullptr, RDW_INTERNALPAINT);
3145 }
3146
3147 demo.cleanup();
3148
Charles Giessen87dd88d2022-02-03 13:46:29 -07003149 return static_cast<int>(msg.wParam);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003150}
3151
Eleni Maria Stea8b86fba2021-07-03 17:12:30 +03003152#elif defined(__linux__) || defined(__FreeBSD__)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003153
Jeremy Hayes9d304782016-10-09 11:48:12 -06003154int main(int argc, char **argv) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003155 Demo demo;
3156
3157 demo.init(argc, argv);
3158
Tony Barbour153cb062016-12-07 13:43:36 -07003159#if defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003160 demo.create_xcb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003161#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Tony Barbour78d6b572016-11-14 14:46:33 -07003162 demo.use_xlib = true;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003163 demo.create_xlib_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003164#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003165 demo.create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003166#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3167 demo.create_directfb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003168#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003169
3170 demo.init_vk_swapchain();
3171
3172 demo.prepare();
3173
Tony Barbour153cb062016-12-07 13:43:36 -07003174#if defined(VK_USE_PLATFORM_XCB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003175 demo.run_xcb();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003176#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003177 demo.run_xlib();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003178#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003179 demo.run();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003180#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3181 demo.run_directfb();
Damien Leone600c3052017-01-31 10:26:07 -07003182#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3183 demo.run_display();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003184#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003185
3186 demo.cleanup();
3187
3188 return validation_error;
3189}
3190
Bill Hollings0a0625a2019-07-15 17:39:18 -04003191#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05003192
3193// Global function invoked from NS or UI views and controllers to create demo
Charles Giessen87dd88d2022-02-03 13:46:29 -07003194static void demo_main(Demo &demo, void *caMetalLayer, int argc, const char *argv[]) {
Karl Schultz9ceac062017-12-12 10:33:01 -05003195 demo.init(argc, (char **)argv);
Bill Hollings0a0625a2019-07-15 17:39:18 -04003196 demo.caMetalLayer = caMetalLayer;
Karl Schultz9ceac062017-12-12 10:33:01 -05003197 demo.init_vk_swapchain();
3198 demo.prepare();
3199 demo.spin_angle = 0.4f;
3200}
3201
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003202#else
3203#error "Platform not supported"
3204#endif