blob: e7826d8e94e524bfdcd838c78d1cf2dc2fe4f84d [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>
19 */
Richard S. Wright Jra7825742021-01-06 16:02:12 -050020
Jeremy Hayesf56427a2016-09-07 15:55:11 -060021#if defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XCB_KHR)
22#include <X11/Xutil.h>
Joey Bzdek15eb0702017-06-07 09:40:36 -060023#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
24#include <linux/input.h>
Manuel Stoecklac939332019-06-26 20:55:53 -040025#include "xdg-shell-client-header.h"
26#include "xdg-decoration-client-header.h"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060027#endif
28
29#include <cassert>
Petr Krausbc0ab752017-12-09 00:22:39 +010030#include <cinttypes>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060031#include <cstdio>
32#include <cstdlib>
33#include <cstring>
34#include <csignal>
Tony-LunarGd74734f2019-06-04 14:11:43 -060035#include <iostream>
36#include <sstream>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060037#include <memory>
38
39#define VULKAN_HPP_NO_EXCEPTIONS
Shannon McPherson2abb6992019-04-05 10:46:16 -060040#define VULKAN_HPP_TYPESAFE_CONVERSION
Jeremy Hayesf56427a2016-09-07 15:55:11 -060041#include <vulkan/vulkan.hpp>
42#include <vulkan/vk_sdk_platform.h>
43
44#include "linmath.h"
45
46#ifndef NDEBUG
47#define VERIFY(x) assert(x)
48#else
49#define VERIFY(x) ((void)(x))
50#endif
51
Lenny Komowffe446c2018-11-19 17:08:04 -070052#define APP_SHORT_NAME "vkcube"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060053#ifdef _WIN32
54#define APP_NAME_STR_LEN 80
55#endif
56
57// Allow a maximum of two outstanding presentation operations.
58#define FRAME_LAG 2
59
60#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
61
62#ifdef _WIN32
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070063#define ERR_EXIT(err_msg, err_class) \
64 do { \
65 if (!suppress_popups) MessageBox(nullptr, err_msg, err_class, MB_OK); \
66 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060067 } while (0)
68#else
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070069#define ERR_EXIT(err_msg, err_class) \
70 do { \
Robert Morell4ccc6522017-02-01 14:51:00 -080071 printf("%s\n", err_msg); \
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070072 fflush(stdout); \
73 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060074 } while (0)
75#endif
76
Jeremy Hayes9d304782016-10-09 11:48:12 -060077struct texture_object {
Jeremy Hayesf56427a2016-09-07 15:55:11 -060078 vk::Sampler sampler;
79
80 vk::Image image;
Tony-LunarGbc9fc052018-09-21 13:47:06 -060081 vk::Buffer buffer;
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -070082 vk::ImageLayout imageLayout{vk::ImageLayout::eUndefined};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060083
84 vk::MemoryAllocateInfo mem_alloc;
85 vk::DeviceMemory mem;
86 vk::ImageView view;
87
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -070088 int32_t tex_width{0};
89 int32_t tex_height{0};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060090};
91
Jeremy Hayes9d304782016-10-09 11:48:12 -060092static char const *const tex_files[] = {"lunarg.ppm"};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060093
94static int validation_error = 0;
95
Jeremy Hayesf56427a2016-09-07 15:55:11 -060096struct vktexcube_vs_uniform {
97 // Must start with MVP
98 float mvp[4][4];
99 float position[12 * 3][4];
100 float attr[12 * 3][4];
101};
102
103//--------------------------------------------------------------------------------------
104// Mesh and VertexFormat Data
105//--------------------------------------------------------------------------------------
106// clang-format off
107static const float g_vertex_buffer_data[] = {
108 -1.0f,-1.0f,-1.0f, // -X side
109 -1.0f,-1.0f, 1.0f,
110 -1.0f, 1.0f, 1.0f,
111 -1.0f, 1.0f, 1.0f,
112 -1.0f, 1.0f,-1.0f,
113 -1.0f,-1.0f,-1.0f,
114
115 -1.0f,-1.0f,-1.0f, // -Z side
116 1.0f, 1.0f,-1.0f,
117 1.0f,-1.0f,-1.0f,
118 -1.0f,-1.0f,-1.0f,
119 -1.0f, 1.0f,-1.0f,
120 1.0f, 1.0f,-1.0f,
121
122 -1.0f,-1.0f,-1.0f, // -Y side
123 1.0f,-1.0f,-1.0f,
124 1.0f,-1.0f, 1.0f,
125 -1.0f,-1.0f,-1.0f,
126 1.0f,-1.0f, 1.0f,
127 -1.0f,-1.0f, 1.0f,
128
129 -1.0f, 1.0f,-1.0f, // +Y side
130 -1.0f, 1.0f, 1.0f,
131 1.0f, 1.0f, 1.0f,
132 -1.0f, 1.0f,-1.0f,
133 1.0f, 1.0f, 1.0f,
134 1.0f, 1.0f,-1.0f,
135
136 1.0f, 1.0f,-1.0f, // +X side
137 1.0f, 1.0f, 1.0f,
138 1.0f,-1.0f, 1.0f,
139 1.0f,-1.0f, 1.0f,
140 1.0f,-1.0f,-1.0f,
141 1.0f, 1.0f,-1.0f,
142
143 -1.0f, 1.0f, 1.0f, // +Z side
144 -1.0f,-1.0f, 1.0f,
145 1.0f, 1.0f, 1.0f,
146 -1.0f,-1.0f, 1.0f,
147 1.0f,-1.0f, 1.0f,
148 1.0f, 1.0f, 1.0f,
149};
150
151static const float g_uv_buffer_data[] = {
152 0.0f, 1.0f, // -X side
153 1.0f, 1.0f,
154 1.0f, 0.0f,
155 1.0f, 0.0f,
156 0.0f, 0.0f,
157 0.0f, 1.0f,
158
159 1.0f, 1.0f, // -Z side
160 0.0f, 0.0f,
161 0.0f, 1.0f,
162 1.0f, 1.0f,
163 1.0f, 0.0f,
164 0.0f, 0.0f,
165
166 1.0f, 0.0f, // -Y side
167 1.0f, 1.0f,
168 0.0f, 1.0f,
169 1.0f, 0.0f,
170 0.0f, 1.0f,
171 0.0f, 0.0f,
172
173 1.0f, 0.0f, // +Y side
174 0.0f, 0.0f,
175 0.0f, 1.0f,
176 1.0f, 0.0f,
177 0.0f, 1.0f,
178 1.0f, 1.0f,
179
180 1.0f, 0.0f, // +X side
181 0.0f, 0.0f,
182 0.0f, 1.0f,
183 0.0f, 1.0f,
184 1.0f, 1.0f,
185 1.0f, 0.0f,
186
187 0.0f, 0.0f, // +Z side
188 0.0f, 1.0f,
189 1.0f, 0.0f,
190 0.0f, 1.0f,
191 1.0f, 1.0f,
192 1.0f, 0.0f,
193};
Jeremy Hayes9d304782016-10-09 11:48:12 -0600194// clang-format on
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600195
Jeremy Hayes9d304782016-10-09 11:48:12 -0600196typedef struct {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600197 vk::Image image;
198 vk::CommandBuffer cmd;
199 vk::CommandBuffer graphics_to_present_cmd;
200 vk::ImageView view;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600201 vk::Buffer uniform_buffer;
202 vk::DeviceMemory uniform_memory;
Tony-LunarG37af49f2019-12-19 12:04:19 -0700203 void *uniform_memory_ptr;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600204 vk::Framebuffer framebuffer;
205 vk::DescriptorSet descriptor_set;
206} SwapchainImageResources;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600207
Joey Bzdekbaf66472017-06-07 09:37:37 -0600208struct Demo {
209 Demo();
210 void build_image_ownership_cmd(uint32_t const &);
211 vk::Bool32 check_layers(uint32_t, const char *const *, uint32_t, vk::LayerProperties *);
212 void cleanup();
213 void create_device();
Tony-LunarGbc9fc052018-09-21 13:47:06 -0600214 void destroy_texture(texture_object *);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600215 void draw();
216 void draw_build_cmd(vk::CommandBuffer);
217 void flush_init_cmd();
218 void init(int, char **);
219 void init_connection();
220 void init_vk();
221 void init_vk_swapchain();
222 void prepare();
223 void prepare_buffers();
224 void prepare_cube_data_buffers();
225 void prepare_depth();
226 void prepare_descriptor_layout();
227 void prepare_descriptor_pool();
228 void prepare_descriptor_set();
229 void prepare_framebuffers();
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100230 vk::ShaderModule prepare_shader_module(const uint32_t *, size_t);
231 vk::ShaderModule prepare_vs();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600232 vk::ShaderModule prepare_fs();
233 void prepare_pipeline();
234 void prepare_render_pass();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600235 void prepare_texture_image(const char *, texture_object *, vk::ImageTiling, vk::ImageUsageFlags, vk::MemoryPropertyFlags);
Tony-LunarGbc9fc052018-09-21 13:47:06 -0600236 void prepare_texture_buffer(const char *, texture_object *);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600237 void prepare_textures();
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100238
Joey Bzdekbaf66472017-06-07 09:37:37 -0600239 void resize();
Tony-LunarG6cebf142019-09-11 14:32:23 -0600240 void create_surface();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600241 void set_image_layout(vk::Image, vk::ImageAspectFlags, vk::ImageLayout, vk::ImageLayout, vk::AccessFlags,
242 vk::PipelineStageFlags, vk::PipelineStageFlags);
243 void update_data_buffer();
244 bool loadTexture(const char *, uint8_t *, vk::SubresourceLayout *, int32_t *, int32_t *);
245 bool memory_type_from_properties(uint32_t, vk::MemoryPropertyFlags, uint32_t *);
246
247#if defined(VK_USE_PLATFORM_WIN32_KHR)
248 void run();
249 void create_window();
250#elif defined(VK_USE_PLATFORM_XLIB_KHR)
251 void create_xlib_window();
252 void handle_xlib_event(const XEvent *);
253 void run_xlib();
254#elif defined(VK_USE_PLATFORM_XCB_KHR)
255 void handle_xcb_event(const xcb_generic_event_t *);
256 void run_xcb();
257 void create_xcb_window();
258#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
259 void run();
260 void create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200261#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
262 void handle_directfb_event(const DFBInputEvent *);
263 void run_directfb();
264 void create_directfb_window();
Bill Hollings0a0625a2019-07-15 17:39:18 -0400265#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -0600266 void run();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600267#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
268 vk::Result create_display_surface();
269 void run_display();
270#endif
271
272#if defined(VK_USE_PLATFORM_WIN32_KHR)
273 HINSTANCE connection; // hInstance - Windows Instance
274 HWND window; // hWnd - window handle
275 POINT minsize; // minimum window size
276 char name[APP_NAME_STR_LEN]; // Name to put on the window/icon
277#elif defined(VK_USE_PLATFORM_XLIB_KHR)
278 Window xlib_window;
279 Atom xlib_wm_delete_window;
280 Display *display;
281#elif defined(VK_USE_PLATFORM_XCB_KHR)
282 xcb_window_t xcb_window;
283 xcb_screen_t *screen;
284 xcb_connection_t *connection;
285 xcb_intern_atom_reply_t *atom_wm_delete_window;
286#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
287 wl_display *display;
288 wl_registry *registry;
289 wl_compositor *compositor;
290 wl_surface *window;
Manuel Stoecklac939332019-06-26 20:55:53 -0400291 xdg_wm_base *wm_base;
292 zxdg_decoration_manager_v1 *xdg_decoration_mgr;
293 zxdg_toplevel_decoration_v1 *toplevel_decoration;
294 xdg_surface *window_surface;
295 bool xdg_surface_has_been_configured;
296 xdg_toplevel *window_toplevel;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600297 wl_seat *seat;
298 wl_pointer *pointer;
299 wl_keyboard *keyboard;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200300#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
301 IDirectFB *dfb;
302 IDirectFBSurface *window;
303 IDirectFBEventBuffer *event_buffer;
Bill Hollings0a0625a2019-07-15 17:39:18 -0400304#elif defined(VK_USE_PLATFORM_METAL_EXT)
305 void *caMetalLayer;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600306#endif
307
308 vk::SurfaceKHR surface;
309 bool prepared;
310 bool use_staging_buffer;
311 bool use_xlib;
312 bool separate_present_queue;
Witold Baryluka3b988f2021-01-07 19:03:02 +0000313 int32_t gpu_number;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600314
315 vk::Instance inst;
316 vk::PhysicalDevice gpu;
317 vk::Device device;
318 vk::Queue graphics_queue;
319 vk::Queue present_queue;
320 uint32_t graphics_queue_family_index;
321 uint32_t present_queue_family_index;
322 vk::Semaphore image_acquired_semaphores[FRAME_LAG];
323 vk::Semaphore draw_complete_semaphores[FRAME_LAG];
324 vk::Semaphore image_ownership_semaphores[FRAME_LAG];
325 vk::PhysicalDeviceProperties gpu_props;
326 std::unique_ptr<vk::QueueFamilyProperties[]> queue_props;
327 vk::PhysicalDeviceMemoryProperties memory_properties;
328
329 uint32_t enabled_extension_count;
330 uint32_t enabled_layer_count;
331 char const *extension_names[64];
332 char const *enabled_layers[64];
333
334 uint32_t width;
335 uint32_t height;
336 vk::Format format;
337 vk::ColorSpaceKHR color_space;
338
339 uint32_t swapchainImageCount;
340 vk::SwapchainKHR swapchain;
Joey Bzdek33bc5c82017-06-14 10:33:36 -0600341 std::unique_ptr<SwapchainImageResources[]> swapchain_image_resources;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600342 vk::PresentModeKHR presentMode;
343 vk::Fence fences[FRAME_LAG];
344 uint32_t frame_index;
345
346 vk::CommandPool cmd_pool;
347 vk::CommandPool present_cmd_pool;
348
349 struct {
350 vk::Format format;
351 vk::Image image;
352 vk::MemoryAllocateInfo mem_alloc;
353 vk::DeviceMemory mem;
354 vk::ImageView view;
355 } depth;
356
357 static int32_t const texture_count = 1;
358 texture_object textures[texture_count];
359 texture_object staging_texture;
360
361 struct {
362 vk::Buffer buf;
363 vk::MemoryAllocateInfo mem_alloc;
364 vk::DeviceMemory mem;
365 vk::DescriptorBufferInfo buffer_info;
366 } uniform_data;
367
368 vk::CommandBuffer cmd; // Buffer for initialization commands
369 vk::PipelineLayout pipeline_layout;
370 vk::DescriptorSetLayout desc_layout;
371 vk::PipelineCache pipelineCache;
372 vk::RenderPass render_pass;
373 vk::Pipeline pipeline;
374
375 mat4x4 projection_matrix;
376 mat4x4 view_matrix;
377 mat4x4 model_matrix;
378
379 float spin_angle;
380 float spin_increment;
381 bool pause;
382
383 vk::ShaderModule vert_shader_module;
384 vk::ShaderModule frag_shader_module;
385
386 vk::DescriptorPool desc_pool;
387 vk::DescriptorSet desc_set;
388
389 std::unique_ptr<vk::Framebuffer[]> framebuffers;
390
391 bool quit;
392 uint32_t curFrame;
393 uint32_t frameCount;
394 bool validate;
395 bool use_break;
396 bool suppress_popups;
397
398 uint32_t current_buffer;
399 uint32_t queue_family_count;
400};
401
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600402#ifdef _WIN32
403// MS-Windows event handling function:
404LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
405#endif
406
Karl Schultz23cc2182016-11-23 17:15:17 -0700407#if defined(VK_USE_PLATFORM_WAYLAND_KHR)
Joey Bzdek15eb0702017-06-07 09:40:36 -0600408static void pointer_handle_enter(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t sx,
409 wl_fixed_t sy) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700410
Joey Bzdek15eb0702017-06-07 09:40:36 -0600411static void pointer_handle_leave(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700412
Joey Bzdek15eb0702017-06-07 09:40:36 -0600413static void pointer_handle_motion(void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) {}
414
415static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button,
416 uint32_t state) {
Joey Bzdek33bc5c82017-06-14 10:33:36 -0600417 Demo *demo = (Demo *)data;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600418 if (button == BTN_LEFT && state == WL_POINTER_BUTTON_STATE_PRESSED) {
Manuel Stoecklac939332019-06-26 20:55:53 -0400419 xdg_toplevel_move(demo->window_toplevel, demo->seat, serial);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600420 }
421}
422
423static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {}
424
425static const struct wl_pointer_listener pointer_listener = {
426 pointer_handle_enter, pointer_handle_leave, pointer_handle_motion, pointer_handle_button, pointer_handle_axis,
427};
428
429static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) {}
430
431static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface,
432 struct wl_array *keys) {}
433
434static void keyboard_handle_leave(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) {}
435
436static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key,
437 uint32_t state) {
438 if (state != WL_KEYBOARD_KEY_STATE_RELEASED) return;
439 Demo *demo = (Demo *)data;
440 switch (key) {
441 case KEY_ESC: // Escape
442 demo->quit = true;
443 break;
444 case KEY_LEFT: // left arrow key
445 demo->spin_angle -= demo->spin_increment;
446 break;
447 case KEY_RIGHT: // right arrow key
448 demo->spin_angle += demo->spin_increment;
449 break;
450 case KEY_SPACE: // space bar
451 demo->pause = !demo->pause;
452 break;
453 }
454}
455
456static void keyboard_handle_modifiers(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed,
457 uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {}
458
459static const struct wl_keyboard_listener keyboard_listener = {
460 keyboard_handle_keymap, keyboard_handle_enter, keyboard_handle_leave, keyboard_handle_key, keyboard_handle_modifiers,
461};
462
463static void seat_handle_capabilities(void *data, wl_seat *seat, uint32_t caps) {
464 // Subscribe to pointer events
465 Demo *demo = (Demo *)data;
466 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !demo->pointer) {
467 demo->pointer = wl_seat_get_pointer(seat);
468 wl_pointer_add_listener(demo->pointer, &pointer_listener, demo);
469 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && demo->pointer) {
470 wl_pointer_destroy(demo->pointer);
471 demo->pointer = NULL;
472 }
473 // Subscribe to keyboard events
474 if (caps & WL_SEAT_CAPABILITY_KEYBOARD) {
475 demo->keyboard = wl_seat_get_keyboard(seat);
476 wl_keyboard_add_listener(demo->keyboard, &keyboard_listener, demo);
477 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD)) {
478 wl_keyboard_destroy(demo->keyboard);
479 demo->keyboard = NULL;
480 }
481}
482
483static const wl_seat_listener seat_listener = {
484 seat_handle_capabilities,
485};
486
Manuel Stoecklac939332019-06-26 20:55:53 -0400487static void wm_base_ping(void *data, xdg_wm_base *xdg_wm_base, uint32_t serial) { xdg_wm_base_pong(xdg_wm_base, serial); }
488
489static const struct xdg_wm_base_listener wm_base_listener = {wm_base_ping};
490
Joey Bzdek15eb0702017-06-07 09:40:36 -0600491static void registry_handle_global(void *data, wl_registry *registry, uint32_t id, const char *interface, uint32_t version) {
492 Demo *demo = (Demo *)data;
493 // pickup wayland objects when they appear
Manuel Stoecklac939332019-06-26 20:55:53 -0400494 if (strcmp(interface, wl_compositor_interface.name) == 0) {
Joey Bzdek15eb0702017-06-07 09:40:36 -0600495 demo->compositor = (wl_compositor *)wl_registry_bind(registry, id, &wl_compositor_interface, 1);
Manuel Stoecklac939332019-06-26 20:55:53 -0400496 } else if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
497 demo->wm_base = (xdg_wm_base *)wl_registry_bind(registry, id, &xdg_wm_base_interface, 1);
498 xdg_wm_base_add_listener(demo->wm_base, &wm_base_listener, nullptr);
499 } else if (strcmp(interface, wl_seat_interface.name) == 0) {
Joey Bzdek15eb0702017-06-07 09:40:36 -0600500 demo->seat = (wl_seat *)wl_registry_bind(registry, id, &wl_seat_interface, 1);
501 wl_seat_add_listener(demo->seat, &seat_listener, demo);
Manuel Stoecklac939332019-06-26 20:55:53 -0400502 } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
503 demo->xdg_decoration_mgr =
504 (zxdg_decoration_manager_v1 *)wl_registry_bind(registry, id, &zxdg_decoration_manager_v1_interface, 1);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600505 }
506}
507
508static void registry_handle_global_remove(void *data, wl_registry *registry, uint32_t name) {}
509
510static const wl_registry_listener registry_listener = {registry_handle_global, registry_handle_global_remove};
Karl Schultz23cc2182016-11-23 17:15:17 -0700511#endif
512
Joey Bzdekbaf66472017-06-07 09:37:37 -0600513Demo::Demo()
514 :
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600515#if defined(VK_USE_PLATFORM_WIN32_KHR)
Joey Bzdekbaf66472017-06-07 09:37:37 -0600516 connection{nullptr},
517 window{nullptr},
518 minsize(POINT{0, 0}), // Use explicit construction to avoid MSVC error C2797.
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600519#endif
Tony Barbour153cb062016-12-07 13:43:36 -0700520
Tony Barbour78d6b572016-11-14 14:46:33 -0700521#if defined(VK_USE_PLATFORM_XLIB_KHR)
Joey Bzdekbaf66472017-06-07 09:37:37 -0600522 xlib_window{0},
523 xlib_wm_delete_window{0},
524 display{nullptr},
Tony Barbour153cb062016-12-07 13:43:36 -0700525#elif defined(VK_USE_PLATFORM_XCB_KHR)
Joey Bzdekbaf66472017-06-07 09:37:37 -0600526 xcb_window{0},
527 screen{nullptr},
528 connection{nullptr},
Karl Schultz23cc2182016-11-23 17:15:17 -0700529#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Joey Bzdekbaf66472017-06-07 09:37:37 -0600530 display{nullptr},
531 registry{nullptr},
532 compositor{nullptr},
533 window{nullptr},
Manuel Stoecklac939332019-06-26 20:55:53 -0400534 wm_base{nullptr},
535 xdg_decoration_mgr{nullptr},
536 toplevel_decoration{nullptr},
537 window_surface{nullptr},
538 xdg_surface_has_been_configured{false},
539 window_toplevel{nullptr},
Joey Bzdekbaf66472017-06-07 09:37:37 -0600540 seat{nullptr},
541 pointer{nullptr},
542 keyboard{nullptr},
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200543#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
544 dfb{nullptr},
545 window{nullptr},
546 event_buffer{nullptr},
Tony Barbour78d6b572016-11-14 14:46:33 -0700547#endif
Joey Bzdekbaf66472017-06-07 09:37:37 -0600548 prepared{false},
549 use_staging_buffer{false},
550 use_xlib{false},
551 graphics_queue_family_index{0},
552 present_queue_family_index{0},
553 enabled_extension_count{0},
554 enabled_layer_count{0},
555 width{0},
556 height{0},
557 swapchainImageCount{0},
Dave Airliea4417182019-04-12 16:47:29 +1000558 presentMode{vk::PresentModeKHR::eFifo},
Joey Bzdekbaf66472017-06-07 09:37:37 -0600559 frame_index{0},
560 spin_angle{0.0f},
561 spin_increment{0.0f},
562 pause{false},
563 quit{false},
564 curFrame{0},
565 frameCount{0},
566 validate{false},
567 use_break{false},
568 suppress_popups{false},
569 current_buffer{0},
570 queue_family_count{0} {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600571#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -0700572 memset(name, '\0', APP_NAME_STR_LEN);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600573#endif
Dave Houlton5fa47912018-02-16 11:02:26 -0700574 memset(projection_matrix, 0, sizeof(projection_matrix));
575 memset(view_matrix, 0, sizeof(view_matrix));
576 memset(model_matrix, 0, sizeof(model_matrix));
577}
578
579void Demo::build_image_ownership_cmd(uint32_t const &i) {
580 auto const cmd_buf_info = vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse);
581 auto result = swapchain_image_resources[i].graphics_to_present_cmd.begin(&cmd_buf_info);
582 VERIFY(result == vk::Result::eSuccess);
583
584 auto const image_ownership_barrier =
585 vk::ImageMemoryBarrier()
586 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600587 .setDstAccessMask(vk::AccessFlags())
Dave Houlton5fa47912018-02-16 11:02:26 -0700588 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
589 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
590 .setSrcQueueFamilyIndex(graphics_queue_family_index)
591 .setDstQueueFamilyIndex(present_queue_family_index)
592 .setImage(swapchain_image_resources[i].image)
593 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
594
595 swapchain_image_resources[i].graphics_to_present_cmd.pipelineBarrier(
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600596 vk::PipelineStageFlagBits::eBottomOfPipe, vk::PipelineStageFlagBits::eBottomOfPipe, vk::DependencyFlagBits(), 0, nullptr, 0,
597 nullptr, 1, &image_ownership_barrier);
Dave Houlton5fa47912018-02-16 11:02:26 -0700598
599 result = swapchain_image_resources[i].graphics_to_present_cmd.end();
600 VERIFY(result == vk::Result::eSuccess);
601}
602
603vk::Bool32 Demo::check_layers(uint32_t check_count, char const *const *const check_names, uint32_t layer_count,
604 vk::LayerProperties *layers) {
605 for (uint32_t i = 0; i < check_count; i++) {
606 vk::Bool32 found = VK_FALSE;
607 for (uint32_t j = 0; j < layer_count; j++) {
608 if (!strcmp(check_names[i], layers[j].layerName)) {
609 found = VK_TRUE;
610 break;
611 }
612 }
613 if (!found) {
614 fprintf(stderr, "Cannot find layer: %s\n", check_names[i]);
615 return 0;
616 }
617 }
618 return VK_TRUE;
619}
620
621void Demo::cleanup() {
622 prepared = false;
623 device.waitIdle();
624
625 // Wait for fences from present operations
626 for (uint32_t i = 0; i < FRAME_LAG; i++) {
627 device.waitForFences(1, &fences[i], VK_TRUE, UINT64_MAX);
628 device.destroyFence(fences[i], nullptr);
629 device.destroySemaphore(image_acquired_semaphores[i], nullptr);
630 device.destroySemaphore(draw_complete_semaphores[i], nullptr);
631 if (separate_present_queue) {
632 device.destroySemaphore(image_ownership_semaphores[i], nullptr);
633 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600634 }
635
Dave Houlton5fa47912018-02-16 11:02:26 -0700636 for (uint32_t i = 0; i < swapchainImageCount; i++) {
637 device.destroyFramebuffer(swapchain_image_resources[i].framebuffer, nullptr);
638 }
639 device.destroyDescriptorPool(desc_pool, nullptr);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600640
Dave Houlton5fa47912018-02-16 11:02:26 -0700641 device.destroyPipeline(pipeline, nullptr);
642 device.destroyPipelineCache(pipelineCache, nullptr);
643 device.destroyRenderPass(render_pass, nullptr);
644 device.destroyPipelineLayout(pipeline_layout, nullptr);
645 device.destroyDescriptorSetLayout(desc_layout, nullptr);
646
647 for (uint32_t i = 0; i < texture_count; i++) {
648 device.destroyImageView(textures[i].view, nullptr);
649 device.destroyImage(textures[i].image, nullptr);
650 device.freeMemory(textures[i].mem, nullptr);
651 device.destroySampler(textures[i].sampler, nullptr);
652 }
653 device.destroySwapchainKHR(swapchain, nullptr);
654
655 device.destroyImageView(depth.view, nullptr);
656 device.destroyImage(depth.image, nullptr);
657 device.freeMemory(depth.mem, nullptr);
658
659 for (uint32_t i = 0; i < swapchainImageCount; i++) {
660 device.destroyImageView(swapchain_image_resources[i].view, nullptr);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -0700661 device.freeCommandBuffers(cmd_pool, {swapchain_image_resources[i].cmd});
Dave Houlton5fa47912018-02-16 11:02:26 -0700662 device.destroyBuffer(swapchain_image_resources[i].uniform_buffer, nullptr);
Tony-LunarG37af49f2019-12-19 12:04:19 -0700663 device.unmapMemory(swapchain_image_resources[i].uniform_memory);
Dave Houlton5fa47912018-02-16 11:02:26 -0700664 device.freeMemory(swapchain_image_resources[i].uniform_memory, nullptr);
665 }
666
667 device.destroyCommandPool(cmd_pool, nullptr);
668
669 if (separate_present_queue) {
670 device.destroyCommandPool(present_cmd_pool, nullptr);
671 }
672 device.waitIdle();
673 device.destroy(nullptr);
674 inst.destroySurfaceKHR(surface, nullptr);
675
676#if defined(VK_USE_PLATFORM_XLIB_KHR)
677 XDestroyWindow(display, xlib_window);
678 XCloseDisplay(display);
679#elif defined(VK_USE_PLATFORM_XCB_KHR)
680 xcb_destroy_window(connection, xcb_window);
681 xcb_disconnect(connection);
682 free(atom_wm_delete_window);
683#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
684 wl_keyboard_destroy(keyboard);
685 wl_pointer_destroy(pointer);
686 wl_seat_destroy(seat);
Manuel Stoecklac939332019-06-26 20:55:53 -0400687 xdg_toplevel_destroy(window_toplevel);
688 xdg_surface_destroy(window_surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700689 wl_surface_destroy(window);
Manuel Stoecklac939332019-06-26 20:55:53 -0400690 xdg_wm_base_destroy(wm_base);
691 if (xdg_decoration_mgr) {
692 zxdg_toplevel_decoration_v1_destroy(toplevel_decoration);
693 zxdg_decoration_manager_v1_destroy(xdg_decoration_mgr);
694 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700695 wl_compositor_destroy(compositor);
696 wl_registry_destroy(registry);
697 wl_display_disconnect(display);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200698#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
699 event_buffer->Release(event_buffer);
700 window->Release(window);
701 dfb->Release(dfb);
Dave Houlton5fa47912018-02-16 11:02:26 -0700702#endif
703
704 inst.destroy(nullptr);
705}
706
707void Demo::create_device() {
708 float const priorities[1] = {0.0};
709
710 vk::DeviceQueueCreateInfo queues[2];
711 queues[0].setQueueFamilyIndex(graphics_queue_family_index);
712 queues[0].setQueueCount(1);
713 queues[0].setPQueuePriorities(priorities);
714
715 auto deviceInfo = vk::DeviceCreateInfo()
716 .setQueueCreateInfoCount(1)
717 .setPQueueCreateInfos(queues)
718 .setEnabledLayerCount(0)
719 .setPpEnabledLayerNames(nullptr)
720 .setEnabledExtensionCount(enabled_extension_count)
721 .setPpEnabledExtensionNames((const char *const *)extension_names)
722 .setPEnabledFeatures(nullptr);
723
724 if (separate_present_queue) {
725 queues[1].setQueueFamilyIndex(present_queue_family_index);
726 queues[1].setQueueCount(1);
727 queues[1].setPQueuePriorities(priorities);
728 deviceInfo.setQueueCreateInfoCount(2);
729 }
730
731 auto result = gpu.createDevice(&deviceInfo, nullptr, &device);
732 VERIFY(result == vk::Result::eSuccess);
733}
734
Tony-LunarGbc9fc052018-09-21 13:47:06 -0600735void Demo::destroy_texture(texture_object *tex_objs) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700736 // clean up staging resources
737 device.freeMemory(tex_objs->mem, nullptr);
Tony-LunarGbc9fc052018-09-21 13:47:06 -0600738 if (tex_objs->image) device.destroyImage(tex_objs->image, nullptr);
739 if (tex_objs->buffer) device.destroyBuffer(tex_objs->buffer, nullptr);
Dave Houlton5fa47912018-02-16 11:02:26 -0700740}
741
742void Demo::draw() {
743 // Ensure no more than FRAME_LAG renderings are outstanding
744 device.waitForFences(1, &fences[frame_index], VK_TRUE, UINT64_MAX);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -0700745 device.resetFences({fences[frame_index]});
Dave Houlton5fa47912018-02-16 11:02:26 -0700746
747 vk::Result result;
748 do {
749 result =
750 device.acquireNextImageKHR(swapchain, UINT64_MAX, image_acquired_semaphores[frame_index], vk::Fence(), &current_buffer);
751 if (result == vk::Result::eErrorOutOfDateKHR) {
752 // demo->swapchain is out of date (e.g. the window was resized) and
753 // must be recreated:
754 resize();
755 } else if (result == vk::Result::eSuboptimalKHR) {
756 // swapchain is not as optimal as it could be, but the platform's
757 // presentation engine will still present the image correctly.
758 break;
Tony-LunarG6cebf142019-09-11 14:32:23 -0600759 } else if (result == vk::Result::eErrorSurfaceLostKHR) {
760 inst.destroySurfaceKHR(surface, nullptr);
761 create_surface();
762 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700763 } else {
764 VERIFY(result == vk::Result::eSuccess);
765 }
766 } while (result != vk::Result::eSuccess);
767
768 update_data_buffer();
769
770 // Wait for the image acquired semaphore to be signaled to ensure
771 // that the image won't be rendered to until the presentation
772 // engine has fully released ownership to the application, and it is
773 // okay to render to the image.
774 vk::PipelineStageFlags const pipe_stage_flags = vk::PipelineStageFlagBits::eColorAttachmentOutput;
775 auto const submit_info = vk::SubmitInfo()
776 .setPWaitDstStageMask(&pipe_stage_flags)
777 .setWaitSemaphoreCount(1)
778 .setPWaitSemaphores(&image_acquired_semaphores[frame_index])
779 .setCommandBufferCount(1)
780 .setPCommandBuffers(&swapchain_image_resources[current_buffer].cmd)
781 .setSignalSemaphoreCount(1)
782 .setPSignalSemaphores(&draw_complete_semaphores[frame_index]);
783
784 result = graphics_queue.submit(1, &submit_info, fences[frame_index]);
785 VERIFY(result == vk::Result::eSuccess);
786
787 if (separate_present_queue) {
788 // If we are using separate queues, change image ownership to the
789 // present queue before presenting, waiting for the draw complete
790 // semaphore and signalling the ownership released semaphore when
791 // finished
792 auto const present_submit_info = vk::SubmitInfo()
793 .setPWaitDstStageMask(&pipe_stage_flags)
794 .setWaitSemaphoreCount(1)
795 .setPWaitSemaphores(&draw_complete_semaphores[frame_index])
796 .setCommandBufferCount(1)
797 .setPCommandBuffers(&swapchain_image_resources[current_buffer].graphics_to_present_cmd)
798 .setSignalSemaphoreCount(1)
799 .setPSignalSemaphores(&image_ownership_semaphores[frame_index]);
800
801 result = present_queue.submit(1, &present_submit_info, vk::Fence());
802 VERIFY(result == vk::Result::eSuccess);
803 }
804
805 // If we are using separate queues we have to wait for image ownership,
806 // otherwise wait for draw complete
807 auto const presentInfo = vk::PresentInfoKHR()
808 .setWaitSemaphoreCount(1)
809 .setPWaitSemaphores(separate_present_queue ? &image_ownership_semaphores[frame_index]
810 : &draw_complete_semaphores[frame_index])
811 .setSwapchainCount(1)
812 .setPSwapchains(&swapchain)
813 .setPImageIndices(&current_buffer);
814
815 result = present_queue.presentKHR(&presentInfo);
816 frame_index += 1;
817 frame_index %= FRAME_LAG;
818 if (result == vk::Result::eErrorOutOfDateKHR) {
819 // swapchain is out of date (e.g. the window was resized) and
820 // must be recreated:
821 resize();
822 } else if (result == vk::Result::eSuboptimalKHR) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600823 // SUBOPTIMAL could be due to resize
824 vk::SurfaceCapabilitiesKHR surfCapabilities;
Tony-LunarGbbdf5842021-06-11 12:00:30 -0600825 result = gpu.getSurfaceCapabilitiesKHR(surface, &surfCapabilities);
Tony-LunarGa8e96342021-06-04 15:12:55 -0600826 VERIFY(result == vk::Result::eSuccess);
827 if (surfCapabilities.currentExtent.width != width || surfCapabilities.currentExtent.height != height) {
828 resize();
829 }
Tony-LunarG6cebf142019-09-11 14:32:23 -0600830 } else if (result == vk::Result::eErrorSurfaceLostKHR) {
831 inst.destroySurfaceKHR(surface, nullptr);
832 create_surface();
833 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700834 } else {
835 VERIFY(result == vk::Result::eSuccess);
836 }
837}
838
839void Demo::draw_build_cmd(vk::CommandBuffer commandBuffer) {
840 auto const commandInfo = vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse);
841
842 vk::ClearValue const clearValues[2] = {vk::ClearColorValue(std::array<float, 4>({{0.2f, 0.2f, 0.2f, 0.2f}})),
843 vk::ClearDepthStencilValue(1.0f, 0u)};
844
845 auto const passInfo = vk::RenderPassBeginInfo()
846 .setRenderPass(render_pass)
847 .setFramebuffer(swapchain_image_resources[current_buffer].framebuffer)
848 .setRenderArea(vk::Rect2D(vk::Offset2D(0, 0), vk::Extent2D((uint32_t)width, (uint32_t)height)))
849 .setClearValueCount(2)
850 .setPClearValues(clearValues);
851
852 auto result = commandBuffer.begin(&commandInfo);
853 VERIFY(result == vk::Result::eSuccess);
854
855 commandBuffer.beginRenderPass(&passInfo, vk::SubpassContents::eInline);
856 commandBuffer.bindPipeline(vk::PipelineBindPoint::eGraphics, pipeline);
857 commandBuffer.bindDescriptorSets(vk::PipelineBindPoint::eGraphics, pipeline_layout, 0, 1,
858 &swapchain_image_resources[current_buffer].descriptor_set, 0, nullptr);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700859 float viewport_dimension;
860 float viewport_x = 0.0f;
861 float viewport_y = 0.0f;
862 if (width < height) {
863 viewport_dimension = (float)width;
864 viewport_y = (height - width) / 2.0f;
865 } else {
866 viewport_dimension = (float)height;
867 viewport_x = (width - height) / 2.0f;
868 }
869 auto const viewport = vk::Viewport()
870 .setX(viewport_x)
871 .setY(viewport_y)
872 .setWidth((float)viewport_dimension)
873 .setHeight((float)viewport_dimension)
874 .setMinDepth((float)0.0f)
875 .setMaxDepth((float)1.0f);
Dave Houlton5fa47912018-02-16 11:02:26 -0700876 commandBuffer.setViewport(0, 1, &viewport);
877
878 vk::Rect2D const scissor(vk::Offset2D(0, 0), vk::Extent2D(width, height));
879 commandBuffer.setScissor(0, 1, &scissor);
880 commandBuffer.draw(12 * 3, 1, 0, 0);
881 // Note that ending the renderpass changes the image's layout from
882 // COLOR_ATTACHMENT_OPTIMAL to PRESENT_SRC_KHR
883 commandBuffer.endRenderPass();
884
885 if (separate_present_queue) {
886 // We have to transfer ownership from the graphics queue family to
887 // the
888 // present queue family to be able to present. Note that we don't
889 // have
890 // to transfer from present queue family back to graphics queue
891 // family at
892 // the start of the next frame because we don't care about the
893 // image's
894 // contents at that point.
Jeremy Hayes9d304782016-10-09 11:48:12 -0600895 auto const image_ownership_barrier =
896 vk::ImageMemoryBarrier()
897 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600898 .setDstAccessMask(vk::AccessFlags())
Jeremy Hayes9d304782016-10-09 11:48:12 -0600899 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
900 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
901 .setSrcQueueFamilyIndex(graphics_queue_family_index)
902 .setDstQueueFamilyIndex(present_queue_family_index)
Dave Houlton5fa47912018-02-16 11:02:26 -0700903 .setImage(swapchain_image_resources[current_buffer].image)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -0700904 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600905
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600906 commandBuffer.pipelineBarrier(vk::PipelineStageFlagBits::eBottomOfPipe, vk::PipelineStageFlagBits::eBottomOfPipe,
Dave Houlton5fa47912018-02-16 11:02:26 -0700907 vk::DependencyFlagBits(), 0, nullptr, 0, nullptr, 1, &image_ownership_barrier);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600908 }
909
Dave Houlton5fa47912018-02-16 11:02:26 -0700910 result = commandBuffer.end();
911 VERIFY(result == vk::Result::eSuccess);
912}
913
914void Demo::flush_init_cmd() {
915 // TODO: hmm.
916 // This function could get called twice if the texture uses a staging
917 // buffer
918 // In that case the second call should be ignored
919 if (!cmd) {
920 return;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600921 }
922
Dave Houlton5fa47912018-02-16 11:02:26 -0700923 auto result = cmd.end();
924 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600925
Dave Houlton5fa47912018-02-16 11:02:26 -0700926 auto const fenceInfo = vk::FenceCreateInfo();
927 vk::Fence fence;
928 result = device.createFence(&fenceInfo, nullptr, &fence);
929 VERIFY(result == vk::Result::eSuccess);
930
931 vk::CommandBuffer const commandBuffers[] = {cmd};
932 auto const submitInfo = vk::SubmitInfo().setCommandBufferCount(1).setPCommandBuffers(commandBuffers);
933
934 result = graphics_queue.submit(1, &submitInfo, fence);
935 VERIFY(result == vk::Result::eSuccess);
936
937 result = device.waitForFences(1, &fence, VK_TRUE, UINT64_MAX);
938 VERIFY(result == vk::Result::eSuccess);
939
940 device.freeCommandBuffers(cmd_pool, 1, commandBuffers);
941 device.destroyFence(fence, nullptr);
942
943 cmd = vk::CommandBuffer();
944}
945
946void Demo::init(int argc, char **argv) {
947 vec3 eye = {0.0f, 3.0f, 5.0f};
948 vec3 origin = {0, 0, 0};
949 vec3 up = {0.0f, 1.0f, 0.0};
950
951 presentMode = vk::PresentModeKHR::eFifo;
952 frameCount = UINT32_MAX;
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100953 width = 500;
954 height = 500;
Dave Houlton5fa47912018-02-16 11:02:26 -0700955 use_xlib = false;
Witold Baryluka3b988f2021-01-07 19:03:02 +0000956 /* Autodetect suitable / best GPU by default */
957 gpu_number = -1;
Tony-LunarG6cebf142019-09-11 14:32:23 -0600958
Dave Houlton5fa47912018-02-16 11:02:26 -0700959 for (int i = 1; i < argc; i++) {
960 if (strcmp(argv[i], "--use_staging") == 0) {
961 use_staging_buffer = true;
962 continue;
963 }
964 if ((strcmp(argv[i], "--present_mode") == 0) && (i < argc - 1)) {
965 presentMode = (vk::PresentModeKHR)atoi(argv[i + 1]);
966 i++;
967 continue;
968 }
969 if (strcmp(argv[i], "--break") == 0) {
970 use_break = true;
971 continue;
972 }
973 if (strcmp(argv[i], "--validate") == 0) {
974 validate = true;
975 continue;
976 }
977 if (strcmp(argv[i], "--xlib") == 0) {
978 fprintf(stderr, "--xlib is deprecated and no longer does anything");
979 continue;
980 }
981 if (strcmp(argv[i], "--c") == 0 && frameCount == UINT32_MAX && i < argc - 1 &&
982 sscanf(argv[i + 1], "%" SCNu32, &frameCount) == 1) {
983 i++;
984 continue;
985 }
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100986 if (strcmp(argv[i], "--width") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &width) == 1 && width > 0) {
987 i++;
988 continue;
989 }
990 if (strcmp(argv[i], "--height") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &height) == 1 && height > 0) {
991 i++;
992 continue;
993 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700994 if (strcmp(argv[i], "--suppress_popups") == 0) {
995 suppress_popups = true;
996 continue;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600997 }
Tony-LunarG50e737c2020-07-16 14:26:03 -0600998 if ((strcmp(argv[i], "--gpu_number") == 0) && (i < argc - 1)) {
999 gpu_number = atoi(argv[i + 1]);
Witold Baryluka3b988f2021-01-07 19:03:02 +00001000 assert(gpu_number >= 0);
Tony-LunarG50e737c2020-07-16 14:26:03 -06001001 i++;
1002 continue;
1003 }
Tony-LunarGd74734f2019-06-04 14:11:43 -06001004 std::stringstream usage;
1005 usage << "Usage:\n " << APP_SHORT_NAME << "\t[--use_staging] [--validate]\n"
1006 << "\t[--break] [--c <framecount>] [--suppress_popups]\n"
Tony-LunarG50e737c2020-07-16 14:26:03 -06001007 << "\t[--gpu_number <index of physical device>]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -06001008 << "\t[--present_mode <present mode enum>]\n"
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +01001009 << "\t[--width <width>] [--height <height>]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -06001010 << "\t<present_mode_enum>\n"
1011 << "\t\tVK_PRESENT_MODE_IMMEDIATE_KHR = " << VK_PRESENT_MODE_IMMEDIATE_KHR << "\n"
1012 << "\t\tVK_PRESENT_MODE_MAILBOX_KHR = " << VK_PRESENT_MODE_MAILBOX_KHR << "\n"
1013 << "\t\tVK_PRESENT_MODE_FIFO_KHR = " << VK_PRESENT_MODE_FIFO_KHR << "\n"
Witold Baryluka3b988f2021-01-07 19:03:02 +00001014 << "\t\tVK_PRESENT_MODE_FIFO_RELAXED_KHR = " << VK_PRESENT_MODE_FIFO_RELAXED_KHR << "\n";
Tony-LunarGd74734f2019-06-04 14:11:43 -06001015
1016#if defined(_WIN32)
1017 if (!suppress_popups) MessageBox(NULL, usage.str().c_str(), "Usage Error", MB_OK);
1018#else
1019 std::cerr << usage.str();
1020 std::cerr.flush();
1021#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001022 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001023 }
1024
Dave Houlton5fa47912018-02-16 11:02:26 -07001025 if (!use_xlib) {
1026 init_connection();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001027 }
1028
Dave Houlton5fa47912018-02-16 11:02:26 -07001029 init_vk();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001030
Dave Houlton5fa47912018-02-16 11:02:26 -07001031 spin_angle = 4.0f;
1032 spin_increment = 0.2f;
1033 pause = false;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001034
Dave Houlton5fa47912018-02-16 11:02:26 -07001035 mat4x4_perspective(projection_matrix, (float)degreesToRadians(45.0f), 1.0f, 0.1f, 100.0f);
1036 mat4x4_look_at(view_matrix, eye, origin, up);
1037 mat4x4_identity(model_matrix);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001038
Dave Houlton5fa47912018-02-16 11:02:26 -07001039 projection_matrix[1][1] *= -1; // Flip projection matrix from GL to Vulkan orientation.
1040}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001041
Dave Houlton5fa47912018-02-16 11:02:26 -07001042void Demo::init_connection() {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001043#if defined(VK_USE_PLATFORM_XCB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001044 const xcb_setup_t *setup;
1045 xcb_screen_iterator_t iter;
1046 int scr;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001047
Dave Houlton5fa47912018-02-16 11:02:26 -07001048 const char *display_envar = getenv("DISPLAY");
1049 if (display_envar == nullptr || display_envar[0] == '\0') {
1050 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
1051 fflush(stdout);
1052 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001053 }
1054
Dave Houlton5fa47912018-02-16 11:02:26 -07001055 connection = xcb_connect(nullptr, &scr);
1056 if (xcb_connection_has_error(connection) > 0) {
1057 printf(
1058 "Cannot find a compatible Vulkan installable client driver "
1059 "(ICD).\nExiting ...\n");
1060 fflush(stdout);
1061 exit(1);
1062 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001063
Dave Houlton5fa47912018-02-16 11:02:26 -07001064 setup = xcb_get_setup(connection);
1065 iter = xcb_setup_roots_iterator(setup);
1066 while (scr-- > 0) xcb_screen_next(&iter);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001067
Dave Houlton5fa47912018-02-16 11:02:26 -07001068 screen = iter.data;
1069#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1070 display = wl_display_connect(nullptr);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001071
Dave Houlton5fa47912018-02-16 11:02:26 -07001072 if (display == nullptr) {
1073 printf("Cannot find a compatible Vulkan installable client driver (ICD).\nExiting ...\n");
1074 fflush(stdout);
1075 exit(1);
1076 }
1077
1078 registry = wl_display_get_registry(display);
1079 wl_registry_add_listener(registry, &registry_listener, this);
1080 wl_display_dispatch(display);
Dave Houlton5fa47912018-02-16 11:02:26 -07001081#endif
1082}
Tony-LunarG27c21242021-03-11 16:28:19 -07001083#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
1084int find_display_gpu(int gpu_number, uint32_t gpu_count, std::unique_ptr<vk::PhysicalDevice[]> &physical_devices) {
1085 uint32_t display_count = 0;
1086 vk::Result result;
1087 int gpu_return = gpu_number;
1088 if (gpu_number >= 0) {
1089 result = physical_devices[gpu_number].getDisplayPropertiesKHR(&display_count, nullptr);
1090 VERIFY(result == vk::Result::eSuccess);
1091 } else {
1092 for (uint32_t i = 0; i < gpu_count; i++) {
1093 result = physical_devices[i].getDisplayPropertiesKHR(&display_count, nullptr);
1094 VERIFY(result == vk::Result::eSuccess);
1095 if (display_count) {
1096 gpu_return = i;
1097 break;
1098 }
1099 }
1100 }
1101 if (display_count > 0)
1102 return gpu_return;
1103 else
1104 return -1;
1105}
1106#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001107void Demo::init_vk() {
1108 uint32_t instance_extension_count = 0;
1109 uint32_t instance_layer_count = 0;
Mark Lobodzinski96f2ff32019-03-27 12:37:30 -06001110 char const *const instance_validation_layers[] = {"VK_LAYER_KHRONOS_validation"};
Dave Houlton5fa47912018-02-16 11:02:26 -07001111 enabled_extension_count = 0;
1112 enabled_layer_count = 0;
1113
Dave Houlton5fa47912018-02-16 11:02:26 -07001114 // Look for validation layers
1115 vk::Bool32 validation_found = VK_FALSE;
1116 if (validate) {
Mike Schuchardt7510c832018-10-29 13:23:08 -07001117 auto result = vk::enumerateInstanceLayerProperties(&instance_layer_count, static_cast<vk::LayerProperties *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001118 VERIFY(result == vk::Result::eSuccess);
1119
Dave Houlton5fa47912018-02-16 11:02:26 -07001120 if (instance_layer_count > 0) {
1121 std::unique_ptr<vk::LayerProperties[]> instance_layers(new vk::LayerProperties[instance_layer_count]);
1122 result = vk::enumerateInstanceLayerProperties(&instance_layer_count, instance_layers.get());
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001123 VERIFY(result == vk::Result::eSuccess);
1124
Mark Lobodzinski96f2ff32019-03-27 12:37:30 -06001125 validation_found = check_layers(ARRAY_SIZE(instance_validation_layers), instance_validation_layers,
Dave Houlton5fa47912018-02-16 11:02:26 -07001126 instance_layer_count, instance_layers.get());
1127 if (validation_found) {
Mark Lobodzinski96f2ff32019-03-27 12:37:30 -06001128 enabled_layer_count = ARRAY_SIZE(instance_validation_layers);
1129 enabled_layers[0] = "VK_LAYER_KHRONOS_validation";
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001130 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001131 }
1132
Dave Houlton5fa47912018-02-16 11:02:26 -07001133 if (!validation_found) {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001134 ERR_EXIT(
Dave Houlton5fa47912018-02-16 11:02:26 -07001135 "vkEnumerateInstanceLayerProperties failed to find required validation layer.\n\n"
1136 "Please look at the Getting Started guide for additional information.\n",
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001137 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001138 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001139 }
1140
Dave Houlton5fa47912018-02-16 11:02:26 -07001141 /* Look for instance extensions */
1142 vk::Bool32 surfaceExtFound = VK_FALSE;
1143 vk::Bool32 platformSurfaceExtFound = VK_FALSE;
1144 memset(extension_names, 0, sizeof(extension_names));
1145
Mike Schuchardt7510c832018-10-29 13:23:08 -07001146 auto result = vk::enumerateInstanceExtensionProperties(nullptr, &instance_extension_count,
1147 static_cast<vk::ExtensionProperties *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001148 VERIFY(result == vk::Result::eSuccess);
1149
1150 if (instance_extension_count > 0) {
1151 std::unique_ptr<vk::ExtensionProperties[]> instance_extensions(new vk::ExtensionProperties[instance_extension_count]);
1152 result = vk::enumerateInstanceExtensionProperties(nullptr, &instance_extension_count, instance_extensions.get());
1153 VERIFY(result == vk::Result::eSuccess);
1154
1155 for (uint32_t i = 0; i < instance_extension_count; i++) {
Richard S. Wright Jrca51bc72021-01-06 13:03:18 -05001156 if (!strcmp(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1157 extension_names[enabled_extension_count++] = VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME;
1158 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001159 if (!strcmp(VK_KHR_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1160 surfaceExtFound = 1;
1161 extension_names[enabled_extension_count++] = VK_KHR_SURFACE_EXTENSION_NAME;
1162 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001163#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001164 if (!strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1165 platformSurfaceExtFound = 1;
1166 extension_names[enabled_extension_count++] = VK_KHR_WIN32_SURFACE_EXTENSION_NAME;
1167 }
1168#elif defined(VK_USE_PLATFORM_XLIB_KHR)
1169 if (!strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1170 platformSurfaceExtFound = 1;
1171 extension_names[enabled_extension_count++] = VK_KHR_XLIB_SURFACE_EXTENSION_NAME;
1172 }
1173#elif defined(VK_USE_PLATFORM_XCB_KHR)
1174 if (!strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1175 platformSurfaceExtFound = 1;
1176 extension_names[enabled_extension_count++] = VK_KHR_XCB_SURFACE_EXTENSION_NAME;
1177 }
Tony Barbour153cb062016-12-07 13:43:36 -07001178#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001179 if (!strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1180 platformSurfaceExtFound = 1;
1181 extension_names[enabled_extension_count++] = VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME;
1182 }
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001183#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1184 if (!strcmp(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1185 platformSurfaceExtFound = 1;
1186 extension_names[enabled_extension_count++] = VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME;
1187 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001188#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
1189 if (!strcmp(VK_KHR_DISPLAY_EXTENSION_NAME, instance_extensions[i].extensionName)) {
1190 platformSurfaceExtFound = 1;
1191 extension_names[enabled_extension_count++] = VK_KHR_DISPLAY_EXTENSION_NAME;
1192 }
Bill Hollings0a0625a2019-07-15 17:39:18 -04001193#elif defined(VK_USE_PLATFORM_METAL_EXT)
1194 if (!strcmp(VK_EXT_METAL_SURFACE_EXTENSION_NAME, instance_extensions[i].extensionName)) {
Karl Schultz9ceac062017-12-12 10:33:01 -05001195 platformSurfaceExtFound = 1;
Bill Hollings0a0625a2019-07-15 17:39:18 -04001196 extension_names[enabled_extension_count++] = VK_EXT_METAL_SURFACE_EXTENSION_NAME;
Karl Schultz9ceac062017-12-12 10:33:01 -05001197 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001198#endif
1199 assert(enabled_extension_count < 64);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001200 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001201 }
1202
1203 if (!surfaceExtFound) {
1204 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_SURFACE_EXTENSION_NAME
1205 " extension.\n\n"
1206 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1207 "Please look at the Getting Started guide for additional information.\n",
1208 "vkCreateInstance Failure");
1209 }
1210
1211 if (!platformSurfaceExtFound) {
1212#if defined(VK_USE_PLATFORM_WIN32_KHR)
1213 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WIN32_SURFACE_EXTENSION_NAME
1214 " extension.\n\n"
1215 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1216 "Please look at the Getting Started guide for additional information.\n",
1217 "vkCreateInstance Failure");
1218#elif defined(VK_USE_PLATFORM_XCB_KHR)
1219 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XCB_SURFACE_EXTENSION_NAME
1220 " extension.\n\n"
1221 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1222 "Please look at the Getting Started guide for additional information.\n",
1223 "vkCreateInstance Failure");
1224#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1225 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME
1226 " extension.\n\n"
1227 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1228 "Please look at the Getting Started guide for additional information.\n",
1229 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001230#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001231 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XLIB_SURFACE_EXTENSION_NAME
1232 " extension.\n\n"
1233 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1234 "Please look at the Getting Started guide for additional information.\n",
1235 "vkCreateInstance Failure");
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001236#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1237 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME
1238 " extension.\n\n"
1239 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1240 "Please look at the Getting Started guide for additional information.\n",
1241 "vkCreateInstance Failure");
Damien Leone600c3052017-01-31 10:26:07 -07001242#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001243 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_DISPLAY_EXTENSION_NAME
1244 " extension.\n\n"
1245 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1246 "Please look at the Getting Started guide for additional information.\n",
1247 "vkCreateInstance Failure");
Bill Hollings0a0625a2019-07-15 17:39:18 -04001248#elif defined(VK_USE_PLATFORM_METAL_EXT)
1249 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_METAL_SURFACE_EXTENSION_NAME
Karl Schultz9ceac062017-12-12 10:33:01 -05001250 " extension.\n\nDo you have a compatible "
1251 "Vulkan installable client driver (ICD) installed?\nPlease "
1252 "look at the Getting Started guide for additional "
1253 "information.\n",
1254 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001255#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001256 }
1257 auto const app = vk::ApplicationInfo()
1258 .setPApplicationName(APP_SHORT_NAME)
1259 .setApplicationVersion(0)
1260 .setPEngineName(APP_SHORT_NAME)
1261 .setEngineVersion(0)
1262 .setApiVersion(VK_API_VERSION_1_0);
1263 auto const inst_info = vk::InstanceCreateInfo()
1264 .setPApplicationInfo(&app)
1265 .setEnabledLayerCount(enabled_layer_count)
1266 .setPpEnabledLayerNames(instance_validation_layers)
1267 .setEnabledExtensionCount(enabled_extension_count)
1268 .setPpEnabledExtensionNames(extension_names);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001269
Dave Houlton5fa47912018-02-16 11:02:26 -07001270 result = vk::createInstance(&inst_info, nullptr, &inst);
1271 if (result == vk::Result::eErrorIncompatibleDriver) {
1272 ERR_EXIT(
1273 "Cannot find a compatible Vulkan installable client driver (ICD).\n\n"
1274 "Please look at the Getting Started guide for additional information.\n",
1275 "vkCreateInstance Failure");
1276 } else if (result == vk::Result::eErrorExtensionNotPresent) {
1277 ERR_EXIT(
1278 "Cannot find a specified extension library.\n"
1279 "Make sure your layers path is set appropriately.\n",
1280 "vkCreateInstance Failure");
1281 } else if (result != vk::Result::eSuccess) {
1282 ERR_EXIT(
1283 "vkCreateInstance failed.\n\n"
1284 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1285 "Please look at the Getting Started guide for additional information.\n",
1286 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001287 }
1288
Witold Baryluka3b988f2021-01-07 19:03:02 +00001289 /* Make initial call to query gpu_count, then second call for gpu info */
1290 uint32_t gpu_count = 0;
Mike Schuchardt7510c832018-10-29 13:23:08 -07001291 result = inst.enumeratePhysicalDevices(&gpu_count, static_cast<vk::PhysicalDevice *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001292 VERIFY(result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001293
Witold Baryluka3b988f2021-01-07 19:03:02 +00001294 if (gpu_count <= 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001295 ERR_EXIT(
1296 "vkEnumeratePhysicalDevices reported zero accessible devices.\n\n"
1297 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1298 "Please look at the Getting Started guide for additional information.\n",
1299 "vkEnumeratePhysicalDevices Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001300 }
1301
Witold Baryluka3b988f2021-01-07 19:03:02 +00001302 std::unique_ptr<vk::PhysicalDevice[]> physical_devices(new vk::PhysicalDevice[gpu_count]);
1303 result = inst.enumeratePhysicalDevices(&gpu_count, physical_devices.get());
1304 VERIFY(result == vk::Result::eSuccess);
1305
1306 if (gpu_number >= 0 && !((uint32_t)gpu_number < gpu_count)) {
1307 fprintf(stderr, "GPU %d specified is not present, GPU count = %u\n", gpu_number, gpu_count);
1308 ERR_EXIT("Specified GPU number is not present", "User Error");
1309 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001310#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
1311 gpu_number = find_display_gpu(gpu_number, gpu_count, physical_devices);
1312 if (gpu_number < 0) {
1313 printf("Cannot find any display!\n");
1314 fflush(stdout);
1315 exit(1);
1316 }
1317#else
Witold Baryluka3b988f2021-01-07 19:03:02 +00001318 /* Try to auto select most suitable device */
1319 if (gpu_number == -1) {
1320 uint32_t count_device_type[VK_PHYSICAL_DEVICE_TYPE_CPU + 1];
1321 memset(count_device_type, 0, sizeof(count_device_type));
1322
1323 for (uint32_t i = 0; i < gpu_count; i++) {
1324 const auto physicalDeviceProperties = physical_devices[i].getProperties();
1325 assert(static_cast<int>(physicalDeviceProperties.deviceType) <= VK_PHYSICAL_DEVICE_TYPE_CPU);
1326 count_device_type[static_cast<int>(physicalDeviceProperties.deviceType)]++;
1327 }
1328
1329 const vk::PhysicalDeviceType device_type_preference[] = {
1330 vk::PhysicalDeviceType::eDiscreteGpu, vk::PhysicalDeviceType::eIntegratedGpu, vk::PhysicalDeviceType::eVirtualGpu,
1331 vk::PhysicalDeviceType::eCpu, vk::PhysicalDeviceType::eOther};
1332 vk::PhysicalDeviceType search_for_device_type = vk::PhysicalDeviceType::eDiscreteGpu;
1333 for (uint32_t i = 0; i < sizeof(device_type_preference) / sizeof(vk::PhysicalDeviceType); i++) {
1334 if (count_device_type[static_cast<int>(device_type_preference[i])]) {
1335 search_for_device_type = device_type_preference[i];
1336 break;
1337 }
1338 }
1339
1340 for (uint32_t i = 0; i < gpu_count; i++) {
1341 const auto physicalDeviceProperties = physical_devices[i].getProperties();
1342 if (physicalDeviceProperties.deviceType == search_for_device_type) {
1343 gpu_number = i;
1344 break;
1345 }
1346 }
1347 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001348#endif
Witold Baryluka3b988f2021-01-07 19:03:02 +00001349 assert(gpu_number >= 0);
1350 gpu = physical_devices[gpu_number];
1351 {
1352 auto physicalDeviceProperties = gpu.getProperties();
1353 fprintf(stderr, "Selected GPU %d: %s, type: %s\n", gpu_number, physicalDeviceProperties.deviceName.data(),
1354 to_string(physicalDeviceProperties.deviceType).c_str());
1355 }
1356 physical_devices.reset();
1357
Dave Houlton5fa47912018-02-16 11:02:26 -07001358 /* Look for device extensions */
1359 uint32_t device_extension_count = 0;
1360 vk::Bool32 swapchainExtFound = VK_FALSE;
1361 enabled_extension_count = 0;
1362 memset(extension_names, 0, sizeof(extension_names));
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001363
Mike Schuchardt7510c832018-10-29 13:23:08 -07001364 result =
1365 gpu.enumerateDeviceExtensionProperties(nullptr, &device_extension_count, static_cast<vk::ExtensionProperties *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001366 VERIFY(result == vk::Result::eSuccess);
1367
1368 if (device_extension_count > 0) {
1369 std::unique_ptr<vk::ExtensionProperties[]> device_extensions(new vk::ExtensionProperties[device_extension_count]);
1370 result = gpu.enumerateDeviceExtensionProperties(nullptr, &device_extension_count, device_extensions.get());
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001371 VERIFY(result == vk::Result::eSuccess);
1372
Dave Houlton5fa47912018-02-16 11:02:26 -07001373 for (uint32_t i = 0; i < device_extension_count; i++) {
1374 if (!strcmp(VK_KHR_SWAPCHAIN_EXTENSION_NAME, device_extensions[i].extensionName)) {
1375 swapchainExtFound = 1;
1376 extension_names[enabled_extension_count++] = VK_KHR_SWAPCHAIN_EXTENSION_NAME;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001377 }
Richard S. Wright Jra7825742021-01-06 16:02:12 -05001378 if (!strcmp("VK_KHR_portability_subset", device_extensions[i].extensionName)) {
1379 extension_names[enabled_extension_count++] = "VK_KHR_portability_subset";
Richard S. Wright Jrca51bc72021-01-06 13:03:18 -05001380 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001381 assert(enabled_extension_count < 64);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001382 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001383 }
Jeremy Hayes6ae1f8a2016-11-16 14:47:13 -07001384
Dave Houlton5fa47912018-02-16 11:02:26 -07001385 if (!swapchainExtFound) {
1386 ERR_EXIT("vkEnumerateDeviceExtensionProperties failed to find the " VK_KHR_SWAPCHAIN_EXTENSION_NAME
1387 " extension.\n\n"
1388 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1389 "Please look at the Getting Started guide for additional information.\n",
1390 "vkCreateInstance Failure");
1391 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001392
Dave Houlton5fa47912018-02-16 11:02:26 -07001393 gpu.getProperties(&gpu_props);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001394
Dave Houlton5fa47912018-02-16 11:02:26 -07001395 /* Call with nullptr data to get count */
Mike Schuchardt7510c832018-10-29 13:23:08 -07001396 gpu.getQueueFamilyProperties(&queue_family_count, static_cast<vk::QueueFamilyProperties *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001397 assert(queue_family_count >= 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001398
Dave Houlton5fa47912018-02-16 11:02:26 -07001399 queue_props.reset(new vk::QueueFamilyProperties[queue_family_count]);
1400 gpu.getQueueFamilyProperties(&queue_family_count, queue_props.get());
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001401
Dave Houlton5fa47912018-02-16 11:02:26 -07001402 // Query fine-grained feature support for this device.
1403 // If app has specific feature requirements it should check supported
1404 // features based on this query
1405 vk::PhysicalDeviceFeatures physDevFeatures;
1406 gpu.getFeatures(&physDevFeatures);
1407}
1408
Tony-LunarG6cebf142019-09-11 14:32:23 -06001409void Demo::create_surface() {
Dave Houlton5fa47912018-02-16 11:02:26 -07001410// Create a WSI surface for the window:
1411#if defined(VK_USE_PLATFORM_WIN32_KHR)
1412 {
1413 auto const createInfo = vk::Win32SurfaceCreateInfoKHR().setHinstance(connection).setHwnd(window);
1414
1415 auto result = inst.createWin32SurfaceKHR(&createInfo, nullptr, &surface);
1416 VERIFY(result == vk::Result::eSuccess);
1417 }
1418#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1419 {
1420 auto const createInfo = vk::WaylandSurfaceCreateInfoKHR().setDisplay(display).setSurface(window);
1421
1422 auto result = inst.createWaylandSurfaceKHR(&createInfo, nullptr, &surface);
1423 VERIFY(result == vk::Result::eSuccess);
1424 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001425#elif defined(VK_USE_PLATFORM_XLIB_KHR)
1426 {
1427 auto const createInfo = vk::XlibSurfaceCreateInfoKHR().setDpy(display).setWindow(xlib_window);
1428
1429 auto result = inst.createXlibSurfaceKHR(&createInfo, nullptr, &surface);
1430 VERIFY(result == vk::Result::eSuccess);
1431 }
1432#elif defined(VK_USE_PLATFORM_XCB_KHR)
1433 {
1434 auto const createInfo = vk::XcbSurfaceCreateInfoKHR().setConnection(connection).setWindow(xcb_window);
1435
1436 auto result = inst.createXcbSurfaceKHR(&createInfo, nullptr, &surface);
1437 VERIFY(result == vk::Result::eSuccess);
1438 }
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001439#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1440 {
1441 auto const createInfo = vk::DirectFBSurfaceCreateInfoEXT().setDfb(dfb).setSurface(window);
1442
1443 auto result = inst.createDirectFBSurfaceEXT(&createInfo, nullptr, &surface);
1444 VERIFY(result == vk::Result::eSuccess);
1445 }
Bill Hollings0a0625a2019-07-15 17:39:18 -04001446#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05001447 {
Bill Hollings0a0625a2019-07-15 17:39:18 -04001448 auto const createInfo = vk::MetalSurfaceCreateInfoEXT().setPLayer(static_cast<CAMetalLayer *>(caMetalLayer));
Karl Schultz9ceac062017-12-12 10:33:01 -05001449
Bill Hollings0a0625a2019-07-15 17:39:18 -04001450 auto result = inst.createMetalSurfaceEXT(&createInfo, nullptr, &surface);
Karl Schultz9ceac062017-12-12 10:33:01 -05001451 VERIFY(result == vk::Result::eSuccess);
1452 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001453#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
1454 {
1455 auto result = create_display_surface();
1456 VERIFY(result == vk::Result::eSuccess);
1457 }
1458#endif
Tony-LunarG6cebf142019-09-11 14:32:23 -06001459}
1460
1461void Demo::init_vk_swapchain() {
1462 create_surface();
Dave Houlton5fa47912018-02-16 11:02:26 -07001463 // Iterate over each queue to learn whether it supports presenting:
1464 std::unique_ptr<vk::Bool32[]> supportsPresent(new vk::Bool32[queue_family_count]);
1465 for (uint32_t i = 0; i < queue_family_count; i++) {
1466 gpu.getSurfaceSupportKHR(i, surface, &supportsPresent[i]);
1467 }
1468
1469 uint32_t graphicsQueueFamilyIndex = UINT32_MAX;
1470 uint32_t presentQueueFamilyIndex = UINT32_MAX;
1471 for (uint32_t i = 0; i < queue_family_count; i++) {
1472 if (queue_props[i].queueFlags & vk::QueueFlagBits::eGraphics) {
1473 if (graphicsQueueFamilyIndex == UINT32_MAX) {
1474 graphicsQueueFamilyIndex = i;
1475 }
1476
1477 if (supportsPresent[i] == VK_TRUE) {
1478 graphicsQueueFamilyIndex = i;
1479 presentQueueFamilyIndex = i;
Jeremy Hayes00399e32017-06-14 15:07:32 -06001480 break;
1481 }
1482 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001483 }
Jeremy Hayes00399e32017-06-14 15:07:32 -06001484
Dave Houlton5fa47912018-02-16 11:02:26 -07001485 if (presentQueueFamilyIndex == UINT32_MAX) {
1486 // If didn't find a queue that supports both graphics and present,
1487 // then
1488 // find a separate present queue.
1489 for (uint32_t i = 0; i < queue_family_count; ++i) {
1490 if (supportsPresent[i] == VK_TRUE) {
1491 presentQueueFamilyIndex = i;
1492 break;
1493 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001494 }
1495 }
1496
Dave Houlton5fa47912018-02-16 11:02:26 -07001497 // Generate error if could not find both a graphics and a present queue
1498 if (graphicsQueueFamilyIndex == UINT32_MAX || presentQueueFamilyIndex == UINT32_MAX) {
1499 ERR_EXIT("Could not find both graphics and present queues\n", "Swapchain Initialization Failure");
1500 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001501
Dave Houlton5fa47912018-02-16 11:02:26 -07001502 graphics_queue_family_index = graphicsQueueFamilyIndex;
1503 present_queue_family_index = presentQueueFamilyIndex;
1504 separate_present_queue = (graphics_queue_family_index != present_queue_family_index);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001505
Dave Houlton5fa47912018-02-16 11:02:26 -07001506 create_device();
Jeremy Hayes00399e32017-06-14 15:07:32 -06001507
Dave Houlton5fa47912018-02-16 11:02:26 -07001508 device.getQueue(graphics_queue_family_index, 0, &graphics_queue);
1509 if (!separate_present_queue) {
1510 present_queue = graphics_queue;
1511 } else {
1512 device.getQueue(present_queue_family_index, 0, &present_queue);
1513 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001514
Dave Houlton5fa47912018-02-16 11:02:26 -07001515 // Get the list of VkFormat's that are supported:
1516 uint32_t formatCount;
Mike Schuchardt7510c832018-10-29 13:23:08 -07001517 auto result = gpu.getSurfaceFormatsKHR(surface, &formatCount, static_cast<vk::SurfaceFormatKHR *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001518 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001519
Dave Houlton5fa47912018-02-16 11:02:26 -07001520 std::unique_ptr<vk::SurfaceFormatKHR[]> surfFormats(new vk::SurfaceFormatKHR[formatCount]);
1521 result = gpu.getSurfaceFormatsKHR(surface, &formatCount, surfFormats.get());
1522 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001523
Dave Houlton5fa47912018-02-16 11:02:26 -07001524 // If the format list includes just one entry of VK_FORMAT_UNDEFINED,
1525 // the surface has no preferred format. Otherwise, at least one
1526 // supported format will be returned.
1527 if (formatCount == 1 && surfFormats[0].format == vk::Format::eUndefined) {
1528 format = vk::Format::eB8G8R8A8Unorm;
1529 } else {
1530 assert(formatCount >= 1);
1531 format = surfFormats[0].format;
1532 }
1533 color_space = surfFormats[0].colorSpace;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001534
Dave Houlton5fa47912018-02-16 11:02:26 -07001535 quit = false;
1536 curFrame = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001537
Dave Houlton5fa47912018-02-16 11:02:26 -07001538 // Create semaphores to synchronize acquiring presentable buffers before
1539 // rendering and waiting for drawing to be complete before presenting
1540 auto const semaphoreCreateInfo = vk::SemaphoreCreateInfo();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001541
Dave Houlton5fa47912018-02-16 11:02:26 -07001542 // Create fences that we can use to throttle if we get too far
1543 // ahead of the image presents
1544 auto const fence_ci = vk::FenceCreateInfo().setFlags(vk::FenceCreateFlagBits::eSignaled);
1545 for (uint32_t i = 0; i < FRAME_LAG; i++) {
1546 result = device.createFence(&fence_ci, nullptr, &fences[i]);
1547 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001548
Dave Houlton5fa47912018-02-16 11:02:26 -07001549 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_acquired_semaphores[i]);
1550 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001551
Dave Houlton5fa47912018-02-16 11:02:26 -07001552 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &draw_complete_semaphores[i]);
1553 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001554
Dave Houlton5fa47912018-02-16 11:02:26 -07001555 if (separate_present_queue) {
1556 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_ownership_semaphores[i]);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001557 VERIFY(result == vk::Result::eSuccess);
1558 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001559 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001560 frame_index = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001561
Dave Houlton5fa47912018-02-16 11:02:26 -07001562 // Get Memory information and properties
1563 gpu.getMemoryProperties(&memory_properties);
1564}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001565
Dave Houlton5fa47912018-02-16 11:02:26 -07001566void Demo::prepare() {
1567 auto const cmd_pool_info = vk::CommandPoolCreateInfo().setQueueFamilyIndex(graphics_queue_family_index);
1568 auto result = device.createCommandPool(&cmd_pool_info, nullptr, &cmd_pool);
1569 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001570
Dave Houlton5fa47912018-02-16 11:02:26 -07001571 auto const cmd = vk::CommandBufferAllocateInfo()
1572 .setCommandPool(cmd_pool)
1573 .setLevel(vk::CommandBufferLevel::ePrimary)
1574 .setCommandBufferCount(1);
1575
1576 result = device.allocateCommandBuffers(&cmd, &this->cmd);
1577 VERIFY(result == vk::Result::eSuccess);
1578
1579 auto const cmd_buf_info = vk::CommandBufferBeginInfo().setPInheritanceInfo(nullptr);
1580
1581 result = this->cmd.begin(&cmd_buf_info);
1582 VERIFY(result == vk::Result::eSuccess);
1583
1584 prepare_buffers();
1585 prepare_depth();
1586 prepare_textures();
1587 prepare_cube_data_buffers();
1588
1589 prepare_descriptor_layout();
1590 prepare_render_pass();
1591 prepare_pipeline();
1592
1593 for (uint32_t i = 0; i < swapchainImageCount; ++i) {
1594 result = device.allocateCommandBuffers(&cmd, &swapchain_image_resources[i].cmd);
1595 VERIFY(result == vk::Result::eSuccess);
1596 }
1597
1598 if (separate_present_queue) {
1599 auto const present_cmd_pool_info = vk::CommandPoolCreateInfo().setQueueFamilyIndex(present_queue_family_index);
1600
1601 result = device.createCommandPool(&present_cmd_pool_info, nullptr, &present_cmd_pool);
1602 VERIFY(result == vk::Result::eSuccess);
1603
1604 auto const present_cmd = vk::CommandBufferAllocateInfo()
1605 .setCommandPool(present_cmd_pool)
1606 .setLevel(vk::CommandBufferLevel::ePrimary)
1607 .setCommandBufferCount(1);
1608
1609 for (uint32_t i = 0; i < swapchainImageCount; i++) {
1610 result = device.allocateCommandBuffers(&present_cmd, &swapchain_image_resources[i].graphics_to_present_cmd);
1611 VERIFY(result == vk::Result::eSuccess);
1612
1613 build_image_ownership_cmd(i);
1614 }
1615 }
1616
1617 prepare_descriptor_pool();
1618 prepare_descriptor_set();
1619
1620 prepare_framebuffers();
1621
1622 for (uint32_t i = 0; i < swapchainImageCount; ++i) {
1623 current_buffer = i;
1624 draw_build_cmd(swapchain_image_resources[i].cmd);
1625 }
1626
1627 /*
1628 * Prepare functions above may generate pipeline commands
1629 * that need to be flushed before beginning the render loop.
1630 */
1631 flush_init_cmd();
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001632 if (staging_texture.buffer) {
1633 destroy_texture(&staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07001634 }
1635
1636 current_buffer = 0;
1637 prepared = true;
1638}
1639
1640void Demo::prepare_buffers() {
1641 vk::SwapchainKHR oldSwapchain = swapchain;
1642
1643 // Check the surface capabilities and formats
1644 vk::SurfaceCapabilitiesKHR surfCapabilities;
1645 auto result = gpu.getSurfaceCapabilitiesKHR(surface, &surfCapabilities);
1646 VERIFY(result == vk::Result::eSuccess);
1647
1648 uint32_t presentModeCount;
Mike Schuchardt7510c832018-10-29 13:23:08 -07001649 result = gpu.getSurfacePresentModesKHR(surface, &presentModeCount, static_cast<vk::PresentModeKHR *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001650 VERIFY(result == vk::Result::eSuccess);
1651
1652 std::unique_ptr<vk::PresentModeKHR[]> presentModes(new vk::PresentModeKHR[presentModeCount]);
1653 result = gpu.getSurfacePresentModesKHR(surface, &presentModeCount, presentModes.get());
1654 VERIFY(result == vk::Result::eSuccess);
1655
1656 vk::Extent2D swapchainExtent;
1657 // width and height are either both -1, or both not -1.
1658 if (surfCapabilities.currentExtent.width == (uint32_t)-1) {
1659 // If the surface size is undefined, the size is set to
1660 // the size of the images requested.
1661 swapchainExtent.width = width;
1662 swapchainExtent.height = height;
1663 } else {
1664 // If the surface size is defined, the swap chain size must match
1665 swapchainExtent = surfCapabilities.currentExtent;
1666 width = surfCapabilities.currentExtent.width;
1667 height = surfCapabilities.currentExtent.height;
1668 }
1669
1670 // The FIFO present mode is guaranteed by the spec to be supported
1671 // and to have no tearing. It's a great default present mode to use.
1672 vk::PresentModeKHR swapchainPresentMode = vk::PresentModeKHR::eFifo;
1673
1674 // There are times when you may wish to use another present mode. The
1675 // following code shows how to select them, and the comments provide some
1676 // reasons you may wish to use them.
1677 //
1678 // It should be noted that Vulkan 1.0 doesn't provide a method for
1679 // synchronizing rendering with the presentation engine's display. There
1680 // is a method provided for throttling rendering with the display, but
1681 // there are some presentation engines for which this method will not work.
1682 // If an application doesn't throttle its rendering, and if it renders much
1683 // faster than the refresh rate of the display, this can waste power on
1684 // mobile devices. That is because power is being spent rendering images
1685 // that may never be seen.
1686
1687 // VK_PRESENT_MODE_IMMEDIATE_KHR is for applications that don't care
1688 // about
1689 // tearing, or have some way of synchronizing their rendering with the
1690 // display.
1691 // VK_PRESENT_MODE_MAILBOX_KHR may be useful for applications that
1692 // generally render a new presentable image every refresh cycle, but are
1693 // occasionally early. In this case, the application wants the new
1694 // image
1695 // to be displayed instead of the previously-queued-for-presentation
1696 // image
1697 // that has not yet been displayed.
1698 // VK_PRESENT_MODE_FIFO_RELAXED_KHR is for applications that generally
1699 // render a new presentable image every refresh cycle, but are
1700 // occasionally
1701 // late. In this case (perhaps because of stuttering/latency concerns),
1702 // the application wants the late image to be immediately displayed,
1703 // even
1704 // though that may mean some tearing.
1705
1706 if (presentMode != swapchainPresentMode) {
1707 for (size_t i = 0; i < presentModeCount; ++i) {
1708 if (presentModes[i] == presentMode) {
1709 swapchainPresentMode = presentMode;
1710 break;
1711 }
1712 }
1713 }
1714
1715 if (swapchainPresentMode != presentMode) {
1716 ERR_EXIT("Present mode specified is not supported\n", "Present mode unsupported");
1717 }
1718
1719 // Determine the number of VkImages to use in the swap chain.
1720 // Application desires to acquire 3 images at a time for triple
1721 // buffering
1722 uint32_t desiredNumOfSwapchainImages = 3;
1723 if (desiredNumOfSwapchainImages < surfCapabilities.minImageCount) {
1724 desiredNumOfSwapchainImages = surfCapabilities.minImageCount;
1725 }
1726
1727 // If maxImageCount is 0, we can ask for as many images as we want,
1728 // otherwise
1729 // we're limited to maxImageCount
1730 if ((surfCapabilities.maxImageCount > 0) && (desiredNumOfSwapchainImages > surfCapabilities.maxImageCount)) {
1731 // Application must settle for fewer images than desired:
1732 desiredNumOfSwapchainImages = surfCapabilities.maxImageCount;
1733 }
1734
1735 vk::SurfaceTransformFlagBitsKHR preTransform;
1736 if (surfCapabilities.supportedTransforms & vk::SurfaceTransformFlagBitsKHR::eIdentity) {
1737 preTransform = vk::SurfaceTransformFlagBitsKHR::eIdentity;
1738 } else {
1739 preTransform = surfCapabilities.currentTransform;
1740 }
1741
1742 // Find a supported composite alpha mode - one of these is guaranteed to be set
1743 vk::CompositeAlphaFlagBitsKHR compositeAlpha = vk::CompositeAlphaFlagBitsKHR::eOpaque;
1744 vk::CompositeAlphaFlagBitsKHR compositeAlphaFlags[4] = {
1745 vk::CompositeAlphaFlagBitsKHR::eOpaque,
1746 vk::CompositeAlphaFlagBitsKHR::ePreMultiplied,
1747 vk::CompositeAlphaFlagBitsKHR::ePostMultiplied,
1748 vk::CompositeAlphaFlagBitsKHR::eInherit,
1749 };
1750 for (uint32_t i = 0; i < ARRAY_SIZE(compositeAlphaFlags); i++) {
1751 if (surfCapabilities.supportedCompositeAlpha & compositeAlphaFlags[i]) {
1752 compositeAlpha = compositeAlphaFlags[i];
1753 break;
1754 }
1755 }
1756
1757 auto const swapchain_ci = vk::SwapchainCreateInfoKHR()
1758 .setSurface(surface)
1759 .setMinImageCount(desiredNumOfSwapchainImages)
1760 .setImageFormat(format)
1761 .setImageColorSpace(color_space)
1762 .setImageExtent({swapchainExtent.width, swapchainExtent.height})
1763 .setImageArrayLayers(1)
1764 .setImageUsage(vk::ImageUsageFlagBits::eColorAttachment)
1765 .setImageSharingMode(vk::SharingMode::eExclusive)
1766 .setQueueFamilyIndexCount(0)
1767 .setPQueueFamilyIndices(nullptr)
1768 .setPreTransform(preTransform)
1769 .setCompositeAlpha(compositeAlpha)
1770 .setPresentMode(swapchainPresentMode)
1771 .setClipped(true)
1772 .setOldSwapchain(oldSwapchain);
1773
1774 result = device.createSwapchainKHR(&swapchain_ci, nullptr, &swapchain);
1775 VERIFY(result == vk::Result::eSuccess);
1776
1777 // If we just re-created an existing swapchain, we should destroy the
1778 // old
1779 // swapchain at this point.
1780 // Note: destroying the swapchain also cleans up all its associated
1781 // presentable images once the platform is done with them.
1782 if (oldSwapchain) {
1783 device.destroySwapchainKHR(oldSwapchain, nullptr);
1784 }
1785
Mike Schuchardt7510c832018-10-29 13:23:08 -07001786 result = device.getSwapchainImagesKHR(swapchain, &swapchainImageCount, static_cast<vk::Image *>(nullptr));
Dave Houlton5fa47912018-02-16 11:02:26 -07001787 VERIFY(result == vk::Result::eSuccess);
1788
1789 std::unique_ptr<vk::Image[]> swapchainImages(new vk::Image[swapchainImageCount]);
1790 result = device.getSwapchainImagesKHR(swapchain, &swapchainImageCount, swapchainImages.get());
1791 VERIFY(result == vk::Result::eSuccess);
1792
1793 swapchain_image_resources.reset(new SwapchainImageResources[swapchainImageCount]);
1794
1795 for (uint32_t i = 0; i < swapchainImageCount; ++i) {
1796 auto color_image_view = vk::ImageViewCreateInfo()
1797 .setViewType(vk::ImageViewType::e2D)
1798 .setFormat(format)
1799 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
1800
1801 swapchain_image_resources[i].image = swapchainImages[i];
1802
1803 color_image_view.image = swapchain_image_resources[i].image;
1804
1805 result = device.createImageView(&color_image_view, nullptr, &swapchain_image_resources[i].view);
1806 VERIFY(result == vk::Result::eSuccess);
1807 }
1808}
1809
1810void Demo::prepare_cube_data_buffers() {
1811 mat4x4 VP;
1812 mat4x4_mul(VP, projection_matrix, view_matrix);
1813
1814 mat4x4 MVP;
1815 mat4x4_mul(MVP, VP, model_matrix);
1816
1817 vktexcube_vs_uniform data;
1818 memcpy(data.mvp, MVP, sizeof(MVP));
1819 // dumpMatrix("MVP", MVP)
1820
1821 for (int32_t i = 0; i < 12 * 3; i++) {
1822 data.position[i][0] = g_vertex_buffer_data[i * 3];
1823 data.position[i][1] = g_vertex_buffer_data[i * 3 + 1];
1824 data.position[i][2] = g_vertex_buffer_data[i * 3 + 2];
1825 data.position[i][3] = 1.0f;
1826 data.attr[i][0] = g_uv_buffer_data[2 * i];
1827 data.attr[i][1] = g_uv_buffer_data[2 * i + 1];
1828 data.attr[i][2] = 0;
1829 data.attr[i][3] = 0;
1830 }
1831
1832 auto const buf_info = vk::BufferCreateInfo().setSize(sizeof(data)).setUsage(vk::BufferUsageFlagBits::eUniformBuffer);
1833
1834 for (unsigned int i = 0; i < swapchainImageCount; i++) {
1835 auto result = device.createBuffer(&buf_info, nullptr, &swapchain_image_resources[i].uniform_buffer);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001836 VERIFY(result == vk::Result::eSuccess);
1837
1838 vk::MemoryRequirements mem_reqs;
Dave Houlton5fa47912018-02-16 11:02:26 -07001839 device.getBufferMemoryRequirements(swapchain_image_resources[i].uniform_buffer, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001840
Dave Houlton5fa47912018-02-16 11:02:26 -07001841 auto mem_alloc = vk::MemoryAllocateInfo().setAllocationSize(mem_reqs.size).setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001842
Dave Houlton5fa47912018-02-16 11:02:26 -07001843 bool const pass = memory_type_from_properties(
1844 mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent,
1845 &mem_alloc.memoryTypeIndex);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001846 VERIFY(pass);
1847
Dave Houlton5fa47912018-02-16 11:02:26 -07001848 result = device.allocateMemory(&mem_alloc, nullptr, &swapchain_image_resources[i].uniform_memory);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001849 VERIFY(result == vk::Result::eSuccess);
1850
Tony-LunarG37af49f2019-12-19 12:04:19 -07001851 result = device.mapMemory(swapchain_image_resources[i].uniform_memory, 0, VK_WHOLE_SIZE, vk::MemoryMapFlags(),
1852 &swapchain_image_resources[i].uniform_memory_ptr);
1853 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001854
Tony-LunarG37af49f2019-12-19 12:04:19 -07001855 memcpy(swapchain_image_resources[i].uniform_memory_ptr, &data, sizeof data);
Dave Houlton5fa47912018-02-16 11:02:26 -07001856
1857 result =
1858 device.bindBufferMemory(swapchain_image_resources[i].uniform_buffer, swapchain_image_resources[i].uniform_memory, 0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001859 VERIFY(result == vk::Result::eSuccess);
1860 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001861}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001862
Dave Houlton5fa47912018-02-16 11:02:26 -07001863void Demo::prepare_depth() {
1864 depth.format = vk::Format::eD16Unorm;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001865
Dave Houlton5fa47912018-02-16 11:02:26 -07001866 auto const image = vk::ImageCreateInfo()
1867 .setImageType(vk::ImageType::e2D)
1868 .setFormat(depth.format)
1869 .setExtent({(uint32_t)width, (uint32_t)height, 1})
1870 .setMipLevels(1)
1871 .setArrayLayers(1)
1872 .setSamples(vk::SampleCountFlagBits::e1)
1873 .setTiling(vk::ImageTiling::eOptimal)
1874 .setUsage(vk::ImageUsageFlagBits::eDepthStencilAttachment)
1875 .setSharingMode(vk::SharingMode::eExclusive)
1876 .setQueueFamilyIndexCount(0)
1877 .setPQueueFamilyIndices(nullptr)
1878 .setInitialLayout(vk::ImageLayout::eUndefined);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001879
Dave Houlton5fa47912018-02-16 11:02:26 -07001880 auto result = device.createImage(&image, nullptr, &depth.image);
1881 VERIFY(result == vk::Result::eSuccess);
1882
1883 vk::MemoryRequirements mem_reqs;
1884 device.getImageMemoryRequirements(depth.image, &mem_reqs);
1885
1886 depth.mem_alloc.setAllocationSize(mem_reqs.size);
1887 depth.mem_alloc.setMemoryTypeIndex(0);
1888
1889 auto const pass = memory_type_from_properties(mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eDeviceLocal,
1890 &depth.mem_alloc.memoryTypeIndex);
1891 VERIFY(pass);
1892
1893 result = device.allocateMemory(&depth.mem_alloc, nullptr, &depth.mem);
1894 VERIFY(result == vk::Result::eSuccess);
1895
1896 result = device.bindImageMemory(depth.image, depth.mem, 0);
1897 VERIFY(result == vk::Result::eSuccess);
1898
1899 auto const view = vk::ImageViewCreateInfo()
1900 .setImage(depth.image)
1901 .setViewType(vk::ImageViewType::e2D)
1902 .setFormat(depth.format)
1903 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eDepth, 0, 1, 0, 1));
1904 result = device.createImageView(&view, nullptr, &depth.view);
1905 VERIFY(result == vk::Result::eSuccess);
1906}
1907
1908void Demo::prepare_descriptor_layout() {
1909 vk::DescriptorSetLayoutBinding const layout_bindings[2] = {vk::DescriptorSetLayoutBinding()
1910 .setBinding(0)
1911 .setDescriptorType(vk::DescriptorType::eUniformBuffer)
1912 .setDescriptorCount(1)
1913 .setStageFlags(vk::ShaderStageFlagBits::eVertex)
1914 .setPImmutableSamplers(nullptr),
1915 vk::DescriptorSetLayoutBinding()
1916 .setBinding(1)
1917 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1918 .setDescriptorCount(texture_count)
1919 .setStageFlags(vk::ShaderStageFlagBits::eFragment)
1920 .setPImmutableSamplers(nullptr)};
1921
1922 auto const descriptor_layout = vk::DescriptorSetLayoutCreateInfo().setBindingCount(2).setPBindings(layout_bindings);
1923
1924 auto result = device.createDescriptorSetLayout(&descriptor_layout, nullptr, &desc_layout);
1925 VERIFY(result == vk::Result::eSuccess);
1926
1927 auto const pPipelineLayoutCreateInfo = vk::PipelineLayoutCreateInfo().setSetLayoutCount(1).setPSetLayouts(&desc_layout);
1928
1929 result = device.createPipelineLayout(&pPipelineLayoutCreateInfo, nullptr, &pipeline_layout);
1930 VERIFY(result == vk::Result::eSuccess);
1931}
1932
1933void Demo::prepare_descriptor_pool() {
1934 vk::DescriptorPoolSize const poolSizes[2] = {
1935 vk::DescriptorPoolSize().setType(vk::DescriptorType::eUniformBuffer).setDescriptorCount(swapchainImageCount),
1936 vk::DescriptorPoolSize()
1937 .setType(vk::DescriptorType::eCombinedImageSampler)
1938 .setDescriptorCount(swapchainImageCount * texture_count)};
1939
1940 auto const descriptor_pool =
1941 vk::DescriptorPoolCreateInfo().setMaxSets(swapchainImageCount).setPoolSizeCount(2).setPPoolSizes(poolSizes);
1942
1943 auto result = device.createDescriptorPool(&descriptor_pool, nullptr, &desc_pool);
1944 VERIFY(result == vk::Result::eSuccess);
1945}
1946
1947void Demo::prepare_descriptor_set() {
1948 auto const alloc_info =
1949 vk::DescriptorSetAllocateInfo().setDescriptorPool(desc_pool).setDescriptorSetCount(1).setPSetLayouts(&desc_layout);
1950
1951 auto buffer_info = vk::DescriptorBufferInfo().setOffset(0).setRange(sizeof(struct vktexcube_vs_uniform));
1952
1953 vk::DescriptorImageInfo tex_descs[texture_count];
1954 for (uint32_t i = 0; i < texture_count; i++) {
1955 tex_descs[i].setSampler(textures[i].sampler);
1956 tex_descs[i].setImageView(textures[i].view);
Karl Schultze88bc842018-09-11 16:23:14 -06001957 tex_descs[i].setImageLayout(vk::ImageLayout::eShaderReadOnlyOptimal);
Dave Houlton5fa47912018-02-16 11:02:26 -07001958 }
1959
1960 vk::WriteDescriptorSet writes[2];
1961
1962 writes[0].setDescriptorCount(1);
1963 writes[0].setDescriptorType(vk::DescriptorType::eUniformBuffer);
1964 writes[0].setPBufferInfo(&buffer_info);
1965
1966 writes[1].setDstBinding(1);
1967 writes[1].setDescriptorCount(texture_count);
1968 writes[1].setDescriptorType(vk::DescriptorType::eCombinedImageSampler);
1969 writes[1].setPImageInfo(tex_descs);
1970
1971 for (unsigned int i = 0; i < swapchainImageCount; i++) {
1972 auto result = device.allocateDescriptorSets(&alloc_info, &swapchain_image_resources[i].descriptor_set);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001973 VERIFY(result == vk::Result::eSuccess);
1974
Dave Houlton5fa47912018-02-16 11:02:26 -07001975 buffer_info.setBuffer(swapchain_image_resources[i].uniform_buffer);
1976 writes[0].setDstSet(swapchain_image_resources[i].descriptor_set);
1977 writes[1].setDstSet(swapchain_image_resources[i].descriptor_set);
1978 device.updateDescriptorSets(2, writes, 0, nullptr);
1979 }
1980}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001981
Dave Houlton5fa47912018-02-16 11:02:26 -07001982void Demo::prepare_framebuffers() {
1983 vk::ImageView attachments[2];
1984 attachments[1] = depth.view;
1985
1986 auto const fb_info = vk::FramebufferCreateInfo()
1987 .setRenderPass(render_pass)
1988 .setAttachmentCount(2)
1989 .setPAttachments(attachments)
1990 .setWidth((uint32_t)width)
1991 .setHeight((uint32_t)height)
1992 .setLayers(1);
1993
1994 for (uint32_t i = 0; i < swapchainImageCount; i++) {
1995 attachments[0] = swapchain_image_resources[i].view;
1996 auto const result = device.createFramebuffer(&fb_info, nullptr, &swapchain_image_resources[i].framebuffer);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001997 VERIFY(result == vk::Result::eSuccess);
1998 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001999}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002000
Dave Houlton5fa47912018-02-16 11:02:26 -07002001vk::ShaderModule Demo::prepare_fs() {
2002 const uint32_t fragShaderCode[] = {
Petr Kraus9a4eb6a2017-11-30 14:49:20 +01002003#include "cube.frag.inc"
Dave Houlton5fa47912018-02-16 11:02:26 -07002004 };
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002005
Dave Houlton5fa47912018-02-16 11:02:26 -07002006 frag_shader_module = prepare_shader_module(fragShaderCode, sizeof(fragShaderCode));
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002007
Dave Houlton5fa47912018-02-16 11:02:26 -07002008 return frag_shader_module;
2009}
2010
2011void Demo::prepare_pipeline() {
2012 vk::PipelineCacheCreateInfo const pipelineCacheInfo;
2013 auto result = device.createPipelineCache(&pipelineCacheInfo, nullptr, &pipelineCache);
2014 VERIFY(result == vk::Result::eSuccess);
2015
2016 vk::PipelineShaderStageCreateInfo const shaderStageInfo[2] = {
2017 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eVertex).setModule(prepare_vs()).setPName("main"),
2018 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eFragment).setModule(prepare_fs()).setPName("main")};
2019
2020 vk::PipelineVertexInputStateCreateInfo const vertexInputInfo;
2021
2022 auto const inputAssemblyInfo = vk::PipelineInputAssemblyStateCreateInfo().setTopology(vk::PrimitiveTopology::eTriangleList);
2023
2024 // TODO: Where are pViewports and pScissors set?
2025 auto const viewportInfo = vk::PipelineViewportStateCreateInfo().setViewportCount(1).setScissorCount(1);
2026
2027 auto const rasterizationInfo = vk::PipelineRasterizationStateCreateInfo()
2028 .setDepthClampEnable(VK_FALSE)
2029 .setRasterizerDiscardEnable(VK_FALSE)
2030 .setPolygonMode(vk::PolygonMode::eFill)
2031 .setCullMode(vk::CullModeFlagBits::eBack)
2032 .setFrontFace(vk::FrontFace::eCounterClockwise)
2033 .setDepthBiasEnable(VK_FALSE)
2034 .setLineWidth(1.0f);
2035
2036 auto const multisampleInfo = vk::PipelineMultisampleStateCreateInfo();
2037
2038 auto const stencilOp =
2039 vk::StencilOpState().setFailOp(vk::StencilOp::eKeep).setPassOp(vk::StencilOp::eKeep).setCompareOp(vk::CompareOp::eAlways);
2040
2041 auto const depthStencilInfo = vk::PipelineDepthStencilStateCreateInfo()
2042 .setDepthTestEnable(VK_TRUE)
2043 .setDepthWriteEnable(VK_TRUE)
2044 .setDepthCompareOp(vk::CompareOp::eLessOrEqual)
2045 .setDepthBoundsTestEnable(VK_FALSE)
2046 .setStencilTestEnable(VK_FALSE)
2047 .setFront(stencilOp)
2048 .setBack(stencilOp);
2049
2050 vk::PipelineColorBlendAttachmentState const colorBlendAttachments[1] = {
2051 vk::PipelineColorBlendAttachmentState().setColorWriteMask(vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG |
2052 vk::ColorComponentFlagBits::eB | vk::ColorComponentFlagBits::eA)};
2053
2054 auto const colorBlendInfo =
2055 vk::PipelineColorBlendStateCreateInfo().setAttachmentCount(1).setPAttachments(colorBlendAttachments);
2056
2057 vk::DynamicState const dynamicStates[2] = {vk::DynamicState::eViewport, vk::DynamicState::eScissor};
2058
2059 auto const dynamicStateInfo = vk::PipelineDynamicStateCreateInfo().setPDynamicStates(dynamicStates).setDynamicStateCount(2);
2060
2061 auto const pipeline = vk::GraphicsPipelineCreateInfo()
2062 .setStageCount(2)
2063 .setPStages(shaderStageInfo)
2064 .setPVertexInputState(&vertexInputInfo)
2065 .setPInputAssemblyState(&inputAssemblyInfo)
2066 .setPViewportState(&viewportInfo)
2067 .setPRasterizationState(&rasterizationInfo)
2068 .setPMultisampleState(&multisampleInfo)
2069 .setPDepthStencilState(&depthStencilInfo)
2070 .setPColorBlendState(&colorBlendInfo)
2071 .setPDynamicState(&dynamicStateInfo)
2072 .setLayout(pipeline_layout)
2073 .setRenderPass(render_pass);
2074
2075 result = device.createGraphicsPipelines(pipelineCache, 1, &pipeline, nullptr, &this->pipeline);
2076 VERIFY(result == vk::Result::eSuccess);
2077
2078 device.destroyShaderModule(frag_shader_module, nullptr);
2079 device.destroyShaderModule(vert_shader_module, nullptr);
2080}
2081
2082void Demo::prepare_render_pass() {
2083 // The initial layout for the color and depth attachments will be LAYOUT_UNDEFINED
2084 // because at the start of the renderpass, we don't care about their contents.
2085 // At the start of the subpass, the color attachment's layout will be transitioned
2086 // to LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth stencil attachment's layout
2087 // will be transitioned to LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL. At the end of
2088 // the renderpass, the color attachment's layout will be transitioned to
2089 // LAYOUT_PRESENT_SRC_KHR to be ready to present. This is all done as part of
2090 // the renderpass, no barriers are necessary.
2091 const vk::AttachmentDescription attachments[2] = {vk::AttachmentDescription()
2092 .setFormat(format)
2093 .setSamples(vk::SampleCountFlagBits::e1)
2094 .setLoadOp(vk::AttachmentLoadOp::eClear)
2095 .setStoreOp(vk::AttachmentStoreOp::eStore)
2096 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2097 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2098 .setInitialLayout(vk::ImageLayout::eUndefined)
2099 .setFinalLayout(vk::ImageLayout::ePresentSrcKHR),
2100 vk::AttachmentDescription()
2101 .setFormat(depth.format)
2102 .setSamples(vk::SampleCountFlagBits::e1)
2103 .setLoadOp(vk::AttachmentLoadOp::eClear)
2104 .setStoreOp(vk::AttachmentStoreOp::eDontCare)
2105 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2106 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2107 .setInitialLayout(vk::ImageLayout::eUndefined)
2108 .setFinalLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal)};
2109
2110 auto const color_reference = vk::AttachmentReference().setAttachment(0).setLayout(vk::ImageLayout::eColorAttachmentOptimal);
2111
2112 auto const depth_reference =
2113 vk::AttachmentReference().setAttachment(1).setLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal);
2114
2115 auto const subpass = vk::SubpassDescription()
2116 .setPipelineBindPoint(vk::PipelineBindPoint::eGraphics)
2117 .setInputAttachmentCount(0)
2118 .setPInputAttachments(nullptr)
2119 .setColorAttachmentCount(1)
2120 .setPColorAttachments(&color_reference)
2121 .setPResolveAttachments(nullptr)
2122 .setPDepthStencilAttachment(&depth_reference)
2123 .setPreserveAttachmentCount(0)
2124 .setPPreserveAttachments(nullptr);
2125
Tony-LunarG495604b2019-06-13 15:32:05 -06002126 vk::PipelineStageFlags stages = vk::PipelineStageFlagBits::eEarlyFragmentTests | vk::PipelineStageFlagBits::eLateFragmentTests;
2127 vk::SubpassDependency const dependencies[2] = {
2128 vk::SubpassDependency() // Depth buffer is shared between swapchain images
2129 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2130 .setDstSubpass(0)
2131 .setSrcStageMask(stages)
2132 .setDstStageMask(stages)
2133 .setSrcAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2134 .setDstAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentRead | vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2135 .setDependencyFlags(vk::DependencyFlags()),
2136 vk::SubpassDependency() // Image layout transition
2137 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2138 .setDstSubpass(0)
2139 .setSrcStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2140 .setDstStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2141 .setSrcAccessMask(vk::AccessFlagBits())
2142 .setDstAccessMask(vk::AccessFlagBits::eColorAttachmentWrite | vk::AccessFlagBits::eColorAttachmentRead)
2143 .setDependencyFlags(vk::DependencyFlags()),
2144 };
2145
Dave Houlton5fa47912018-02-16 11:02:26 -07002146 auto const rp_info = vk::RenderPassCreateInfo()
2147 .setAttachmentCount(2)
2148 .setPAttachments(attachments)
2149 .setSubpassCount(1)
2150 .setPSubpasses(&subpass)
Tony-LunarG495604b2019-06-13 15:32:05 -06002151 .setDependencyCount(2)
2152 .setPDependencies(dependencies);
Dave Houlton5fa47912018-02-16 11:02:26 -07002153
2154 auto result = device.createRenderPass(&rp_info, nullptr, &render_pass);
2155 VERIFY(result == vk::Result::eSuccess);
2156}
2157
2158vk::ShaderModule Demo::prepare_shader_module(const uint32_t *code, size_t size) {
2159 const auto moduleCreateInfo = vk::ShaderModuleCreateInfo().setCodeSize(size).setPCode(code);
2160
2161 vk::ShaderModule module;
2162 auto result = device.createShaderModule(&moduleCreateInfo, nullptr, &module);
2163 VERIFY(result == vk::Result::eSuccess);
2164
2165 return module;
2166}
2167
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002168void Demo::prepare_texture_buffer(const char *filename, texture_object *tex_obj) {
2169 int32_t tex_width;
2170 int32_t tex_height;
2171
2172 if (!loadTexture(filename, NULL, NULL, &tex_width, &tex_height)) {
2173 ERR_EXIT("Failed to load textures", "Load Texture Failure");
2174 }
2175
2176 tex_obj->tex_width = tex_width;
2177 tex_obj->tex_height = tex_height;
2178
2179 auto const buffer_create_info = vk::BufferCreateInfo()
2180 .setSize(tex_width * tex_height * 4)
2181 .setUsage(vk::BufferUsageFlagBits::eTransferSrc)
2182 .setSharingMode(vk::SharingMode::eExclusive)
2183 .setQueueFamilyIndexCount(0)
2184 .setPQueueFamilyIndices(nullptr);
2185
2186 auto result = device.createBuffer(&buffer_create_info, nullptr, &tex_obj->buffer);
2187 VERIFY(result == vk::Result::eSuccess);
2188
2189 vk::MemoryRequirements mem_reqs;
2190 device.getBufferMemoryRequirements(tex_obj->buffer, &mem_reqs);
2191
2192 tex_obj->mem_alloc.setAllocationSize(mem_reqs.size);
2193 tex_obj->mem_alloc.setMemoryTypeIndex(0);
2194
2195 vk::MemoryPropertyFlags requirements = vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent;
2196 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, requirements, &tex_obj->mem_alloc.memoryTypeIndex);
2197 VERIFY(pass == true);
2198
2199 result = device.allocateMemory(&tex_obj->mem_alloc, nullptr, &(tex_obj->mem));
2200 VERIFY(result == vk::Result::eSuccess);
2201
2202 result = device.bindBufferMemory(tex_obj->buffer, tex_obj->mem, 0);
2203 VERIFY(result == vk::Result::eSuccess);
2204
2205 vk::SubresourceLayout layout;
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002206 layout.rowPitch = tex_width * 4;
2207 auto data = device.mapMemory(tex_obj->mem, 0, tex_obj->mem_alloc.allocationSize);
2208 VERIFY(data.result == vk::Result::eSuccess);
2209
2210 if (!loadTexture(filename, (uint8_t *)data.value, &layout, &tex_width, &tex_height)) {
2211 fprintf(stderr, "Error loading texture: %s\n", filename);
2212 }
2213
2214 device.unmapMemory(tex_obj->mem);
2215}
2216
Dave Houlton5fa47912018-02-16 11:02:26 -07002217void Demo::prepare_texture_image(const char *filename, texture_object *tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
2218 vk::MemoryPropertyFlags required_props) {
2219 int32_t tex_width;
2220 int32_t tex_height;
2221 if (!loadTexture(filename, nullptr, nullptr, &tex_width, &tex_height)) {
2222 ERR_EXIT("Failed to load textures", "Load Texture Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002223 }
2224
Dave Houlton5fa47912018-02-16 11:02:26 -07002225 tex_obj->tex_width = tex_width;
2226 tex_obj->tex_height = tex_height;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002227
Dave Houlton5fa47912018-02-16 11:02:26 -07002228 auto const image_create_info = vk::ImageCreateInfo()
2229 .setImageType(vk::ImageType::e2D)
2230 .setFormat(vk::Format::eR8G8B8A8Unorm)
2231 .setExtent({(uint32_t)tex_width, (uint32_t)tex_height, 1})
2232 .setMipLevels(1)
2233 .setArrayLayers(1)
2234 .setSamples(vk::SampleCountFlagBits::e1)
2235 .setTiling(tiling)
2236 .setUsage(usage)
2237 .setSharingMode(vk::SharingMode::eExclusive)
2238 .setQueueFamilyIndexCount(0)
2239 .setPQueueFamilyIndices(nullptr)
2240 .setInitialLayout(vk::ImageLayout::ePreinitialized);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002241
Dave Houlton5fa47912018-02-16 11:02:26 -07002242 auto result = device.createImage(&image_create_info, nullptr, &tex_obj->image);
2243 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002244
Dave Houlton5fa47912018-02-16 11:02:26 -07002245 vk::MemoryRequirements mem_reqs;
2246 device.getImageMemoryRequirements(tex_obj->image, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002247
Dave Houlton5fa47912018-02-16 11:02:26 -07002248 tex_obj->mem_alloc.setAllocationSize(mem_reqs.size);
2249 tex_obj->mem_alloc.setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002250
Dave Houlton5fa47912018-02-16 11:02:26 -07002251 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, required_props, &tex_obj->mem_alloc.memoryTypeIndex);
2252 VERIFY(pass == true);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002253
Dave Houlton5fa47912018-02-16 11:02:26 -07002254 result = device.allocateMemory(&tex_obj->mem_alloc, nullptr, &(tex_obj->mem));
2255 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002256
Dave Houlton5fa47912018-02-16 11:02:26 -07002257 result = device.bindImageMemory(tex_obj->image, tex_obj->mem, 0);
2258 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002259
Dave Houlton5fa47912018-02-16 11:02:26 -07002260 if (required_props & vk::MemoryPropertyFlagBits::eHostVisible) {
2261 auto const subres = vk::ImageSubresource().setAspectMask(vk::ImageAspectFlagBits::eColor).setMipLevel(0).setArrayLayer(0);
2262 vk::SubresourceLayout layout;
2263 device.getImageSubresourceLayout(tex_obj->image, &subres, &layout);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002264
Dave Houlton5fa47912018-02-16 11:02:26 -07002265 auto data = device.mapMemory(tex_obj->mem, 0, tex_obj->mem_alloc.allocationSize);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002266 VERIFY(data.result == vk::Result::eSuccess);
2267
Dave Houlton5fa47912018-02-16 11:02:26 -07002268 if (!loadTexture(filename, (uint8_t *)data.value, &layout, &tex_width, &tex_height)) {
2269 fprintf(stderr, "Error loading texture: %s\n", filename);
2270 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002271
Dave Houlton5fa47912018-02-16 11:02:26 -07002272 device.unmapMemory(tex_obj->mem);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002273 }
2274
Dave Houlton5fa47912018-02-16 11:02:26 -07002275 tex_obj->imageLayout = vk::ImageLayout::eShaderReadOnlyOptimal;
2276}
2277
2278void Demo::prepare_textures() {
2279 vk::Format const tex_format = vk::Format::eR8G8B8A8Unorm;
2280 vk::FormatProperties props;
2281 gpu.getFormatProperties(tex_format, &props);
2282
2283 for (uint32_t i = 0; i < texture_count; i++) {
2284 if ((props.linearTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) && !use_staging_buffer) {
2285 /* Device can texture using linear textures */
2286 prepare_texture_image(tex_files[i], &textures[i], vk::ImageTiling::eLinear, vk::ImageUsageFlagBits::eSampled,
2287 vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent);
2288 // Nothing in the pipeline needs to be complete to start, and don't allow fragment
2289 // shader to run until layout transition completes
2290 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2291 textures[i].imageLayout, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2292 vk::PipelineStageFlagBits::eFragmentShader);
2293 staging_texture.image = vk::Image();
2294 } else if (props.optimalTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) {
2295 /* Must use staging buffer to copy linear texture to optimized */
2296
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002297 prepare_texture_buffer(tex_files[i], &staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07002298
2299 prepare_texture_image(tex_files[i], &textures[i], vk::ImageTiling::eOptimal,
2300 vk::ImageUsageFlagBits::eTransferDst | vk::ImageUsageFlagBits::eSampled,
2301 vk::MemoryPropertyFlagBits::eDeviceLocal);
2302
Dave Houlton5fa47912018-02-16 11:02:26 -07002303 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2304 vk::ImageLayout::eTransferDstOptimal, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2305 vk::PipelineStageFlagBits::eTransfer);
2306
2307 auto const subresource = vk::ImageSubresourceLayers()
2308 .setAspectMask(vk::ImageAspectFlagBits::eColor)
2309 .setMipLevel(0)
2310 .setBaseArrayLayer(0)
2311 .setLayerCount(1);
2312
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002313 auto const copy_region =
2314 vk::BufferImageCopy()
2315 .setBufferOffset(0)
2316 .setBufferRowLength(staging_texture.tex_width)
2317 .setBufferImageHeight(staging_texture.tex_height)
2318 .setImageSubresource(subresource)
2319 .setImageOffset({0, 0, 0})
2320 .setImageExtent({(uint32_t)staging_texture.tex_width, (uint32_t)staging_texture.tex_height, 1});
Dave Houlton5fa47912018-02-16 11:02:26 -07002321
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002322 cmd.copyBufferToImage(staging_texture.buffer, textures[i].image, vk::ImageLayout::eTransferDstOptimal, 1, &copy_region);
Dave Houlton5fa47912018-02-16 11:02:26 -07002323
2324 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::eTransferDstOptimal,
2325 textures[i].imageLayout, vk::AccessFlagBits::eTransferWrite, vk::PipelineStageFlagBits::eTransfer,
2326 vk::PipelineStageFlagBits::eFragmentShader);
2327 } else {
2328 assert(!"No support for R8G8B8A8_UNORM as texture image format");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002329 }
2330
Dave Houlton5fa47912018-02-16 11:02:26 -07002331 auto const samplerInfo = vk::SamplerCreateInfo()
2332 .setMagFilter(vk::Filter::eNearest)
2333 .setMinFilter(vk::Filter::eNearest)
2334 .setMipmapMode(vk::SamplerMipmapMode::eNearest)
2335 .setAddressModeU(vk::SamplerAddressMode::eClampToEdge)
2336 .setAddressModeV(vk::SamplerAddressMode::eClampToEdge)
2337 .setAddressModeW(vk::SamplerAddressMode::eClampToEdge)
2338 .setMipLodBias(0.0f)
2339 .setAnisotropyEnable(VK_FALSE)
2340 .setMaxAnisotropy(1)
2341 .setCompareEnable(VK_FALSE)
2342 .setCompareOp(vk::CompareOp::eNever)
2343 .setMinLod(0.0f)
2344 .setMaxLod(0.0f)
2345 .setBorderColor(vk::BorderColor::eFloatOpaqueWhite)
2346 .setUnnormalizedCoordinates(VK_FALSE);
2347
2348 auto result = device.createSampler(&samplerInfo, nullptr, &textures[i].sampler);
2349 VERIFY(result == vk::Result::eSuccess);
2350
2351 auto const viewInfo = vk::ImageViewCreateInfo()
2352 .setImage(textures[i].image)
2353 .setViewType(vk::ImageViewType::e2D)
2354 .setFormat(tex_format)
2355 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
2356
2357 result = device.createImageView(&viewInfo, nullptr, &textures[i].view);
2358 VERIFY(result == vk::Result::eSuccess);
2359 }
2360}
2361
2362vk::ShaderModule Demo::prepare_vs() {
2363 const uint32_t vertShaderCode[] = {
2364#include "cube.vert.inc"
2365 };
2366
2367 vert_shader_module = prepare_shader_module(vertShaderCode, sizeof(vertShaderCode));
2368
2369 return vert_shader_module;
2370}
2371
2372void Demo::resize() {
2373 uint32_t i;
2374
2375 // Don't react to resize until after first initialization.
2376 if (!prepared) {
2377 return;
2378 }
2379
2380 // In order to properly resize the window, we must re-create the
2381 // swapchain
2382 // AND redo the command buffers, etc.
2383 //
2384 // First, perform part of the cleanup() function:
2385 prepared = false;
2386 auto result = device.waitIdle();
2387 VERIFY(result == vk::Result::eSuccess);
2388
2389 for (i = 0; i < swapchainImageCount; i++) {
2390 device.destroyFramebuffer(swapchain_image_resources[i].framebuffer, nullptr);
2391 }
2392
2393 device.destroyDescriptorPool(desc_pool, nullptr);
2394
2395 device.destroyPipeline(pipeline, nullptr);
2396 device.destroyPipelineCache(pipelineCache, nullptr);
2397 device.destroyRenderPass(render_pass, nullptr);
2398 device.destroyPipelineLayout(pipeline_layout, nullptr);
2399 device.destroyDescriptorSetLayout(desc_layout, nullptr);
2400
2401 for (i = 0; i < texture_count; i++) {
2402 device.destroyImageView(textures[i].view, nullptr);
2403 device.destroyImage(textures[i].image, nullptr);
2404 device.freeMemory(textures[i].mem, nullptr);
2405 device.destroySampler(textures[i].sampler, nullptr);
2406 }
2407
2408 device.destroyImageView(depth.view, nullptr);
2409 device.destroyImage(depth.image, nullptr);
2410 device.freeMemory(depth.mem, nullptr);
2411
2412 for (i = 0; i < swapchainImageCount; i++) {
2413 device.destroyImageView(swapchain_image_resources[i].view, nullptr);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -07002414 device.freeCommandBuffers(cmd_pool, {swapchain_image_resources[i].cmd});
Dave Houlton5fa47912018-02-16 11:02:26 -07002415 device.destroyBuffer(swapchain_image_resources[i].uniform_buffer, nullptr);
Tony-LunarG37af49f2019-12-19 12:04:19 -07002416 device.unmapMemory(swapchain_image_resources[i].uniform_memory);
Dave Houlton5fa47912018-02-16 11:02:26 -07002417 device.freeMemory(swapchain_image_resources[i].uniform_memory, nullptr);
2418 }
2419
2420 device.destroyCommandPool(cmd_pool, nullptr);
2421 if (separate_present_queue) {
2422 device.destroyCommandPool(present_cmd_pool, nullptr);
2423 }
2424
2425 // Second, re-perform the prepare() function, which will re-create the
2426 // swapchain.
2427 prepare();
2428}
2429
2430void Demo::set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
2431 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages) {
2432 assert(cmd);
2433
2434 auto DstAccessMask = [](vk::ImageLayout const &layout) {
2435 vk::AccessFlags flags;
2436
2437 switch (layout) {
2438 case vk::ImageLayout::eTransferDstOptimal:
2439 // Make sure anything that was copying from this image has
2440 // completed
2441 flags = vk::AccessFlagBits::eTransferWrite;
2442 break;
2443 case vk::ImageLayout::eColorAttachmentOptimal:
2444 flags = vk::AccessFlagBits::eColorAttachmentWrite;
2445 break;
2446 case vk::ImageLayout::eDepthStencilAttachmentOptimal:
2447 flags = vk::AccessFlagBits::eDepthStencilAttachmentWrite;
2448 break;
2449 case vk::ImageLayout::eShaderReadOnlyOptimal:
2450 // Make sure any Copy or CPU writes to image are flushed
2451 flags = vk::AccessFlagBits::eShaderRead | vk::AccessFlagBits::eInputAttachmentRead;
2452 break;
2453 case vk::ImageLayout::eTransferSrcOptimal:
2454 flags = vk::AccessFlagBits::eTransferRead;
2455 break;
2456 case vk::ImageLayout::ePresentSrcKHR:
2457 flags = vk::AccessFlagBits::eMemoryRead;
2458 break;
2459 default:
2460 break;
2461 }
2462
2463 return flags;
2464 };
2465
2466 auto const barrier = vk::ImageMemoryBarrier()
2467 .setSrcAccessMask(srcAccessMask)
2468 .setDstAccessMask(DstAccessMask(newLayout))
2469 .setOldLayout(oldLayout)
2470 .setNewLayout(newLayout)
Tony-LunarGa141b962018-05-30 11:33:19 -06002471 .setSrcQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2472 .setDstQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
Dave Houlton5fa47912018-02-16 11:02:26 -07002473 .setImage(image)
2474 .setSubresourceRange(vk::ImageSubresourceRange(aspectMask, 0, 1, 0, 1));
2475
2476 cmd.pipelineBarrier(src_stages, dest_stages, vk::DependencyFlagBits(), 0, nullptr, 0, nullptr, 1, &barrier);
2477}
2478
2479void Demo::update_data_buffer() {
2480 mat4x4 VP;
2481 mat4x4_mul(VP, projection_matrix, view_matrix);
2482
2483 // Rotate around the Y axis
2484 mat4x4 Model;
2485 mat4x4_dup(Model, model_matrix);
Arman Uguray3ae08892021-05-25 00:07:24 -07002486 mat4x4_rotate_Y(model_matrix, Model, (float)degreesToRadians(spin_angle));
2487 mat4x4_orthonormalize(model_matrix, model_matrix);
Dave Houlton5fa47912018-02-16 11:02:26 -07002488
2489 mat4x4 MVP;
2490 mat4x4_mul(MVP, VP, model_matrix);
2491
Tony-LunarG37af49f2019-12-19 12:04:19 -07002492 memcpy(swapchain_image_resources[current_buffer].uniform_memory_ptr, (const void *)&MVP[0][0], sizeof(MVP));
Dave Houlton5fa47912018-02-16 11:02:26 -07002493}
2494
Karl Schultzb7940402018-05-29 13:09:22 -06002495/* Convert ppm image data from header file into RGBA texture image */
2496#include "lunarg.ppm.h"
Dave Houlton5fa47912018-02-16 11:02:26 -07002497bool Demo::loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout *layout, int32_t *width, int32_t *height) {
Karl Schultzb7940402018-05-29 13:09:22 -06002498 (void)filename;
2499 char *cPtr;
2500 cPtr = (char *)lunarg_ppm;
2501 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "P6\n", 3)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002502 return false;
2503 }
Karl Schultzb7940402018-05-29 13:09:22 -06002504 while (strncmp(cPtr++, "\n", 1))
2505 ;
2506 sscanf(cPtr, "%u %u", width, height);
2507 if (rgba_data == NULL) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002508 return true;
2509 }
Karl Schultzb7940402018-05-29 13:09:22 -06002510 while (strncmp(cPtr++, "\n", 1))
2511 ;
2512 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "255\n", 4)) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002513 return false;
2514 }
Karl Schultzb7940402018-05-29 13:09:22 -06002515 while (strncmp(cPtr++, "\n", 1))
2516 ;
Dave Houlton5fa47912018-02-16 11:02:26 -07002517 for (int y = 0; y < *height; y++) {
2518 uint8_t *rowPtr = rgba_data;
Dave Houlton5fa47912018-02-16 11:02:26 -07002519 for (int x = 0; x < *width; x++) {
Karl Schultzb7940402018-05-29 13:09:22 -06002520 memcpy(rowPtr, cPtr, 3);
Dave Houlton5fa47912018-02-16 11:02:26 -07002521 rowPtr[3] = 255; /* Alpha of 1 */
2522 rowPtr += 4;
Karl Schultzb7940402018-05-29 13:09:22 -06002523 cPtr += 3;
Dave Houlton5fa47912018-02-16 11:02:26 -07002524 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002525 rgba_data += layout->rowPitch;
2526 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002527 return true;
2528}
2529
2530bool Demo::memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t *typeIndex) {
2531 // Search memtypes to find first index with those properties
2532 for (uint32_t i = 0; i < VK_MAX_MEMORY_TYPES; i++) {
2533 if ((typeBits & 1) == 1) {
2534 // Type is available, does it match user properties?
2535 if ((memory_properties.memoryTypes[i].propertyFlags & requirements_mask) == requirements_mask) {
2536 *typeIndex = i;
2537 return true;
2538 }
2539 }
2540 typeBits >>= 1;
2541 }
2542
2543 // No memory types matched, return failure
2544 return false;
2545}
2546
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002547#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07002548void Demo::run() {
2549 if (!prepared) {
2550 return;
2551 }
2552
2553 draw();
2554 curFrame++;
2555
Petr Krausd88e4e52019-01-23 18:45:04 +01002556 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002557 PostQuitMessage(validation_error);
2558 }
2559}
2560
2561void Demo::create_window() {
2562 WNDCLASSEX win_class;
2563
2564 // Initialize the window class structure:
2565 win_class.cbSize = sizeof(WNDCLASSEX);
2566 win_class.style = CS_HREDRAW | CS_VREDRAW;
2567 win_class.lpfnWndProc = WndProc;
2568 win_class.cbClsExtra = 0;
2569 win_class.cbWndExtra = 0;
2570 win_class.hInstance = connection; // hInstance
2571 win_class.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
2572 win_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
2573 win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
2574 win_class.lpszMenuName = nullptr;
2575 win_class.lpszClassName = name;
2576 win_class.hIconSm = LoadIcon(nullptr, IDI_WINLOGO);
2577
2578 // Register window class:
2579 if (!RegisterClassEx(&win_class)) {
2580 // It didn't work, so try to give a useful error:
2581 printf("Unexpected error trying to start the application!\n");
2582 fflush(stdout);
2583 exit(1);
2584 }
2585
2586 // Create window with the registered class:
2587 RECT wr = {0, 0, static_cast<LONG>(width), static_cast<LONG>(height)};
2588 AdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
2589 window = CreateWindowEx(0,
2590 name, // class name
2591 name, // app name
2592 WS_OVERLAPPEDWINDOW | // window style
2593 WS_VISIBLE | WS_SYSMENU,
2594 100, 100, // x/y coords
2595 wr.right - wr.left, // width
2596 wr.bottom - wr.top, // height
2597 nullptr, // handle to parent
2598 nullptr, // handle to menu
2599 connection, // hInstance
2600 nullptr); // no extra parameters
2601
2602 if (!window) {
2603 // It didn't work, so try to give a useful error:
2604 printf("Cannot create a window in which to draw!\n");
2605 fflush(stdout);
2606 exit(1);
2607 }
2608
2609 // Window client area size must be at least 1 pixel high, to prevent
2610 // crash.
2611 minsize.x = GetSystemMetrics(SM_CXMINTRACK);
2612 minsize.y = GetSystemMetrics(SM_CYMINTRACK) + 1;
2613}
2614#elif defined(VK_USE_PLATFORM_XLIB_KHR)
2615
2616void Demo::create_xlib_window() {
2617 const char *display_envar = getenv("DISPLAY");
2618 if (display_envar == nullptr || display_envar[0] == '\0') {
2619 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
2620 fflush(stdout);
2621 exit(1);
2622 }
2623
2624 XInitThreads();
2625 display = XOpenDisplay(nullptr);
2626 long visualMask = VisualScreenMask;
2627 int numberOfVisuals;
2628 XVisualInfo vInfoTemplate = {};
2629 vInfoTemplate.screen = DefaultScreen(display);
2630 XVisualInfo *visualInfo = XGetVisualInfo(display, visualMask, &vInfoTemplate, &numberOfVisuals);
2631
2632 Colormap colormap = XCreateColormap(display, RootWindow(display, vInfoTemplate.screen), visualInfo->visual, AllocNone);
2633
2634 XSetWindowAttributes windowAttributes = {};
2635 windowAttributes.colormap = colormap;
2636 windowAttributes.background_pixel = 0xFFFFFFFF;
2637 windowAttributes.border_pixel = 0;
2638 windowAttributes.event_mask = KeyPressMask | KeyReleaseMask | StructureNotifyMask | ExposureMask;
2639
2640 xlib_window =
2641 XCreateWindow(display, RootWindow(display, vInfoTemplate.screen), 0, 0, width, height, 0, visualInfo->depth, InputOutput,
2642 visualInfo->visual, CWBackPixel | CWBorderPixel | CWEventMask | CWColormap, &windowAttributes);
2643
2644 XSelectInput(display, xlib_window, ExposureMask | KeyPressMask);
2645 XMapWindow(display, xlib_window);
2646 XFlush(display);
2647 xlib_wm_delete_window = XInternAtom(display, "WM_DELETE_WINDOW", False);
2648}
2649
2650void Demo::handle_xlib_event(const XEvent *event) {
2651 switch (event->type) {
2652 case ClientMessage:
2653 if ((Atom)event->xclient.data.l[0] == xlib_wm_delete_window) {
2654 quit = true;
2655 }
2656 break;
2657 case KeyPress:
2658 switch (event->xkey.keycode) {
2659 case 0x9: // Escape
2660 quit = true;
2661 break;
2662 case 0x71: // left arrow key
2663 spin_angle -= spin_increment;
2664 break;
2665 case 0x72: // right arrow key
2666 spin_angle += spin_increment;
2667 break;
2668 case 0x41: // space bar
2669 pause = !pause;
2670 break;
2671 }
2672 break;
2673 case ConfigureNotify:
2674 if (((int32_t)width != event->xconfigure.width) || ((int32_t)height != event->xconfigure.height)) {
2675 width = event->xconfigure.width;
2676 height = event->xconfigure.height;
2677 resize();
2678 }
2679 break;
2680 default:
2681 break;
2682 }
2683}
2684
2685void Demo::run_xlib() {
2686 while (!quit) {
2687 XEvent event;
2688
2689 if (pause) {
2690 XNextEvent(display, &event);
2691 handle_xlib_event(&event);
2692 }
2693 while (XPending(display) > 0) {
2694 XNextEvent(display, &event);
2695 handle_xlib_event(&event);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002696 }
2697
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002698 draw();
2699 curFrame++;
2700
Dave Houlton5fa47912018-02-16 11:02:26 -07002701 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2702 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002703 }
2704 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002705}
Tony Barbour153cb062016-12-07 13:43:36 -07002706#elif defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002707
Dave Houlton5fa47912018-02-16 11:02:26 -07002708void Demo::handle_xcb_event(const xcb_generic_event_t *event) {
2709 uint8_t event_code = event->response_type & 0x7f;
2710 switch (event_code) {
2711 case XCB_EXPOSE:
2712 // TODO: Resize window
2713 break;
2714 case XCB_CLIENT_MESSAGE:
2715 if ((*(xcb_client_message_event_t *)event).data.data32[0] == (*atom_wm_delete_window).atom) {
2716 quit = true;
2717 }
2718 break;
2719 case XCB_KEY_RELEASE: {
2720 const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002721
Dave Houlton5fa47912018-02-16 11:02:26 -07002722 switch (key->detail) {
2723 case 0x9: // Escape
2724 quit = true;
2725 break;
2726 case 0x71: // left arrow key
2727 spin_angle -= spin_increment;
2728 break;
2729 case 0x72: // right arrow key
2730 spin_angle += spin_increment;
2731 break;
2732 case 0x41: // space bar
2733 pause = !pause;
2734 break;
2735 }
2736 } break;
2737 case XCB_CONFIGURE_NOTIFY: {
2738 const xcb_configure_notify_event_t *cfg = (const xcb_configure_notify_event_t *)event;
2739 if ((width != cfg->width) || (height != cfg->height)) {
2740 width = cfg->width;
2741 height = cfg->height;
2742 resize();
2743 }
2744 } break;
2745 default:
2746 break;
2747 }
2748}
2749
2750void Demo::run_xcb() {
2751 xcb_flush(connection);
2752
2753 while (!quit) {
2754 xcb_generic_event_t *event;
2755
2756 if (pause) {
2757 event = xcb_wait_for_event(connection);
2758 } else {
2759 event = xcb_poll_for_event(connection);
2760 }
2761 while (event) {
2762 handle_xcb_event(event);
2763 free(event);
2764 event = xcb_poll_for_event(connection);
2765 }
2766
2767 draw();
2768 curFrame++;
2769 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2770 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002771 }
2772 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002773}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002774
Dave Houlton5fa47912018-02-16 11:02:26 -07002775void Demo::create_xcb_window() {
2776 uint32_t value_mask, value_list[32];
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002777
Dave Houlton5fa47912018-02-16 11:02:26 -07002778 xcb_window = xcb_generate_id(connection);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002779
Dave Houlton5fa47912018-02-16 11:02:26 -07002780 value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
2781 value_list[0] = screen->black_pixel;
2782 value_list[1] = XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002783
Dave Houlton5fa47912018-02-16 11:02:26 -07002784 xcb_create_window(connection, XCB_COPY_FROM_PARENT, xcb_window, screen->root, 0, 0, width, height, 0,
2785 XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
2786
2787 /* Magic code that will send notification when window is destroyed */
2788 xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
2789 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
2790
2791 xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
2792 atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
2793
2794 xcb_change_property(connection, XCB_PROP_MODE_REPLACE, xcb_window, (*reply).atom, 4, 32, 1, &(*atom_wm_delete_window).atom);
2795
2796 free(reply);
2797
2798 xcb_map_window(connection, xcb_window);
2799
2800 // Force the x/y coordinates to 100,100 results are identical in
2801 // consecutive
2802 // runs
2803 const uint32_t coords[] = {100, 100};
2804 xcb_configure_window(connection, xcb_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, coords);
2805}
2806#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2807
2808void Demo::run() {
2809 while (!quit) {
2810 if (pause) {
2811 wl_display_dispatch(display);
2812 } else {
2813 wl_display_dispatch_pending(display);
2814 update_data_buffer();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002815 draw();
2816 curFrame++;
Jeremy Hayes9d304782016-10-09 11:48:12 -06002817 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002818 quit = true;
2819 }
2820 }
2821 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002822}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002823
Manuel Stoecklac939332019-06-26 20:55:53 -04002824static void handle_surface_configure(void *data, xdg_surface *xdg_surface, uint32_t serial) {
2825 Demo *demo = (Demo *)data;
2826 xdg_surface_ack_configure(xdg_surface, serial);
2827 if (demo->xdg_surface_has_been_configured) {
2828 demo->resize();
2829 }
2830 demo->xdg_surface_has_been_configured = true;
2831}
2832
2833static const xdg_surface_listener surface_listener = {handle_surface_configure};
2834
2835static void handle_toplevel_configure(void *data, xdg_toplevel *xdg_toplevel, int32_t width, int32_t height,
2836 struct wl_array *states) {
2837 Demo *demo = (Demo *)data;
2838 /* zero values imply the program may choose its own size, so in that case
2839 * stay with the existing value (which on startup is the default) */
2840 if (width > 0) {
2841 demo->width = width;
2842 }
2843 if (height > 0) {
2844 demo->height = height;
2845 }
2846 // This will be followed by a surface configure
2847}
2848
2849static void handle_toplevel_close(void *data, xdg_toplevel *xdg_toplevel) {
2850 Demo *demo = (Demo *)data;
2851 demo->quit = true;
2852}
2853
2854static const xdg_toplevel_listener toplevel_listener = {handle_toplevel_configure, handle_toplevel_close};
2855
Dave Houlton5fa47912018-02-16 11:02:26 -07002856void Demo::create_window() {
Manuel Stoecklac939332019-06-26 20:55:53 -04002857 if (!wm_base) {
2858 printf("Compositor did not provide the standard protocol xdg-wm-base\n");
2859 fflush(stdout);
2860 exit(1);
2861 }
2862
Dave Houlton5fa47912018-02-16 11:02:26 -07002863 window = wl_compositor_create_surface(compositor);
2864 if (!window) {
2865 printf("Can not create wayland_surface from compositor!\n");
2866 fflush(stdout);
2867 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002868 }
2869
Manuel Stoecklac939332019-06-26 20:55:53 -04002870 window_surface = xdg_wm_base_get_xdg_surface(wm_base, window);
2871 if (!window_surface) {
2872 printf("Can not get xdg_surface from wayland_surface!\n");
Dave Houlton5fa47912018-02-16 11:02:26 -07002873 fflush(stdout);
2874 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002875 }
Manuel Stoecklac939332019-06-26 20:55:53 -04002876 window_toplevel = xdg_surface_get_toplevel(window_surface);
2877 if (!window_toplevel) {
2878 printf("Can not allocate xdg_toplevel for xdg_surface!\n");
2879 fflush(stdout);
2880 exit(1);
2881 }
2882 xdg_surface_add_listener(window_surface, &surface_listener, this);
2883 xdg_toplevel_add_listener(window_toplevel, &toplevel_listener, this);
2884 xdg_toplevel_set_title(window_toplevel, APP_SHORT_NAME);
2885 if (xdg_decoration_mgr) {
2886 // if supported, let the compositor render titlebars for us
2887 toplevel_decoration = zxdg_decoration_manager_v1_get_toplevel_decoration(xdg_decoration_mgr, window_toplevel);
2888 zxdg_toplevel_decoration_v1_set_mode(toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
2889 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002890
Manuel Stoecklac939332019-06-26 20:55:53 -04002891 wl_surface_commit(window);
Dave Houlton5fa47912018-02-16 11:02:26 -07002892}
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002893#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
2894
2895void Demo::handle_directfb_event(const DFBInputEvent *event) {
2896 if (event->type != DIET_KEYPRESS) return;
2897 switch (event->key_symbol) {
2898 case DIKS_ESCAPE: // Escape
2899 quit = true;
2900 break;
2901 case DIKS_CURSOR_LEFT: // left arrow key
2902 spin_angle -= spin_increment;
2903 break;
2904 case DIKS_CURSOR_RIGHT: // right arrow key
2905 spin_angle += spin_increment;
2906 break;
2907 case DIKS_SPACE: // space bar
2908 pause = !pause;
2909 break;
2910 default:
2911 break;
2912 }
2913}
2914
2915void Demo::run_directfb() {
2916 while (!quit) {
2917 DFBInputEvent event;
2918
2919 if (pause) {
2920 event_buffer->WaitForEvent(event_buffer);
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002921 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002922 } else {
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002923 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002924
2925 draw();
2926 curFrame++;
2927 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2928 quit = true;
2929 }
2930 }
2931 }
2932}
2933
2934void Demo::create_directfb_window() {
2935 DFBResult ret;
2936
2937 ret = DirectFBInit(NULL, NULL);
2938 if (ret) {
2939 printf("DirectFBInit failed to initialize DirectFB!\n");
2940 fflush(stdout);
2941 exit(1);
2942 }
2943
2944 ret = DirectFBCreate(&dfb);
2945 if (ret) {
2946 printf("DirectFBCreate failed to create main interface of DirectFB!\n");
2947 fflush(stdout);
2948 exit(1);
2949 }
2950
2951 DFBSurfaceDescription desc;
2952 desc.flags = (DFBSurfaceDescriptionFlags)(DSDESC_CAPS | DSDESC_WIDTH | DSDESC_HEIGHT);
2953 desc.caps = DSCAPS_PRIMARY;
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002954 desc.width = width;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002955 desc.height = height;
2956 ret = dfb->CreateSurface(dfb, &desc, &window);
2957 if (ret) {
2958 printf("CreateSurface failed to create DirectFB surface interface!\n");
2959 fflush(stdout);
2960 exit(1);
2961 }
2962
2963 ret = dfb->CreateInputEventBuffer(dfb, DICAPS_KEYS, DFB_FALSE, &event_buffer);
2964 if (ret) {
2965 printf("CreateInputEventBuffer failed to create DirectFB event buffer interface!\n");
2966 fflush(stdout);
2967 exit(1);
2968 }
2969}
Bill Hollings0a0625a2019-07-15 17:39:18 -04002970#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -06002971void Demo::run() {
2972 draw();
2973 curFrame++;
2974 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2975 quit = true;
2976 }
2977}
Damien Leone600c3052017-01-31 10:26:07 -07002978#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2979
Dave Houlton5fa47912018-02-16 11:02:26 -07002980vk::Result Demo::create_display_surface() {
2981 vk::Result result;
2982 uint32_t display_count;
2983 uint32_t mode_count;
2984 uint32_t plane_count;
2985 vk::DisplayPropertiesKHR display_props;
2986 vk::DisplayKHR display;
2987 vk::DisplayModePropertiesKHR mode_props;
2988 vk::DisplayPlanePropertiesKHR *plane_props;
2989 vk::Bool32 found_plane = VK_FALSE;
2990 uint32_t plane_index;
2991 vk::Extent2D image_extent;
Damien Leone600c3052017-01-31 10:26:07 -07002992
Dave Houlton5fa47912018-02-16 11:02:26 -07002993 display_count = 1;
2994 result = gpu.getDisplayPropertiesKHR(&display_count, &display_props);
2995 VERIFY((result == vk::Result::eSuccess) || (result == vk::Result::eIncomplete));
2996
2997 display = display_props.display;
2998
2999 // Get the first mode of the display
3000 result = gpu.getDisplayModePropertiesKHR(display, &mode_count, nullptr);
3001 VERIFY(result == vk::Result::eSuccess);
3002
3003 if (mode_count == 0) {
3004 printf("Cannot find any mode for the display!\n");
3005 fflush(stdout);
3006 exit(1);
3007 }
3008
3009 mode_count = 1;
3010 result = gpu.getDisplayModePropertiesKHR(display, &mode_count, &mode_props);
3011 VERIFY((result == vk::Result::eSuccess) || (result == vk::Result::eIncomplete));
3012
3013 // Get the list of planes
3014 result = gpu.getDisplayPlanePropertiesKHR(&plane_count, nullptr);
3015 VERIFY(result == vk::Result::eSuccess);
3016
3017 if (plane_count == 0) {
3018 printf("Cannot find any plane!\n");
3019 fflush(stdout);
3020 exit(1);
3021 }
3022
3023 plane_props = (vk::DisplayPlanePropertiesKHR *)malloc(sizeof(vk::DisplayPlanePropertiesKHR) * plane_count);
3024 VERIFY(plane_props != nullptr);
3025
3026 result = gpu.getDisplayPlanePropertiesKHR(&plane_count, plane_props);
3027 VERIFY(result == vk::Result::eSuccess);
3028
3029 // Find a plane compatible with the display
3030 for (plane_index = 0; plane_index < plane_count; plane_index++) {
3031 uint32_t supported_count;
3032 vk::DisplayKHR *supported_displays;
3033
3034 // Disqualify planes that are bound to a different display
3035 if (plane_props[plane_index].currentDisplay && (plane_props[plane_index].currentDisplay != display)) {
3036 continue;
Damien Leone600c3052017-01-31 10:26:07 -07003037 }
3038
Dave Houlton5fa47912018-02-16 11:02:26 -07003039 result = gpu.getDisplayPlaneSupportedDisplaysKHR(plane_index, &supported_count, nullptr);
Damien Leone600c3052017-01-31 10:26:07 -07003040 VERIFY(result == vk::Result::eSuccess);
3041
Dave Houlton5fa47912018-02-16 11:02:26 -07003042 if (supported_count == 0) {
3043 continue;
Damien Leone600c3052017-01-31 10:26:07 -07003044 }
3045
Dave Houlton5fa47912018-02-16 11:02:26 -07003046 supported_displays = (vk::DisplayKHR *)malloc(sizeof(vk::DisplayKHR) * supported_count);
3047 VERIFY(supported_displays != nullptr);
Damien Leone600c3052017-01-31 10:26:07 -07003048
Dave Houlton5fa47912018-02-16 11:02:26 -07003049 result = gpu.getDisplayPlaneSupportedDisplaysKHR(plane_index, &supported_count, supported_displays);
Damien Leone600c3052017-01-31 10:26:07 -07003050 VERIFY(result == vk::Result::eSuccess);
3051
Dave Houlton5fa47912018-02-16 11:02:26 -07003052 for (uint32_t i = 0; i < supported_count; i++) {
3053 if (supported_displays[i] == display) {
3054 found_plane = VK_TRUE;
Damien Leone600c3052017-01-31 10:26:07 -07003055 break;
3056 }
3057 }
3058
Dave Houlton5fa47912018-02-16 11:02:26 -07003059 free(supported_displays);
Damien Leone600c3052017-01-31 10:26:07 -07003060
Dave Houlton5fa47912018-02-16 11:02:26 -07003061 if (found_plane) {
3062 break;
Damien Leone600c3052017-01-31 10:26:07 -07003063 }
3064 }
Dave Houlton5fa47912018-02-16 11:02:26 -07003065
3066 if (!found_plane) {
3067 printf("Cannot find a plane compatible with the display!\n");
3068 fflush(stdout);
3069 exit(1);
3070 }
3071
3072 free(plane_props);
3073
3074 vk::DisplayPlaneCapabilitiesKHR planeCaps;
3075 gpu.getDisplayPlaneCapabilitiesKHR(mode_props.displayMode, plane_index, &planeCaps);
3076 // Find a supported alpha mode
3077 vk::DisplayPlaneAlphaFlagBitsKHR alphaMode = vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque;
3078 vk::DisplayPlaneAlphaFlagBitsKHR alphaModes[4] = {
3079 vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque,
3080 vk::DisplayPlaneAlphaFlagBitsKHR::eGlobal,
3081 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixel,
3082 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixelPremultiplied,
3083 };
3084 for (uint32_t i = 0; i < sizeof(alphaModes); i++) {
3085 if (planeCaps.supportedAlpha & alphaModes[i]) {
3086 alphaMode = alphaModes[i];
3087 break;
3088 }
3089 }
3090
3091 image_extent.setWidth(mode_props.parameters.visibleRegion.width);
3092 image_extent.setHeight(mode_props.parameters.visibleRegion.height);
3093
3094 auto const createInfo = vk::DisplaySurfaceCreateInfoKHR()
3095 .setDisplayMode(mode_props.displayMode)
3096 .setPlaneIndex(plane_index)
3097 .setPlaneStackIndex(plane_props[plane_index].currentStackIndex)
3098 .setGlobalAlpha(1.0f)
3099 .setAlphaMode(alphaMode)
3100 .setImageExtent(image_extent);
3101
3102 return inst.createDisplayPlaneSurfaceKHR(&createInfo, nullptr, &surface);
3103}
3104
3105void Demo::run_display() {
3106 while (!quit) {
3107 draw();
3108 curFrame++;
3109
Petr Krausd88e4e52019-01-23 18:45:04 +01003110 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07003111 quit = true;
3112 }
3113 }
3114}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003115#endif
3116
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003117#if _WIN32
3118// Include header required for parsing the command line options.
3119#include <shellapi.h>
3120
3121Demo demo;
3122
3123// MS-Windows event handling function:
Jeremy Hayes9d304782016-10-09 11:48:12 -06003124LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
3125 switch (uMsg) {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003126 case WM_CLOSE:
3127 PostQuitMessage(validation_error);
3128 break;
3129 case WM_PAINT:
3130 demo.run();
3131 break;
3132 case WM_GETMINMAXINFO: // set window's minimum size
3133 ((MINMAXINFO *)lParam)->ptMinTrackSize = demo.minsize;
3134 return 0;
Aaron Hagan500b9c32018-10-03 21:56:29 -04003135 case WM_ERASEBKGND:
3136 return 1;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003137 case WM_SIZE:
3138 // Resize the application to the new window size, except when
3139 // it was minimized. Vulkan doesn't support images or swapchains
3140 // with width=0 and height=0.
3141 if (wParam != SIZE_MINIMIZED) {
3142 demo.width = lParam & 0xffff;
3143 demo.height = (lParam & 0xffff0000) >> 16;
3144 demo.resize();
3145 }
3146 break;
Petr Krausd88e4e52019-01-23 18:45:04 +01003147 case WM_KEYDOWN:
3148 switch (wParam) {
3149 case VK_ESCAPE:
3150 PostQuitMessage(validation_error);
3151 break;
3152 case VK_LEFT:
3153 demo.spin_angle -= demo.spin_increment;
3154 break;
3155 case VK_RIGHT:
3156 demo.spin_angle += demo.spin_increment;
3157 break;
3158 case VK_SPACE:
3159 demo.pause = !demo.pause;
3160 break;
3161 }
3162 return 0;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003163 default:
3164 break;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003165 }
3166
3167 return (DefWindowProc(hWnd, uMsg, wParam, lParam));
3168}
3169
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003170int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR pCmdLine, int nCmdShow) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003171 // TODO: Gah.. refactor. This isn't 1989.
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003172 MSG msg; // message
3173 bool done; // flag saying when app is complete
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003174 int argc;
3175 char **argv;
3176
Jamie Madillb2ff6502017-03-15 16:17:46 -04003177 // Ensure wParam is initialized.
3178 msg.wParam = 0;
3179
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003180 // Use the CommandLine functions to get the command line arguments.
3181 // Unfortunately, Microsoft outputs
3182 // this information as wide characters for Unicode, and we simply want the
3183 // Ascii version to be compatible
3184 // with the non-Windows side. So, we have to convert the information to
3185 // Ascii character strings.
3186 LPWSTR *commandLineArgs = CommandLineToArgvW(GetCommandLineW(), &argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003187 if (nullptr == commandLineArgs) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003188 argc = 0;
3189 }
3190
Jeremy Hayes9d304782016-10-09 11:48:12 -06003191 if (argc > 0) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003192 argv = (char **)malloc(sizeof(char *) * argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003193 if (argv == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003194 argc = 0;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003195 } else {
3196 for (int iii = 0; iii < argc; iii++) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003197 size_t wideCharLen = wcslen(commandLineArgs[iii]);
3198 size_t numConverted = 0;
3199
3200 argv[iii] = (char *)malloc(sizeof(char) * (wideCharLen + 1));
Jeremy Hayes9d304782016-10-09 11:48:12 -06003201 if (argv[iii] != nullptr) {
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003202 wcstombs_s(&numConverted, argv[iii], wideCharLen + 1, commandLineArgs[iii], wideCharLen + 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003203 }
3204 }
3205 }
Jeremy Hayes9d304782016-10-09 11:48:12 -06003206 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003207 argv = nullptr;
3208 }
3209
3210 demo.init(argc, argv);
3211
3212 // Free up the items we had to allocate for the command line arguments.
Jeremy Hayes9d304782016-10-09 11:48:12 -06003213 if (argc > 0 && argv != nullptr) {
3214 for (int iii = 0; iii < argc; iii++) {
3215 if (argv[iii] != nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003216 free(argv[iii]);
3217 }
3218 }
3219 free(argv);
3220 }
3221
3222 demo.connection = hInstance;
Lenny Komowffe446c2018-11-19 17:08:04 -07003223 strncpy(demo.name, "Vulkan Cube", APP_NAME_STR_LEN);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003224 demo.create_window();
3225 demo.init_vk_swapchain();
3226
3227 demo.prepare();
3228
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003229 done = false; // initialize loop condition variable
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003230
3231 // main message loop
Jeremy Hayes9d304782016-10-09 11:48:12 -06003232 while (!done) {
Petr Krausd88e4e52019-01-23 18:45:04 +01003233 if (demo.pause) {
3234 const BOOL succ = WaitMessage();
3235
3236 if (!succ) {
3237 const auto &suppress_popups = demo.suppress_popups;
3238 ERR_EXIT("WaitMessage() failed on paused demo", "event loop error");
3239 }
3240 }
3241
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003242 PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE);
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003243 if (msg.message == WM_QUIT) // check for a quit message
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003244 {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003245 done = true; // if found, quit app
Jeremy Hayes9d304782016-10-09 11:48:12 -06003246 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003247 /* Translate and dispatch to event queue*/
3248 TranslateMessage(&msg);
3249 DispatchMessage(&msg);
3250 }
3251 RedrawWindow(demo.window, nullptr, nullptr, RDW_INTERNALPAINT);
3252 }
3253
3254 demo.cleanup();
3255
3256 return (int)msg.wParam;
3257}
3258
3259#elif __linux__
3260
Jeremy Hayes9d304782016-10-09 11:48:12 -06003261int main(int argc, char **argv) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003262 Demo demo;
3263
3264 demo.init(argc, argv);
3265
Tony Barbour153cb062016-12-07 13:43:36 -07003266#if defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003267 demo.create_xcb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003268#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Tony Barbour78d6b572016-11-14 14:46:33 -07003269 demo.use_xlib = true;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003270 demo.create_xlib_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003271#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003272 demo.create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003273#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3274 demo.create_directfb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003275#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003276
3277 demo.init_vk_swapchain();
3278
3279 demo.prepare();
3280
Tony Barbour153cb062016-12-07 13:43:36 -07003281#if defined(VK_USE_PLATFORM_XCB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003282 demo.run_xcb();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003283#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003284 demo.run_xlib();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003285#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003286 demo.run();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003287#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3288 demo.run_directfb();
Damien Leone600c3052017-01-31 10:26:07 -07003289#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3290 demo.run_display();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003291#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003292
3293 demo.cleanup();
3294
3295 return validation_error;
3296}
3297
Bill Hollings0a0625a2019-07-15 17:39:18 -04003298#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05003299
3300// Global function invoked from NS or UI views and controllers to create demo
Bill Hollings0a0625a2019-07-15 17:39:18 -04003301static void demo_main(struct Demo &demo, void *caMetalLayer, int argc, const char *argv[]) {
Karl Schultz9ceac062017-12-12 10:33:01 -05003302 demo.init(argc, (char **)argv);
Bill Hollings0a0625a2019-07-15 17:39:18 -04003303 demo.caMetalLayer = caMetalLayer;
Karl Schultz9ceac062017-12-12 10:33:01 -05003304 demo.init_vk_swapchain();
3305 demo.prepare();
3306 demo.spin_angle = 0.4f;
3307}
3308
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003309#else
3310#error "Platform not supported"
3311#endif