blob: 6898b5633052392a423b7f15b185bdef1c2e8ad9 [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>
Charles Giessenc2f1a942022-02-06 23:38:39 -070035
Tony-LunarGd74734f2019-06-04 14:11:43 -060036#include <sstream>
Charles Giessenc2f1a942022-02-06 23:38:39 -070037#include <iostream>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060038#include <memory>
39
40#define VULKAN_HPP_NO_EXCEPTIONS
Shannon McPherson2abb6992019-04-05 10:46:16 -060041#define VULKAN_HPP_TYPESAFE_CONVERSION
Jeremy Hayesf56427a2016-09-07 15:55:11 -060042#include <vulkan/vulkan.hpp>
43#include <vulkan/vk_sdk_platform.h>
44
45#include "linmath.h"
46
47#ifndef NDEBUG
48#define VERIFY(x) assert(x)
49#else
50#define VERIFY(x) ((void)(x))
51#endif
52
Charles Giessen87dd88d2022-02-03 13:46:29 -070053#define APP_SHORT_NAME "vkcubepp"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060054
55// Allow a maximum of two outstanding presentation operations.
Charles Giessenc2f1a942022-02-06 23:38:39 -070056constexpr uint32_t FRAME_LAG = 2;
Jeremy Hayesf56427a2016-09-07 15:55:11 -060057
58#ifdef _WIN32
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070059#define ERR_EXIT(err_msg, err_class) \
60 do { \
61 if (!suppress_popups) MessageBox(nullptr, err_msg, err_class, MB_OK); \
62 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060063 } while (0)
64#else
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070065#define ERR_EXIT(err_msg, err_class) \
66 do { \
Robert Morell4ccc6522017-02-01 14:51:00 -080067 printf("%s\n", err_msg); \
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070068 fflush(stdout); \
69 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060070 } while (0)
71#endif
72
Jeremy Hayes9d304782016-10-09 11:48:12 -060073struct texture_object {
Jeremy Hayesf56427a2016-09-07 15:55:11 -060074 vk::Sampler sampler;
75
76 vk::Image image;
Tony-LunarGbc9fc052018-09-21 13:47:06 -060077 vk::Buffer buffer;
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -070078 vk::ImageLayout imageLayout{vk::ImageLayout::eUndefined};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060079
80 vk::MemoryAllocateInfo mem_alloc;
81 vk::DeviceMemory mem;
82 vk::ImageView view;
83
Charles Giessen3bcefe52022-02-21 11:57:16 -070084 uint32_t tex_width{0};
85 uint32_t tex_height{0};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060086};
87
Jeremy Hayes9d304782016-10-09 11:48:12 -060088static char const *const tex_files[] = {"lunarg.ppm"};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060089
90static int validation_error = 0;
91
Jeremy Hayesf56427a2016-09-07 15:55:11 -060092struct vktexcube_vs_uniform {
93 // Must start with MVP
94 float mvp[4][4];
95 float position[12 * 3][4];
96 float attr[12 * 3][4];
97};
98
99//--------------------------------------------------------------------------------------
100// Mesh and VertexFormat Data
101//--------------------------------------------------------------------------------------
102// clang-format off
103static const float g_vertex_buffer_data[] = {
104 -1.0f,-1.0f,-1.0f, // -X side
105 -1.0f,-1.0f, 1.0f,
106 -1.0f, 1.0f, 1.0f,
107 -1.0f, 1.0f, 1.0f,
108 -1.0f, 1.0f,-1.0f,
109 -1.0f,-1.0f,-1.0f,
110
111 -1.0f,-1.0f,-1.0f, // -Z side
112 1.0f, 1.0f,-1.0f,
113 1.0f,-1.0f,-1.0f,
114 -1.0f,-1.0f,-1.0f,
115 -1.0f, 1.0f,-1.0f,
116 1.0f, 1.0f,-1.0f,
117
118 -1.0f,-1.0f,-1.0f, // -Y side
119 1.0f,-1.0f,-1.0f,
120 1.0f,-1.0f, 1.0f,
121 -1.0f,-1.0f,-1.0f,
122 1.0f,-1.0f, 1.0f,
123 -1.0f,-1.0f, 1.0f,
124
125 -1.0f, 1.0f,-1.0f, // +Y side
126 -1.0f, 1.0f, 1.0f,
127 1.0f, 1.0f, 1.0f,
128 -1.0f, 1.0f,-1.0f,
129 1.0f, 1.0f, 1.0f,
130 1.0f, 1.0f,-1.0f,
131
132 1.0f, 1.0f,-1.0f, // +X side
133 1.0f, 1.0f, 1.0f,
134 1.0f,-1.0f, 1.0f,
135 1.0f,-1.0f, 1.0f,
136 1.0f,-1.0f,-1.0f,
137 1.0f, 1.0f,-1.0f,
138
139 -1.0f, 1.0f, 1.0f, // +Z side
140 -1.0f,-1.0f, 1.0f,
141 1.0f, 1.0f, 1.0f,
142 -1.0f,-1.0f, 1.0f,
143 1.0f,-1.0f, 1.0f,
144 1.0f, 1.0f, 1.0f,
145};
146
147static const float g_uv_buffer_data[] = {
148 0.0f, 1.0f, // -X side
149 1.0f, 1.0f,
150 1.0f, 0.0f,
151 1.0f, 0.0f,
152 0.0f, 0.0f,
153 0.0f, 1.0f,
154
155 1.0f, 1.0f, // -Z side
156 0.0f, 0.0f,
157 0.0f, 1.0f,
158 1.0f, 1.0f,
159 1.0f, 0.0f,
160 0.0f, 0.0f,
161
162 1.0f, 0.0f, // -Y side
163 1.0f, 1.0f,
164 0.0f, 1.0f,
165 1.0f, 0.0f,
166 0.0f, 1.0f,
167 0.0f, 0.0f,
168
169 1.0f, 0.0f, // +Y side
170 0.0f, 0.0f,
171 0.0f, 1.0f,
172 1.0f, 0.0f,
173 0.0f, 1.0f,
174 1.0f, 1.0f,
175
176 1.0f, 0.0f, // +X side
177 0.0f, 0.0f,
178 0.0f, 1.0f,
179 0.0f, 1.0f,
180 1.0f, 1.0f,
181 1.0f, 0.0f,
182
183 0.0f, 0.0f, // +Z side
184 0.0f, 1.0f,
185 1.0f, 0.0f,
186 0.0f, 1.0f,
187 1.0f, 1.0f,
188 1.0f, 0.0f,
189};
Jeremy Hayes9d304782016-10-09 11:48:12 -0600190// clang-format on
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600191
Charles Giessen87dd88d2022-02-03 13:46:29 -0700192struct SwapchainImageResources {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600193 vk::Image image;
194 vk::CommandBuffer cmd;
195 vk::CommandBuffer graphics_to_present_cmd;
196 vk::ImageView view;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600197 vk::Buffer uniform_buffer;
198 vk::DeviceMemory uniform_memory;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700199 void *uniform_memory_ptr = nullptr;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600200 vk::Framebuffer framebuffer;
201 vk::DescriptorSet descriptor_set;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700202};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600203
Joey Bzdekbaf66472017-06-07 09:37:37 -0600204struct Demo {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700205 void build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700206 vk::Bool32 check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600207 void cleanup();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700208 void destroy_swapchain_related_resources();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600209 void create_device();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700210 void destroy_texture(texture_object &tex_objs);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600211 void draw();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700212 void draw_build_cmd(const SwapchainImageResources &swapchain_image_resource);
213 void prepare_init_cmd();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600214 void flush_init_cmd();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700215 void init(int argc, char **argv);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600216 void init_connection();
217 void init_vk();
218 void init_vk_swapchain();
219 void prepare();
220 void prepare_buffers();
221 void prepare_cube_data_buffers();
222 void prepare_depth();
223 void prepare_descriptor_layout();
224 void prepare_descriptor_pool();
225 void prepare_descriptor_set();
226 void prepare_framebuffers();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700227 vk::ShaderModule prepare_shader_module(const uint32_t *code, size_t size);
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100228 vk::ShaderModule prepare_vs();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600229 vk::ShaderModule prepare_fs();
230 void prepare_pipeline();
231 void prepare_render_pass();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700232 void prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
233 vk::MemoryPropertyFlags required_props);
234 void prepare_texture_buffer(const char *filename, texture_object &tex_obj);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600235 void prepare_textures();
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100236
Joey Bzdekbaf66472017-06-07 09:37:37 -0600237 void resize();
Tony-LunarG6cebf142019-09-11 14:32:23 -0600238 void create_surface();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700239 void set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
240 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600241 void update_data_buffer();
Charles Giessen3bcefe52022-02-21 11:57:16 -0700242 bool loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout &layout, uint32_t &width, uint32_t &height);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700243 bool memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex);
Charles Giessen7dc2dd52022-02-03 13:55:48 -0700244 vk::SurfaceFormatKHR pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600245
246#if defined(VK_USE_PLATFORM_WIN32_KHR)
247 void run();
248 void create_window();
249#elif defined(VK_USE_PLATFORM_XLIB_KHR)
250 void create_xlib_window();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700251 void handle_xlib_event(const XEvent *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600252 void run_xlib();
253#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700254 void handle_xcb_event(const xcb_generic_event_t *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600255 void run_xcb();
256 void create_xcb_window();
257#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
258 void run();
259 void create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200260#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700261 void handle_directfb_event(const DFBInputEvent *event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200262 void run_directfb();
263 void create_directfb_window();
Bill Hollings0a0625a2019-07-15 17:39:18 -0400264#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -0600265 void run();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600266#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
267 vk::Result create_display_surface();
268 void run_display();
269#endif
270
Charles Giessenc2f1a942022-02-06 23:38:39 -0700271 std::string name = "vkcubepp"; // Name to put on the window/icon
Joey Bzdekbaf66472017-06-07 09:37:37 -0600272#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700273 HINSTANCE connection = nullptr; // hInstance - Windows Instance
274 HWND window = nullptr; // hWnd - window handle
275 POINT minsize = {0, 0}; // minimum window size
Joey Bzdekbaf66472017-06-07 09:37:37 -0600276#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700277 Window xlib_window = 0;
278 Atom xlib_wm_delete_window = 0;
279 Display *display = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600280#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700281 xcb_window_t xcb_window = 0;
282 xcb_screen_t *screen = nullptr;
283 xcb_connection_t *connection = nullptr;
284 xcb_intern_atom_reply_t *atom_wm_delete_window = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600285#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700286 wl_display *display = nullptr;
287 wl_registry *registry = nullptr;
288 wl_compositor *compositor = nullptr;
289 wl_surface *window = nullptr;
290 xdg_wm_base *wm_base = nullptr;
291 zxdg_decoration_manager_v1 *xdg_decoration_mgr = nullptr;
292 zxdg_toplevel_decoration_v1 *toplevel_decoration = nullptr;
293 xdg_surface *window_surface = nullptr;
294 bool xdg_surface_has_been_configured = false;
295 xdg_toplevel *window_toplevel = nullptr;
296 wl_seat *seat = nullptr;
297 wl_pointer *pointer = nullptr;
298 wl_keyboard *keyboard = nullptr;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200299#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700300 IDirectFB *dfb = nullptr;
301 IDirectFBSurface *window = nullptr;
302 IDirectFBEventBuffer *event_buffer = nullptr;
Bill Hollings0a0625a2019-07-15 17:39:18 -0400303#elif defined(VK_USE_PLATFORM_METAL_EXT)
304 void *caMetalLayer;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600305#endif
306
307 vk::SurfaceKHR surface;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700308 bool prepared = false;
309 bool use_staging_buffer = false;
310 bool use_xlib = false;
311 bool separate_present_queue = false;
312 int32_t gpu_number = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600313
314 vk::Instance inst;
315 vk::PhysicalDevice gpu;
316 vk::Device device;
317 vk::Queue graphics_queue;
318 vk::Queue present_queue;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700319 uint32_t graphics_queue_family_index = 0;
320 uint32_t present_queue_family_index = 0;
321 std::array<vk::Semaphore, FRAME_LAG> image_acquired_semaphores;
322 std::array<vk::Semaphore, FRAME_LAG> draw_complete_semaphores;
323 std::array<vk::Semaphore, FRAME_LAG> image_ownership_semaphores;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600324 vk::PhysicalDeviceProperties gpu_props;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700325 std::vector<vk::QueueFamilyProperties> queue_props;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600326 vk::PhysicalDeviceMemoryProperties memory_properties;
327
Charles Giessen87dd88d2022-02-03 13:46:29 -0700328 std::vector<const char *> enabled_instance_extensions;
329 std::vector<const char *> enabled_layers;
330 std::vector<const char *> enabled_device_extensions;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600331
Charles Giessen3bcefe52022-02-21 11:57:16 -0700332 uint32_t width = 0;
333 uint32_t height = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600334 vk::Format format;
335 vk::ColorSpaceKHR color_space;
336
Joey Bzdekbaf66472017-06-07 09:37:37 -0600337 vk::SwapchainKHR swapchain;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700338 std::vector<SwapchainImageResources> swapchain_image_resources;
339 vk::PresentModeKHR presentMode = vk::PresentModeKHR::eFifo;
340 std::array<vk::Fence, FRAME_LAG> fences;
341 uint32_t frame_index = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600342
343 vk::CommandPool cmd_pool;
344 vk::CommandPool present_cmd_pool;
345
346 struct {
347 vk::Format format;
348 vk::Image image;
349 vk::MemoryAllocateInfo mem_alloc;
350 vk::DeviceMemory mem;
351 vk::ImageView view;
352 } depth;
353
354 static int32_t const texture_count = 1;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700355 std::array<texture_object, texture_count> textures;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600356 texture_object staging_texture;
357
358 struct {
359 vk::Buffer buf;
360 vk::MemoryAllocateInfo mem_alloc;
361 vk::DeviceMemory mem;
362 vk::DescriptorBufferInfo buffer_info;
363 } uniform_data;
364
365 vk::CommandBuffer cmd; // Buffer for initialization commands
366 vk::PipelineLayout pipeline_layout;
367 vk::DescriptorSetLayout desc_layout;
368 vk::PipelineCache pipelineCache;
369 vk::RenderPass render_pass;
370 vk::Pipeline pipeline;
371
Charles Giessenc2f1a942022-02-06 23:38:39 -0700372 mat4x4 projection_matrix = {};
373 mat4x4 view_matrix = {};
374 mat4x4 model_matrix = {};
Joey Bzdekbaf66472017-06-07 09:37:37 -0600375
Charles Giessen87dd88d2022-02-03 13:46:29 -0700376 float spin_angle = 0.0f;
377 float spin_increment = 0.0f;
378 bool pause = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600379
380 vk::ShaderModule vert_shader_module;
381 vk::ShaderModule frag_shader_module;
382
383 vk::DescriptorPool desc_pool;
384 vk::DescriptorSet desc_set;
385
Charles Giessen87dd88d2022-02-03 13:46:29 -0700386 std::vector<vk::Framebuffer> framebuffers;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600387
Charles Giessen87dd88d2022-02-03 13:46:29 -0700388 bool quit = false;
389 uint32_t curFrame = 0;
390 uint32_t frameCount = 0;
391 bool validate = false;
392 bool use_break = false;
393 bool suppress_popups = false;
394 bool force_errors = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600395
Charles Giessen87dd88d2022-02-03 13:46:29 -0700396 uint32_t current_buffer = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600397};
398
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600399#ifdef _WIN32
400// MS-Windows event handling function:
401LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
402#endif
403
Karl Schultz23cc2182016-11-23 17:15:17 -0700404#if defined(VK_USE_PLATFORM_WAYLAND_KHR)
Joey Bzdek15eb0702017-06-07 09:40:36 -0600405static void pointer_handle_enter(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t sx,
406 wl_fixed_t sy) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700407
Joey Bzdek15eb0702017-06-07 09:40:36 -0600408static void pointer_handle_leave(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700409
Joey Bzdek15eb0702017-06-07 09:40:36 -0600410static void pointer_handle_motion(void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) {}
411
412static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button,
413 uint32_t state) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700414 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600415 if (button == BTN_LEFT && state == WL_POINTER_BUTTON_STATE_PRESSED) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700416 xdg_toplevel_move(demo.window_toplevel, demo.seat, serial);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600417 }
418}
419
420static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {}
421
422static const struct wl_pointer_listener pointer_listener = {
423 pointer_handle_enter, pointer_handle_leave, pointer_handle_motion, pointer_handle_button, pointer_handle_axis,
424};
425
426static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) {}
427
428static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface,
429 struct wl_array *keys) {}
430
431static void keyboard_handle_leave(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) {}
432
433static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key,
434 uint32_t state) {
435 if (state != WL_KEYBOARD_KEY_STATE_RELEASED) return;
Charles Giessen3bcefe52022-02-21 11:57:16 -0700436 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600437 switch (key) {
438 case KEY_ESC: // Escape
Charles Giessen3bcefe52022-02-21 11:57:16 -0700439 demo.quit = true;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600440 break;
441 case KEY_LEFT: // left arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700442 demo.spin_angle -= demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600443 break;
444 case KEY_RIGHT: // right arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700445 demo.spin_angle += demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600446 break;
447 case KEY_SPACE: // space bar
Charles Giessen3bcefe52022-02-21 11:57:16 -0700448 demo.pause = !demo.pause;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600449 break;
450 }
451}
452
453static void keyboard_handle_modifiers(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed,
454 uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {}
455
456static const struct wl_keyboard_listener keyboard_listener = {
457 keyboard_handle_keymap, keyboard_handle_enter, keyboard_handle_leave, keyboard_handle_key, keyboard_handle_modifiers,
458};
459
460static void seat_handle_capabilities(void *data, wl_seat *seat, uint32_t caps) {
461 // Subscribe to pointer events
Charles Giessen3bcefe52022-02-21 11:57:16 -0700462 Demo &demo = *static_cast<Demo *>(data);
463 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !demo.pointer) {
464 demo.pointer = wl_seat_get_pointer(seat);
465 wl_pointer_add_listener(demo.pointer, &pointer_listener, demo);
466 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && demo.pointer) {
467 wl_pointer_destroy(demo.pointer);
468 demo.pointer = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600469 }
470 // Subscribe to keyboard events
471 if (caps & WL_SEAT_CAPABILITY_KEYBOARD) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700472 demo.keyboard = wl_seat_get_keyboard(seat);
473 wl_keyboard_add_listener(demo.keyboard, &keyboard_listener, demo);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600474 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD)) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700475 wl_keyboard_destroy(demo.keyboard);
476 demo.keyboard = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600477 }
478}
479
480static const wl_seat_listener seat_listener = {
481 seat_handle_capabilities,
482};
483
Manuel Stoecklac939332019-06-26 20:55:53 -0400484static void wm_base_ping(void *data, xdg_wm_base *xdg_wm_base, uint32_t serial) { xdg_wm_base_pong(xdg_wm_base, serial); }
485
486static const struct xdg_wm_base_listener wm_base_listener = {wm_base_ping};
487
Joey Bzdek15eb0702017-06-07 09:40:36 -0600488static void registry_handle_global(void *data, wl_registry *registry, uint32_t id, const char *interface, uint32_t version) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700489 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600490 // pickup wayland objects when they appear
Manuel Stoecklac939332019-06-26 20:55:53 -0400491 if (strcmp(interface, wl_compositor_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700492 demo.compositor = (wl_compositor *)wl_registry_bind(registry, id, &wl_compositor_interface, 1);
Manuel Stoecklac939332019-06-26 20:55:53 -0400493 } else if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700494 demo.wm_base = (xdg_wm_base *)wl_registry_bind(registry, id, &xdg_wm_base_interface, 1);
495 xdg_wm_base_add_listener(demo.wm_base, &wm_base_listener, nullptr);
Manuel Stoecklac939332019-06-26 20:55:53 -0400496 } else if (strcmp(interface, wl_seat_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700497 demo.seat = (wl_seat *)wl_registry_bind(registry, id, &wl_seat_interface, 1);
498 wl_seat_add_listener(demo.seat, &seat_listener, demo);
Manuel Stoecklac939332019-06-26 20:55:53 -0400499 } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700500 demo.xdg_decoration_mgr =
Manuel Stoecklac939332019-06-26 20:55:53 -0400501 (zxdg_decoration_manager_v1 *)wl_registry_bind(registry, id, &zxdg_decoration_manager_v1_interface, 1);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600502 }
503}
504
505static void registry_handle_global_remove(void *data, wl_registry *registry, uint32_t name) {}
506
507static const wl_registry_listener registry_listener = {registry_handle_global, registry_handle_global_remove};
Karl Schultz23cc2182016-11-23 17:15:17 -0700508#endif
509
Charles Giessenc2f1a942022-02-06 23:38:39 -0700510void Demo::build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700511 auto result = swapchain_image_resource.graphics_to_present_cmd.begin(
512 vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700513 VERIFY(result == vk::Result::eSuccess);
514
515 auto const image_ownership_barrier =
516 vk::ImageMemoryBarrier()
517 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600518 .setDstAccessMask(vk::AccessFlags())
Dave Houlton5fa47912018-02-16 11:02:26 -0700519 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
520 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
521 .setSrcQueueFamilyIndex(graphics_queue_family_index)
522 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700523 .setImage(swapchain_image_resource.image)
Dave Houlton5fa47912018-02-16 11:02:26 -0700524 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
525
Charles Giessen87dd88d2022-02-03 13:46:29 -0700526 swapchain_image_resource.graphics_to_present_cmd.pipelineBarrier(vk::PipelineStageFlagBits::eBottomOfPipe,
527 vk::PipelineStageFlagBits::eBottomOfPipe,
528 vk::DependencyFlagBits(), {}, {}, image_ownership_barrier);
Dave Houlton5fa47912018-02-16 11:02:26 -0700529
Charles Giessen87dd88d2022-02-03 13:46:29 -0700530 result = swapchain_image_resource.graphics_to_present_cmd.end();
Dave Houlton5fa47912018-02-16 11:02:26 -0700531 VERIFY(result == vk::Result::eSuccess);
532}
533
Charles Giessen87dd88d2022-02-03 13:46:29 -0700534vk::Bool32 Demo::check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers) {
535 for (const auto &name : check_names) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700536 vk::Bool32 found = VK_FALSE;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700537 for (const auto &layer : layers) {
538 if (!strcmp(name, layer.layerName)) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700539 found = VK_TRUE;
540 break;
541 }
542 }
543 if (!found) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700544 fprintf(stderr, "Cannot find layer: %s\n", name);
Dave Houlton5fa47912018-02-16 11:02:26 -0700545 return 0;
546 }
547 }
548 return VK_TRUE;
549}
550
551void Demo::cleanup() {
552 prepared = false;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700553 auto result = device.waitIdle();
554 VERIFY(result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700555
Charles Giessen87dd88d2022-02-03 13:46:29 -0700556 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -0700557 // Wait for fences from present operations
558 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700559 device.destroyFence(fences[i]);
560 device.destroySemaphore(image_acquired_semaphores[i]);
561 device.destroySemaphore(draw_complete_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700562 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700563 device.destroySemaphore(image_ownership_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700564 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600565 }
566
Charles Giessen87dd88d2022-02-03 13:46:29 -0700567 device.destroySwapchainKHR(swapchain);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600568
Charles Giessen87dd88d2022-02-03 13:46:29 -0700569 device.destroy();
570 inst.destroySurfaceKHR(surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700571
572#if defined(VK_USE_PLATFORM_XLIB_KHR)
573 XDestroyWindow(display, xlib_window);
574 XCloseDisplay(display);
575#elif defined(VK_USE_PLATFORM_XCB_KHR)
576 xcb_destroy_window(connection, xcb_window);
577 xcb_disconnect(connection);
578 free(atom_wm_delete_window);
579#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
580 wl_keyboard_destroy(keyboard);
581 wl_pointer_destroy(pointer);
582 wl_seat_destroy(seat);
Manuel Stoecklac939332019-06-26 20:55:53 -0400583 xdg_toplevel_destroy(window_toplevel);
584 xdg_surface_destroy(window_surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700585 wl_surface_destroy(window);
Manuel Stoecklac939332019-06-26 20:55:53 -0400586 xdg_wm_base_destroy(wm_base);
587 if (xdg_decoration_mgr) {
588 zxdg_toplevel_decoration_v1_destroy(toplevel_decoration);
589 zxdg_decoration_manager_v1_destroy(xdg_decoration_mgr);
590 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700591 wl_compositor_destroy(compositor);
592 wl_registry_destroy(registry);
593 wl_display_disconnect(display);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200594#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
595 event_buffer->Release(event_buffer);
596 window->Release(window);
597 dfb->Release(dfb);
Dave Houlton5fa47912018-02-16 11:02:26 -0700598#endif
599
Charles Giessen87dd88d2022-02-03 13:46:29 -0700600 inst.destroy();
Dave Houlton5fa47912018-02-16 11:02:26 -0700601}
602
603void Demo::create_device() {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700604 float priorities = 0.0;
Dave Houlton5fa47912018-02-16 11:02:26 -0700605
Charles Giessen87dd88d2022-02-03 13:46:29 -0700606 std::vector<vk::DeviceQueueCreateInfo> queues;
607 queues.push_back(vk::DeviceQueueCreateInfo().setQueueFamilyIndex(graphics_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700608
609 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700610 queues.push_back(
611 vk::DeviceQueueCreateInfo().setQueueFamilyIndex(present_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700612 }
613
Charles Giessen87dd88d2022-02-03 13:46:29 -0700614 auto deviceInfo = vk::DeviceCreateInfo().setQueueCreateInfos(queues).setPEnabledExtensionNames(enabled_device_extensions);
615 auto device_return = gpu.createDevice(deviceInfo);
616 VERIFY(device_return.result == vk::Result::eSuccess);
617 device = device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -0700618}
619
Charles Giessen87dd88d2022-02-03 13:46:29 -0700620void Demo::destroy_texture(texture_object &tex_objs) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700621 // clean up staging resources
Charles Giessen87dd88d2022-02-03 13:46:29 -0700622 device.freeMemory(tex_objs.mem);
623 if (tex_objs.image) device.destroyImage(tex_objs.image);
624 if (tex_objs.buffer) device.destroyBuffer(tex_objs.buffer);
Dave Houlton5fa47912018-02-16 11:02:26 -0700625}
626
627void Demo::draw() {
628 // Ensure no more than FRAME_LAG renderings are outstanding
Charles Giessen87dd88d2022-02-03 13:46:29 -0700629 device.waitForFences(fences[frame_index], VK_TRUE, UINT64_MAX);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -0700630 device.resetFences({fences[frame_index]});
Dave Houlton5fa47912018-02-16 11:02:26 -0700631
Charles Giessenc2f1a942022-02-06 23:38:39 -0700632 vk::Result acquire_result;
Dave Houlton5fa47912018-02-16 11:02:26 -0700633 do {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700634 acquire_result =
Dave Houlton5fa47912018-02-16 11:02:26 -0700635 device.acquireNextImageKHR(swapchain, UINT64_MAX, image_acquired_semaphores[frame_index], vk::Fence(), &current_buffer);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700636 if (acquire_result == vk::Result::eErrorOutOfDateKHR) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700637 // demo.swapchain is out of date (e.g. the window was resized) and
Dave Houlton5fa47912018-02-16 11:02:26 -0700638 // must be recreated:
639 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700640 } else if (acquire_result == vk::Result::eSuboptimalKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700641 // swapchain is not as optimal as it could be, but the platform's
642 // presentation engine will still present the image correctly.
643 break;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700644 } else if (acquire_result == vk::Result::eErrorSurfaceLostKHR) {
645 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600646 create_surface();
647 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700648 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700649 VERIFY(acquire_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700650 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700651 } while (acquire_result != vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700652
653 update_data_buffer();
654
655 // Wait for the image acquired semaphore to be signaled to ensure
656 // that the image won't be rendered to until the presentation
657 // engine has fully released ownership to the application, and it is
658 // okay to render to the image.
659 vk::PipelineStageFlags const pipe_stage_flags = vk::PipelineStageFlagBits::eColorAttachmentOutput;
Dave Houlton5fa47912018-02-16 11:02:26 -0700660
Charles Giessen87dd88d2022-02-03 13:46:29 -0700661 auto submit_result = graphics_queue.submit(vk::SubmitInfo()
662 .setWaitDstStageMask(pipe_stage_flags)
663 .setWaitSemaphores(image_acquired_semaphores[frame_index])
664 .setCommandBuffers(swapchain_image_resources[current_buffer].cmd)
665 .setSignalSemaphores(draw_complete_semaphores[frame_index]),
666 fences[frame_index]);
667 VERIFY(submit_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700668
669 if (separate_present_queue) {
670 // If we are using separate queues, change image ownership to the
671 // present queue before presenting, waiting for the draw complete
672 // semaphore and signalling the ownership released semaphore when
673 // finished
Charles Giessen87dd88d2022-02-03 13:46:29 -0700674 auto change_owner_result =
675 present_queue.submit(vk::SubmitInfo()
676 .setWaitDstStageMask(pipe_stage_flags)
677 .setWaitSemaphores(draw_complete_semaphores[frame_index])
678 .setCommandBuffers(swapchain_image_resources[current_buffer].graphics_to_present_cmd)
679 .setSignalSemaphores(image_ownership_semaphores[frame_index]));
680 VERIFY(change_owner_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700681 }
682
683 // If we are using separate queues we have to wait for image ownership,
684 // otherwise wait for draw complete
Charles Giessen87dd88d2022-02-03 13:46:29 -0700685 auto present_result =
686 present_queue.presentKHR(vk::PresentInfoKHR()
687 .setWaitSemaphores(separate_present_queue ? image_ownership_semaphores[frame_index]
688 : draw_complete_semaphores[frame_index])
689 .setSwapchains(swapchain)
690 .setImageIndices(current_buffer));
Dave Houlton5fa47912018-02-16 11:02:26 -0700691 frame_index += 1;
692 frame_index %= FRAME_LAG;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700693 if (present_result == vk::Result::eErrorOutOfDateKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700694 // swapchain is out of date (e.g. the window was resized) and
695 // must be recreated:
696 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700697 } else if (present_result == vk::Result::eSuboptimalKHR) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600698 // SUBOPTIMAL could be due to resize
699 vk::SurfaceCapabilitiesKHR surfCapabilities;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700700 auto caps_result = gpu.getSurfaceCapabilitiesKHR(surface, &surfCapabilities);
701 VERIFY(caps_result == vk::Result::eSuccess);
Charles Giessen3bcefe52022-02-21 11:57:16 -0700702 if (surfCapabilities.currentExtent.width != width || surfCapabilities.currentExtent.height != height) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600703 resize();
704 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700705 } else if (present_result == vk::Result::eErrorSurfaceLostKHR) {
706 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600707 create_surface();
708 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700709 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700710 VERIFY(present_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700711 }
712}
713
Charles Giessen87dd88d2022-02-03 13:46:29 -0700714void Demo::draw_build_cmd(const SwapchainImageResources &swapchain_image_resource) {
715 const auto commandBuffer = swapchain_image_resource.cmd;
Dave Houlton5fa47912018-02-16 11:02:26 -0700716 vk::ClearValue const clearValues[2] = {vk::ClearColorValue(std::array<float, 4>({{0.2f, 0.2f, 0.2f, 0.2f}})),
717 vk::ClearDepthStencilValue(1.0f, 0u)};
718
Charles Giessen87dd88d2022-02-03 13:46:29 -0700719 auto result = commandBuffer.begin(vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700720 VERIFY(result == vk::Result::eSuccess);
721
Charles Giessen87dd88d2022-02-03 13:46:29 -0700722 commandBuffer.beginRenderPass(vk::RenderPassBeginInfo()
723 .setRenderPass(render_pass)
724 .setFramebuffer(swapchain_image_resource.framebuffer)
Charles Giessen3bcefe52022-02-21 11:57:16 -0700725 .setRenderArea(vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)))
Charles Giessen87dd88d2022-02-03 13:46:29 -0700726 .setClearValueCount(2)
727 .setPClearValues(clearValues),
728 vk::SubpassContents::eInline);
729
Dave Houlton5fa47912018-02-16 11:02:26 -0700730 commandBuffer.bindPipeline(vk::PipelineBindPoint::eGraphics, pipeline);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700731 commandBuffer.bindDescriptorSets(vk::PipelineBindPoint::eGraphics, pipeline_layout, 0, swapchain_image_resource.descriptor_set,
Charles Giessenc2f1a942022-02-06 23:38:39 -0700732 {});
Jeremy Kniager979b5312019-11-22 14:55:57 -0700733 float viewport_dimension;
734 float viewport_x = 0.0f;
735 float viewport_y = 0.0f;
736 if (width < height) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700737 viewport_dimension = static_cast<float>(width);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700738 viewport_y = (height - width) / 2.0f;
739 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700740 viewport_dimension = static_cast<float>(height);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700741 viewport_x = (width - height) / 2.0f;
742 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700743
Charles Giessen87dd88d2022-02-03 13:46:29 -0700744 commandBuffer.setViewport(0, vk::Viewport()
745 .setX(viewport_x)
746 .setY(viewport_y)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700747 .setWidth(viewport_dimension)
748 .setHeight(viewport_dimension)
749 .setMinDepth(0.0f)
750 .setMaxDepth(1.0f));
Charles Giessen87dd88d2022-02-03 13:46:29 -0700751
Charles Giessen3bcefe52022-02-21 11:57:16 -0700752 commandBuffer.setScissor(0, vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)));
Dave Houlton5fa47912018-02-16 11:02:26 -0700753 commandBuffer.draw(12 * 3, 1, 0, 0);
754 // Note that ending the renderpass changes the image's layout from
755 // COLOR_ATTACHMENT_OPTIMAL to PRESENT_SRC_KHR
756 commandBuffer.endRenderPass();
757
758 if (separate_present_queue) {
759 // We have to transfer ownership from the graphics queue family to
760 // the
761 // present queue family to be able to present. Note that we don't
762 // have
763 // to transfer from present queue family back to graphics queue
764 // family at
765 // the start of the next frame because we don't care about the
766 // image's
767 // contents at that point.
Charles Giessen87dd88d2022-02-03 13:46:29 -0700768 commandBuffer.pipelineBarrier(
769 vk::PipelineStageFlagBits::eBottomOfPipe, vk::PipelineStageFlagBits::eBottomOfPipe, vk::DependencyFlagBits(), {}, {},
Jeremy Hayes9d304782016-10-09 11:48:12 -0600770 vk::ImageMemoryBarrier()
771 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600772 .setDstAccessMask(vk::AccessFlags())
Jeremy Hayes9d304782016-10-09 11:48:12 -0600773 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
774 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
775 .setSrcQueueFamilyIndex(graphics_queue_family_index)
776 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700777 .setImage(swapchain_image_resource.image)
778 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1)));
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600779 }
780
Dave Houlton5fa47912018-02-16 11:02:26 -0700781 result = commandBuffer.end();
782 VERIFY(result == vk::Result::eSuccess);
783}
784
Charles Giessen87dd88d2022-02-03 13:46:29 -0700785void Demo::prepare_init_cmd() {
786 auto cmd_pool_return = device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(graphics_queue_family_index));
787 VERIFY(cmd_pool_return.result == vk::Result::eSuccess);
788 cmd_pool = cmd_pool_return.value;
789
790 auto cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
791 .setCommandPool(cmd_pool)
792 .setLevel(vk::CommandBufferLevel::ePrimary)
793 .setCommandBufferCount(1));
794 VERIFY(cmd_return.result == vk::Result::eSuccess);
795 cmd = cmd_return.value[0];
796
797 auto result = cmd.begin(vk::CommandBufferBeginInfo());
798 VERIFY(result == vk::Result::eSuccess);
799}
800
Dave Houlton5fa47912018-02-16 11:02:26 -0700801void Demo::flush_init_cmd() {
Dave Houlton5fa47912018-02-16 11:02:26 -0700802 auto result = cmd.end();
803 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600804
Mark Young43c08f82021-11-30 16:38:25 -0700805 auto fenceInfo = vk::FenceCreateInfo();
806 if (force_errors) {
807 // Remove sType to intentionally force validation layer errors.
808 fenceInfo.sType = vk::StructureType::eRenderPassBeginInfo;
809 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700810 auto fence_return = device.createFence(fenceInfo);
811 VERIFY(fence_return.result == vk::Result::eSuccess);
812 auto fence = fence_return.value;
813
814 result = graphics_queue.submit(vk::SubmitInfo().setCommandBuffers(cmd), fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700815 VERIFY(result == vk::Result::eSuccess);
816
Charles Giessen87dd88d2022-02-03 13:46:29 -0700817 result = device.waitForFences(fence, VK_TRUE, UINT64_MAX);
Dave Houlton5fa47912018-02-16 11:02:26 -0700818 VERIFY(result == vk::Result::eSuccess);
819
Charles Giessen87dd88d2022-02-03 13:46:29 -0700820 device.freeCommandBuffers(cmd_pool, cmd);
821 device.destroyFence(fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700822}
823
824void Demo::init(int argc, char **argv) {
825 vec3 eye = {0.0f, 3.0f, 5.0f};
826 vec3 origin = {0, 0, 0};
827 vec3 up = {0.0f, 1.0f, 0.0};
828
829 presentMode = vk::PresentModeKHR::eFifo;
830 frameCount = UINT32_MAX;
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100831 width = 500;
832 height = 500;
Dave Houlton5fa47912018-02-16 11:02:26 -0700833 use_xlib = false;
Witold Baryluka3b988f2021-01-07 19:03:02 +0000834 /* Autodetect suitable / best GPU by default */
835 gpu_number = -1;
Tony-LunarG6cebf142019-09-11 14:32:23 -0600836
Dave Houlton5fa47912018-02-16 11:02:26 -0700837 for (int i = 1; i < argc; i++) {
838 if (strcmp(argv[i], "--use_staging") == 0) {
839 use_staging_buffer = true;
840 continue;
841 }
842 if ((strcmp(argv[i], "--present_mode") == 0) && (i < argc - 1)) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700843 presentMode = static_cast<vk::PresentModeKHR>(atoi(argv[i + 1]));
Dave Houlton5fa47912018-02-16 11:02:26 -0700844 i++;
845 continue;
846 }
847 if (strcmp(argv[i], "--break") == 0) {
848 use_break = true;
849 continue;
850 }
851 if (strcmp(argv[i], "--validate") == 0) {
852 validate = true;
853 continue;
854 }
855 if (strcmp(argv[i], "--xlib") == 0) {
856 fprintf(stderr, "--xlib is deprecated and no longer does anything");
857 continue;
858 }
859 if (strcmp(argv[i], "--c") == 0 && frameCount == UINT32_MAX && i < argc - 1 &&
860 sscanf(argv[i + 1], "%" SCNu32, &frameCount) == 1) {
861 i++;
862 continue;
863 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700864 if (strcmp(argv[i], "--width") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &width) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100865 i++;
866 continue;
867 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700868 if (strcmp(argv[i], "--height") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &height) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100869 i++;
870 continue;
871 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700872 if (strcmp(argv[i], "--suppress_popups") == 0) {
873 suppress_popups = true;
874 continue;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600875 }
Tony-LunarG50e737c2020-07-16 14:26:03 -0600876 if ((strcmp(argv[i], "--gpu_number") == 0) && (i < argc - 1)) {
877 gpu_number = atoi(argv[i + 1]);
Witold Baryluka3b988f2021-01-07 19:03:02 +0000878 assert(gpu_number >= 0);
Tony-LunarG50e737c2020-07-16 14:26:03 -0600879 i++;
880 continue;
881 }
Mark Young43c08f82021-11-30 16:38:25 -0700882 if (strcmp(argv[i], "--force_errors") == 0) {
883 force_errors = true;
884 continue;
885 }
Tony-LunarGd74734f2019-06-04 14:11:43 -0600886 std::stringstream usage;
887 usage << "Usage:\n " << APP_SHORT_NAME << "\t[--use_staging] [--validate]\n"
888 << "\t[--break] [--c <framecount>] [--suppress_popups]\n"
Tony-LunarG50e737c2020-07-16 14:26:03 -0600889 << "\t[--gpu_number <index of physical device>]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600890 << "\t[--present_mode <present mode enum>]\n"
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100891 << "\t[--width <width>] [--height <height>]\n"
Mark Young43c08f82021-11-30 16:38:25 -0700892 << "\t[--force_errors]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600893 << "\t<present_mode_enum>\n"
894 << "\t\tVK_PRESENT_MODE_IMMEDIATE_KHR = " << VK_PRESENT_MODE_IMMEDIATE_KHR << "\n"
895 << "\t\tVK_PRESENT_MODE_MAILBOX_KHR = " << VK_PRESENT_MODE_MAILBOX_KHR << "\n"
896 << "\t\tVK_PRESENT_MODE_FIFO_KHR = " << VK_PRESENT_MODE_FIFO_KHR << "\n"
Witold Baryluka3b988f2021-01-07 19:03:02 +0000897 << "\t\tVK_PRESENT_MODE_FIFO_RELAXED_KHR = " << VK_PRESENT_MODE_FIFO_RELAXED_KHR << "\n";
Tony-LunarGd74734f2019-06-04 14:11:43 -0600898
899#if defined(_WIN32)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700900 if (!suppress_popups) MessageBox(nullptr, usage.str().c_str(), "Usage Error", MB_OK);
Tony-LunarGd74734f2019-06-04 14:11:43 -0600901#else
902 std::cerr << usage.str();
903 std::cerr.flush();
904#endif
Dave Houlton5fa47912018-02-16 11:02:26 -0700905 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600906 }
907
Dave Houlton5fa47912018-02-16 11:02:26 -0700908 if (!use_xlib) {
909 init_connection();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600910 }
911
Dave Houlton5fa47912018-02-16 11:02:26 -0700912 init_vk();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600913
Dave Houlton5fa47912018-02-16 11:02:26 -0700914 spin_angle = 4.0f;
915 spin_increment = 0.2f;
916 pause = false;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600917
Charles Giessen87dd88d2022-02-03 13:46:29 -0700918 mat4x4_perspective(projection_matrix, static_cast<float>(degreesToRadians(45.0f)), 1.0f, 0.1f, 100.0f);
Dave Houlton5fa47912018-02-16 11:02:26 -0700919 mat4x4_look_at(view_matrix, eye, origin, up);
920 mat4x4_identity(model_matrix);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600921
Dave Houlton5fa47912018-02-16 11:02:26 -0700922 projection_matrix[1][1] *= -1; // Flip projection matrix from GL to Vulkan orientation.
923}
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600924
Dave Houlton5fa47912018-02-16 11:02:26 -0700925void Demo::init_connection() {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600926#if defined(VK_USE_PLATFORM_XCB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -0700927 const xcb_setup_t *setup;
928 xcb_screen_iterator_t iter;
929 int scr;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600930
Dave Houlton5fa47912018-02-16 11:02:26 -0700931 const char *display_envar = getenv("DISPLAY");
932 if (display_envar == nullptr || display_envar[0] == '\0') {
933 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
934 fflush(stdout);
935 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600936 }
937
Dave Houlton5fa47912018-02-16 11:02:26 -0700938 connection = xcb_connect(nullptr, &scr);
939 if (xcb_connection_has_error(connection) > 0) {
C Stout05c61712021-08-20 13:19:01 -0700940 printf("Cannot connect to XCB.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700941 fflush(stdout);
942 exit(1);
943 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600944
Dave Houlton5fa47912018-02-16 11:02:26 -0700945 setup = xcb_get_setup(connection);
946 iter = xcb_setup_roots_iterator(setup);
947 while (scr-- > 0) xcb_screen_next(&iter);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600948
Dave Houlton5fa47912018-02-16 11:02:26 -0700949 screen = iter.data;
950#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
951 display = wl_display_connect(nullptr);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600952
Dave Houlton5fa47912018-02-16 11:02:26 -0700953 if (display == nullptr) {
C Stout05c61712021-08-20 13:19:01 -0700954 printf("Cannot connect to wayland.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700955 fflush(stdout);
956 exit(1);
957 }
958
959 registry = wl_display_get_registry(display);
960 wl_registry_add_listener(registry, &registry_listener, this);
961 wl_display_dispatch(display);
Dave Houlton5fa47912018-02-16 11:02:26 -0700962#endif
963}
Tony-LunarG27c21242021-03-11 16:28:19 -0700964#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700965int find_display_gpu(int gpu_number, const std::vector<vk::PhysicalDevice> &physical_devices) {
Tony-LunarG27c21242021-03-11 16:28:19 -0700966 uint32_t display_count = 0;
Tony-LunarG27c21242021-03-11 16:28:19 -0700967 int gpu_return = gpu_number;
968 if (gpu_number >= 0) {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700969 auto display_props_return = physical_devices[gpu_number].getDisplayPropertiesKHR();
970 VERIFY(display_props_return.result == vk::Result::eSuccess);
Tony-LunarG27c21242021-03-11 16:28:19 -0700971 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700972 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700973 auto display_props_return = physical_devices[i].getDisplayPropertiesKHR();
974 VERIFY(display_props_return.result == vk::Result::eSuccess);
975 if (display_props_return.value.size() > 0) {
Tony-LunarG27c21242021-03-11 16:28:19 -0700976 gpu_return = i;
977 break;
978 }
979 }
980 }
981 if (display_count > 0)
982 return gpu_return;
983 else
984 return -1;
985}
986#endif
Dave Houlton5fa47912018-02-16 11:02:26 -0700987void Demo::init_vk() {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700988 std::vector<char const *> instance_validation_layers = {"VK_LAYER_KHRONOS_validation"};
Dave Houlton5fa47912018-02-16 11:02:26 -0700989
Dave Houlton5fa47912018-02-16 11:02:26 -0700990 // Look for validation layers
991 vk::Bool32 validation_found = VK_FALSE;
992 if (validate) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700993 auto layers = vk::enumerateInstanceLayerProperties();
994 VERIFY(layers.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700995
Charles Giessen87dd88d2022-02-03 13:46:29 -0700996 validation_found = check_layers(instance_validation_layers, layers.value);
997 if (validation_found) {
998 enabled_layers.push_back("VK_LAYER_KHRONOS_validation");
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600999 }
1000
Charles Giessen87dd88d2022-02-03 13:46:29 -07001001 else {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001002 ERR_EXIT(
Dave Houlton5fa47912018-02-16 11:02:26 -07001003 "vkEnumerateInstanceLayerProperties failed to find required validation layer.\n\n"
1004 "Please look at the Getting Started guide for additional information.\n",
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001005 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001006 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001007 }
1008
Dave Houlton5fa47912018-02-16 11:02:26 -07001009 /* Look for instance extensions */
1010 vk::Bool32 surfaceExtFound = VK_FALSE;
1011 vk::Bool32 platformSurfaceExtFound = VK_FALSE;
Dave Houlton5fa47912018-02-16 11:02:26 -07001012
Charles Giessen87dd88d2022-02-03 13:46:29 -07001013 auto instance_extensions_return = vk::enumerateInstanceExtensionProperties();
1014 VERIFY(instance_extensions_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001015
Charles Giessen87dd88d2022-02-03 13:46:29 -07001016 for (const auto &extension : instance_extensions_return.value) {
1017 if (!strcmp(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, extension.extensionName)) {
1018 enabled_instance_extensions.push_back(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001019 } else if (!strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001020 surfaceExtFound = 1;
1021 enabled_instance_extensions.push_back(VK_KHR_SURFACE_EXTENSION_NAME);
1022 }
1023#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001024 else if (!strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001025 platformSurfaceExtFound = 1;
1026 enabled_instance_extensions.push_back(VK_KHR_WIN32_SURFACE_EXTENSION_NAME);
1027 }
1028#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001029 else if (!strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001030 platformSurfaceExtFound = 1;
1031 enabled_instance_extensions.push_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME);
1032 }
1033#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001034 else if (!strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001035 platformSurfaceExtFound = 1;
1036 enabled_instance_extensions.push_back(VK_KHR_XCB_SURFACE_EXTENSION_NAME);
1037 }
1038#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001039 else if (!strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001040 platformSurfaceExtFound = 1;
1041 enabled_instance_extensions.push_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME);
1042 }
1043#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001044 else if (!strcmp(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001045 platformSurfaceExtFound = 1;
1046 enabled_instance_extensions.push_back(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME);
1047 }
1048#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001049 else if (!strcmp(VK_KHR_DISPLAY_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001050 platformSurfaceExtFound = 1;
1051 enabled_instance_extensions.push_back(VK_KHR_DISPLAY_EXTENSION_NAME);
1052 }
1053#elif defined(VK_USE_PLATFORM_METAL_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001054 else if (!strcmp(VK_EXT_METAL_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001055 platformSurfaceExtFound = 1;
1056 enabled_instance_extensions.push_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
1057 }
1058#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001059 }
1060
1061 if (!surfaceExtFound) {
1062 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_SURFACE_EXTENSION_NAME
1063 " extension.\n\n"
1064 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1065 "Please look at the Getting Started guide for additional information.\n",
1066 "vkCreateInstance Failure");
1067 }
1068
1069 if (!platformSurfaceExtFound) {
1070#if defined(VK_USE_PLATFORM_WIN32_KHR)
1071 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WIN32_SURFACE_EXTENSION_NAME
1072 " extension.\n\n"
1073 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1074 "Please look at the Getting Started guide for additional information.\n",
1075 "vkCreateInstance Failure");
1076#elif defined(VK_USE_PLATFORM_XCB_KHR)
1077 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XCB_SURFACE_EXTENSION_NAME
1078 " extension.\n\n"
1079 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1080 "Please look at the Getting Started guide for additional information.\n",
1081 "vkCreateInstance Failure");
1082#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1083 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME
1084 " extension.\n\n"
1085 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1086 "Please look at the Getting Started guide for additional information.\n",
1087 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001088#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001089 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XLIB_SURFACE_EXTENSION_NAME
1090 " extension.\n\n"
1091 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1092 "Please look at the Getting Started guide for additional information.\n",
1093 "vkCreateInstance Failure");
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001094#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1095 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME
1096 " extension.\n\n"
1097 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1098 "Please look at the Getting Started guide for additional information.\n",
1099 "vkCreateInstance Failure");
Damien Leone600c3052017-01-31 10:26:07 -07001100#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001101 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_DISPLAY_EXTENSION_NAME
1102 " extension.\n\n"
1103 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1104 "Please look at the Getting Started guide for additional information.\n",
1105 "vkCreateInstance Failure");
Bill Hollings0a0625a2019-07-15 17:39:18 -04001106#elif defined(VK_USE_PLATFORM_METAL_EXT)
1107 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_METAL_SURFACE_EXTENSION_NAME
Karl Schultz9ceac062017-12-12 10:33:01 -05001108 " extension.\n\nDo you have a compatible "
1109 "Vulkan installable client driver (ICD) installed?\nPlease "
1110 "look at the Getting Started guide for additional "
1111 "information.\n",
1112 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001113#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001114 }
1115 auto const app = vk::ApplicationInfo()
1116 .setPApplicationName(APP_SHORT_NAME)
1117 .setApplicationVersion(0)
1118 .setPEngineName(APP_SHORT_NAME)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001119 .setEngineVersion(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001120 auto const inst_info = vk::InstanceCreateInfo()
1121 .setPApplicationInfo(&app)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001122 .setPEnabledLayerNames(enabled_layers)
1123 .setPEnabledExtensionNames(enabled_instance_extensions);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001124
Charles Giessen87dd88d2022-02-03 13:46:29 -07001125 auto instance_result = vk::createInstance(inst_info);
1126 if (instance_result.result == vk::Result::eErrorIncompatibleDriver) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001127 ERR_EXIT(
1128 "Cannot find a compatible Vulkan installable client driver (ICD).\n\n"
1129 "Please look at the Getting Started guide for additional information.\n",
1130 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001131 } else if (instance_result.result == vk::Result::eErrorExtensionNotPresent) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001132 ERR_EXIT(
1133 "Cannot find a specified extension library.\n"
1134 "Make sure your layers path is set appropriately.\n",
1135 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001136 } else if (instance_result.result != vk::Result::eSuccess) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001137 ERR_EXIT(
1138 "vkCreateInstance failed.\n\n"
1139 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1140 "Please look at the Getting Started guide for additional information.\n",
1141 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001142 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07001143 inst = instance_result.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001144
Charles Giessen87dd88d2022-02-03 13:46:29 -07001145 auto physical_device_return = inst.enumeratePhysicalDevices();
1146 VERIFY(physical_device_return.result == vk::Result::eSuccess);
1147 auto physical_devices = physical_device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001148
Charles Giessen87dd88d2022-02-03 13:46:29 -07001149 if (physical_devices.size() <= 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001150 ERR_EXIT(
1151 "vkEnumeratePhysicalDevices reported zero accessible devices.\n\n"
1152 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1153 "Please look at the Getting Started guide for additional information.\n",
1154 "vkEnumeratePhysicalDevices Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001155 }
1156
Charles Giessen87dd88d2022-02-03 13:46:29 -07001157 if (gpu_number >= 0 && !(static_cast<uint32_t>(gpu_number) < physical_devices.size())) {
1158 fprintf(stderr, "GPU %d specified is not present, GPU count = %zu\n", gpu_number, physical_devices.size());
Witold Baryluka3b988f2021-01-07 19:03:02 +00001159 ERR_EXIT("Specified GPU number is not present", "User Error");
1160 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001161#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001162 gpu_number = find_display_gpu(gpu_number, physical_devices);
Tony-LunarG27c21242021-03-11 16:28:19 -07001163 if (gpu_number < 0) {
1164 printf("Cannot find any display!\n");
1165 fflush(stdout);
1166 exit(1);
1167 }
1168#else
Witold Baryluka3b988f2021-01-07 19:03:02 +00001169 /* Try to auto select most suitable device */
1170 if (gpu_number == -1) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001171 constexpr uint32_t device_type_count = static_cast<uint32_t>(vk::PhysicalDeviceType::eCpu) + 1;
1172 std::array<uint32_t, device_type_count> count_device_type{};
Witold Baryluka3b988f2021-01-07 19:03:02 +00001173
Charles Giessen87dd88d2022-02-03 13:46:29 -07001174 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001175 const auto physicalDeviceProperties = physical_devices[i].getProperties();
Charles Giessen87dd88d2022-02-03 13:46:29 -07001176 assert(physicalDeviceProperties.deviceType <= vk::PhysicalDeviceType::eCpu);
Witold Baryluka3b988f2021-01-07 19:03:02 +00001177 count_device_type[static_cast<int>(physicalDeviceProperties.deviceType)]++;
1178 }
1179
Charles Giessen87dd88d2022-02-03 13:46:29 -07001180 std::array<vk::PhysicalDeviceType, device_type_count> const device_type_preference = {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001181 vk::PhysicalDeviceType::eDiscreteGpu, vk::PhysicalDeviceType::eIntegratedGpu, vk::PhysicalDeviceType::eVirtualGpu,
1182 vk::PhysicalDeviceType::eCpu, vk::PhysicalDeviceType::eOther};
Charles Giessen87dd88d2022-02-03 13:46:29 -07001183
Witold Baryluka3b988f2021-01-07 19:03:02 +00001184 vk::PhysicalDeviceType search_for_device_type = vk::PhysicalDeviceType::eDiscreteGpu;
1185 for (uint32_t i = 0; i < sizeof(device_type_preference) / sizeof(vk::PhysicalDeviceType); i++) {
1186 if (count_device_type[static_cast<int>(device_type_preference[i])]) {
1187 search_for_device_type = device_type_preference[i];
1188 break;
1189 }
1190 }
1191
Charles Giessen87dd88d2022-02-03 13:46:29 -07001192 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001193 const auto physicalDeviceProperties = physical_devices[i].getProperties();
1194 if (physicalDeviceProperties.deviceType == search_for_device_type) {
1195 gpu_number = i;
1196 break;
1197 }
1198 }
1199 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001200#endif
Witold Baryluka3b988f2021-01-07 19:03:02 +00001201 assert(gpu_number >= 0);
1202 gpu = physical_devices[gpu_number];
1203 {
1204 auto physicalDeviceProperties = gpu.getProperties();
1205 fprintf(stderr, "Selected GPU %d: %s, type: %s\n", gpu_number, physicalDeviceProperties.deviceName.data(),
1206 to_string(physicalDeviceProperties.deviceType).c_str());
1207 }
Witold Baryluka3b988f2021-01-07 19:03:02 +00001208
Dave Houlton5fa47912018-02-16 11:02:26 -07001209 /* Look for device extensions */
Dave Houlton5fa47912018-02-16 11:02:26 -07001210 vk::Bool32 swapchainExtFound = VK_FALSE;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001211
Charles Giessen87dd88d2022-02-03 13:46:29 -07001212 auto device_extension_return = gpu.enumerateDeviceExtensionProperties();
1213 VERIFY(device_extension_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001214
Charles Giessen87dd88d2022-02-03 13:46:29 -07001215 for (const auto &extension : device_extension_return.value) {
1216 if (!strcmp(VK_KHR_SWAPCHAIN_EXTENSION_NAME, extension.extensionName)) {
1217 swapchainExtFound = 1;
1218 enabled_device_extensions.push_back(VK_KHR_SWAPCHAIN_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001219 } else if (!strcmp("VK_KHR_portability_subset", extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001220 enabled_device_extensions.push_back("VK_KHR_portability_subset");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001221 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001222 }
Jeremy Hayes6ae1f8a2016-11-16 14:47:13 -07001223
Dave Houlton5fa47912018-02-16 11:02:26 -07001224 if (!swapchainExtFound) {
1225 ERR_EXIT("vkEnumerateDeviceExtensionProperties failed to find the " VK_KHR_SWAPCHAIN_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");
1230 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001231
Dave Houlton5fa47912018-02-16 11:02:26 -07001232 gpu.getProperties(&gpu_props);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001233
Dave Houlton5fa47912018-02-16 11:02:26 -07001234 /* Call with nullptr data to get count */
Charles Giessen87dd88d2022-02-03 13:46:29 -07001235 queue_props = gpu.getQueueFamilyProperties();
1236 assert(queue_props.size() >= 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001237
Dave Houlton5fa47912018-02-16 11:02:26 -07001238 // Query fine-grained feature support for this device.
1239 // If app has specific feature requirements it should check supported
1240 // features based on this query
1241 vk::PhysicalDeviceFeatures physDevFeatures;
1242 gpu.getFeatures(&physDevFeatures);
1243}
1244
Tony-LunarG6cebf142019-09-11 14:32:23 -06001245void Demo::create_surface() {
Dave Houlton5fa47912018-02-16 11:02:26 -07001246// Create a WSI surface for the window:
1247#if defined(VK_USE_PLATFORM_WIN32_KHR)
1248 {
1249 auto const createInfo = vk::Win32SurfaceCreateInfoKHR().setHinstance(connection).setHwnd(window);
1250
1251 auto result = inst.createWin32SurfaceKHR(&createInfo, nullptr, &surface);
1252 VERIFY(result == vk::Result::eSuccess);
1253 }
1254#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1255 {
1256 auto const createInfo = vk::WaylandSurfaceCreateInfoKHR().setDisplay(display).setSurface(window);
1257
1258 auto result = inst.createWaylandSurfaceKHR(&createInfo, nullptr, &surface);
1259 VERIFY(result == vk::Result::eSuccess);
1260 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001261#elif defined(VK_USE_PLATFORM_XLIB_KHR)
1262 {
1263 auto const createInfo = vk::XlibSurfaceCreateInfoKHR().setDpy(display).setWindow(xlib_window);
1264
1265 auto result = inst.createXlibSurfaceKHR(&createInfo, nullptr, &surface);
1266 VERIFY(result == vk::Result::eSuccess);
1267 }
1268#elif defined(VK_USE_PLATFORM_XCB_KHR)
1269 {
1270 auto const createInfo = vk::XcbSurfaceCreateInfoKHR().setConnection(connection).setWindow(xcb_window);
1271
1272 auto result = inst.createXcbSurfaceKHR(&createInfo, nullptr, &surface);
1273 VERIFY(result == vk::Result::eSuccess);
1274 }
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001275#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1276 {
1277 auto const createInfo = vk::DirectFBSurfaceCreateInfoEXT().setDfb(dfb).setSurface(window);
1278
1279 auto result = inst.createDirectFBSurfaceEXT(&createInfo, nullptr, &surface);
1280 VERIFY(result == vk::Result::eSuccess);
1281 }
Bill Hollings0a0625a2019-07-15 17:39:18 -04001282#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05001283 {
Bill Hollings0a0625a2019-07-15 17:39:18 -04001284 auto const createInfo = vk::MetalSurfaceCreateInfoEXT().setPLayer(static_cast<CAMetalLayer *>(caMetalLayer));
Karl Schultz9ceac062017-12-12 10:33:01 -05001285
Bill Hollings0a0625a2019-07-15 17:39:18 -04001286 auto result = inst.createMetalSurfaceEXT(&createInfo, nullptr, &surface);
Karl Schultz9ceac062017-12-12 10:33:01 -05001287 VERIFY(result == vk::Result::eSuccess);
1288 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001289#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
1290 {
1291 auto result = create_display_surface();
1292 VERIFY(result == vk::Result::eSuccess);
1293 }
1294#endif
Tony-LunarG6cebf142019-09-11 14:32:23 -06001295}
1296
1297void Demo::init_vk_swapchain() {
1298 create_surface();
Dave Houlton5fa47912018-02-16 11:02:26 -07001299 // Iterate over each queue to learn whether it supports presenting:
Charles Giessenc2f1a942022-02-06 23:38:39 -07001300 std::vector<vk::Bool32> supportsPresent;
1301 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
1302 auto supports = gpu.getSurfaceSupportKHR(i, surface);
1303 VERIFY(supports.result == vk::Result::eSuccess);
1304 supportsPresent.push_back(supports.value);
Dave Houlton5fa47912018-02-16 11:02:26 -07001305 }
1306
1307 uint32_t graphicsQueueFamilyIndex = UINT32_MAX;
1308 uint32_t presentQueueFamilyIndex = UINT32_MAX;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001309 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001310 if (queue_props[i].queueFlags & vk::QueueFlagBits::eGraphics) {
1311 if (graphicsQueueFamilyIndex == UINT32_MAX) {
1312 graphicsQueueFamilyIndex = i;
1313 }
1314
1315 if (supportsPresent[i] == VK_TRUE) {
1316 graphicsQueueFamilyIndex = i;
1317 presentQueueFamilyIndex = i;
Jeremy Hayes00399e32017-06-14 15:07:32 -06001318 break;
1319 }
1320 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001321 }
Jeremy Hayes00399e32017-06-14 15:07:32 -06001322
Dave Houlton5fa47912018-02-16 11:02:26 -07001323 if (presentQueueFamilyIndex == UINT32_MAX) {
1324 // If didn't find a queue that supports both graphics and present,
1325 // then
1326 // find a separate present queue.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001327 for (uint32_t i = 0; i < queue_props.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001328 if (supportsPresent[i] == VK_TRUE) {
1329 presentQueueFamilyIndex = i;
1330 break;
1331 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001332 }
1333 }
1334
Dave Houlton5fa47912018-02-16 11:02:26 -07001335 // Generate error if could not find both a graphics and a present queue
1336 if (graphicsQueueFamilyIndex == UINT32_MAX || presentQueueFamilyIndex == UINT32_MAX) {
1337 ERR_EXIT("Could not find both graphics and present queues\n", "Swapchain Initialization Failure");
1338 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001339
Dave Houlton5fa47912018-02-16 11:02:26 -07001340 graphics_queue_family_index = graphicsQueueFamilyIndex;
1341 present_queue_family_index = presentQueueFamilyIndex;
1342 separate_present_queue = (graphics_queue_family_index != present_queue_family_index);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001343
Dave Houlton5fa47912018-02-16 11:02:26 -07001344 create_device();
Jeremy Hayes00399e32017-06-14 15:07:32 -06001345
Charles Giessenc2f1a942022-02-06 23:38:39 -07001346 graphics_queue = device.getQueue(graphics_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001347 if (!separate_present_queue) {
1348 present_queue = graphics_queue;
1349 } else {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001350 present_queue = device.getQueue(present_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001351 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001352
Dave Houlton5fa47912018-02-16 11:02:26 -07001353 // Get the list of VkFormat's that are supported:
Charles Giessen87dd88d2022-02-03 13:46:29 -07001354 auto surface_formats_return = gpu.getSurfaceFormatsKHR(surface);
1355 VERIFY(surface_formats_return.result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001356
Charles Giessen7dc2dd52022-02-03 13:55:48 -07001357 vk::SurfaceFormatKHR surfaceFormat = pick_surface_format(surface_formats_return.value);
1358 format = surfaceFormat.format;
1359 color_space = surfaceFormat.colorSpace;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001360
Dave Houlton5fa47912018-02-16 11:02:26 -07001361 quit = false;
1362 curFrame = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001363
Dave Houlton5fa47912018-02-16 11:02:26 -07001364 // Create semaphores to synchronize acquiring presentable buffers before
1365 // rendering and waiting for drawing to be complete before presenting
1366 auto const semaphoreCreateInfo = vk::SemaphoreCreateInfo();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001367
Dave Houlton5fa47912018-02-16 11:02:26 -07001368 // Create fences that we can use to throttle if we get too far
1369 // ahead of the image presents
1370 auto const fence_ci = vk::FenceCreateInfo().setFlags(vk::FenceCreateFlagBits::eSignaled);
1371 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001372 vk::Result result = device.createFence(&fence_ci, nullptr, &fences[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -07001373 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001374
Dave Houlton5fa47912018-02-16 11:02:26 -07001375 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_acquired_semaphores[i]);
1376 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001377
Dave Houlton5fa47912018-02-16 11:02:26 -07001378 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &draw_complete_semaphores[i]);
1379 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001380
Dave Houlton5fa47912018-02-16 11:02:26 -07001381 if (separate_present_queue) {
1382 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_ownership_semaphores[i]);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001383 VERIFY(result == vk::Result::eSuccess);
1384 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001385 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001386 frame_index = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001387
Dave Houlton5fa47912018-02-16 11:02:26 -07001388 // Get Memory information and properties
Charles Giessen87dd88d2022-02-03 13:46:29 -07001389 memory_properties = gpu.getMemoryProperties();
Dave Houlton5fa47912018-02-16 11:02:26 -07001390}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001391
Dave Houlton5fa47912018-02-16 11:02:26 -07001392void Demo::prepare() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001393 prepare_init_cmd();
Dave Houlton5fa47912018-02-16 11:02:26 -07001394
1395 prepare_buffers();
1396 prepare_depth();
1397 prepare_textures();
1398 prepare_cube_data_buffers();
1399
1400 prepare_descriptor_layout();
1401 prepare_render_pass();
1402 prepare_pipeline();
1403
Charles Giessen87dd88d2022-02-03 13:46:29 -07001404 for (auto &swapchain_image_resource : swapchain_image_resources) {
1405 auto alloc_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1406 .setCommandPool(cmd_pool)
1407 .setLevel(vk::CommandBufferLevel::ePrimary)
1408 .setCommandBufferCount(1));
1409 VERIFY(alloc_return.result == vk::Result::eSuccess);
1410 swapchain_image_resource.cmd = alloc_return.value[0];
Dave Houlton5fa47912018-02-16 11:02:26 -07001411 }
1412
1413 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001414 auto present_cmd_pool_return =
1415 device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(present_queue_family_index));
1416 VERIFY(present_cmd_pool_return.result == vk::Result::eSuccess);
1417 present_cmd_pool = present_cmd_pool_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001418
Charles Giessen87dd88d2022-02-03 13:46:29 -07001419 for (auto &swapchain_image_resource : swapchain_image_resources) {
1420 auto alloc_cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1421 .setCommandPool(present_cmd_pool)
1422 .setLevel(vk::CommandBufferLevel::ePrimary)
1423 .setCommandBufferCount(1));
1424 VERIFY(alloc_cmd_return.result == vk::Result::eSuccess);
1425 swapchain_image_resource.graphics_to_present_cmd = alloc_cmd_return.value[0];
1426 build_image_ownership_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001427 }
1428 }
1429
1430 prepare_descriptor_pool();
1431 prepare_descriptor_set();
1432
1433 prepare_framebuffers();
1434
Charles Giessen87dd88d2022-02-03 13:46:29 -07001435 for (const auto &swapchain_image_resource : swapchain_image_resources) {
1436 draw_build_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001437 }
1438
1439 /*
1440 * Prepare functions above may generate pipeline commands
1441 * that need to be flushed before beginning the render loop.
1442 */
1443 flush_init_cmd();
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001444 if (staging_texture.buffer) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001445 destroy_texture(staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07001446 }
1447
1448 current_buffer = 0;
1449 prepared = true;
1450}
1451
1452void Demo::prepare_buffers() {
1453 vk::SwapchainKHR oldSwapchain = swapchain;
1454
1455 // Check the surface capabilities and formats
Charles Giessen87dd88d2022-02-03 13:46:29 -07001456 auto surface_capabilities_return = gpu.getSurfaceCapabilitiesKHR(surface);
1457 VERIFY(surface_capabilities_return.result == vk::Result::eSuccess);
1458 auto surfCapabilities = surface_capabilities_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001459
Charles Giessen87dd88d2022-02-03 13:46:29 -07001460 auto present_modes_return = gpu.getSurfacePresentModesKHR(surface);
1461 VERIFY(present_modes_return.result == vk::Result::eSuccess);
1462 auto present_modes = present_modes_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001463
1464 vk::Extent2D swapchainExtent;
1465 // width and height are either both -1, or both not -1.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001466 if (surfCapabilities.currentExtent.width == static_cast<uint32_t>(-1)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001467 // If the surface size is undefined, the size is set to
1468 // the size of the images requested.
1469 swapchainExtent.width = width;
1470 swapchainExtent.height = height;
1471 } else {
1472 // If the surface size is defined, the swap chain size must match
1473 swapchainExtent = surfCapabilities.currentExtent;
1474 width = surfCapabilities.currentExtent.width;
1475 height = surfCapabilities.currentExtent.height;
1476 }
1477
1478 // The FIFO present mode is guaranteed by the spec to be supported
1479 // and to have no tearing. It's a great default present mode to use.
1480 vk::PresentModeKHR swapchainPresentMode = vk::PresentModeKHR::eFifo;
1481
1482 // There are times when you may wish to use another present mode. The
1483 // following code shows how to select them, and the comments provide some
1484 // reasons you may wish to use them.
1485 //
1486 // It should be noted that Vulkan 1.0 doesn't provide a method for
1487 // synchronizing rendering with the presentation engine's display. There
1488 // is a method provided for throttling rendering with the display, but
1489 // there are some presentation engines for which this method will not work.
1490 // If an application doesn't throttle its rendering, and if it renders much
1491 // faster than the refresh rate of the display, this can waste power on
1492 // mobile devices. That is because power is being spent rendering images
1493 // that may never be seen.
1494
1495 // VK_PRESENT_MODE_IMMEDIATE_KHR is for applications that don't care
1496 // about
1497 // tearing, or have some way of synchronizing their rendering with the
1498 // display.
1499 // VK_PRESENT_MODE_MAILBOX_KHR may be useful for applications that
1500 // generally render a new presentable image every refresh cycle, but are
1501 // occasionally early. In this case, the application wants the new
1502 // image
1503 // to be displayed instead of the previously-queued-for-presentation
1504 // image
1505 // that has not yet been displayed.
1506 // VK_PRESENT_MODE_FIFO_RELAXED_KHR is for applications that generally
1507 // render a new presentable image every refresh cycle, but are
1508 // occasionally
1509 // late. In this case (perhaps because of stuttering/latency concerns),
1510 // the application wants the late image to be immediately displayed,
1511 // even
1512 // though that may mean some tearing.
1513
1514 if (presentMode != swapchainPresentMode) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001515 for (const auto &mode : present_modes) {
1516 if (mode == presentMode) {
1517 swapchainPresentMode = mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07001518 break;
1519 }
1520 }
1521 }
1522
1523 if (swapchainPresentMode != presentMode) {
1524 ERR_EXIT("Present mode specified is not supported\n", "Present mode unsupported");
1525 }
1526
1527 // Determine the number of VkImages to use in the swap chain.
1528 // Application desires to acquire 3 images at a time for triple
1529 // buffering
1530 uint32_t desiredNumOfSwapchainImages = 3;
1531 if (desiredNumOfSwapchainImages < surfCapabilities.minImageCount) {
1532 desiredNumOfSwapchainImages = surfCapabilities.minImageCount;
1533 }
1534
1535 // If maxImageCount is 0, we can ask for as many images as we want,
1536 // otherwise
1537 // we're limited to maxImageCount
1538 if ((surfCapabilities.maxImageCount > 0) && (desiredNumOfSwapchainImages > surfCapabilities.maxImageCount)) {
1539 // Application must settle for fewer images than desired:
1540 desiredNumOfSwapchainImages = surfCapabilities.maxImageCount;
1541 }
1542
1543 vk::SurfaceTransformFlagBitsKHR preTransform;
1544 if (surfCapabilities.supportedTransforms & vk::SurfaceTransformFlagBitsKHR::eIdentity) {
1545 preTransform = vk::SurfaceTransformFlagBitsKHR::eIdentity;
1546 } else {
1547 preTransform = surfCapabilities.currentTransform;
1548 }
1549
1550 // Find a supported composite alpha mode - one of these is guaranteed to be set
1551 vk::CompositeAlphaFlagBitsKHR compositeAlpha = vk::CompositeAlphaFlagBitsKHR::eOpaque;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001552 std::array<vk::CompositeAlphaFlagBitsKHR, 4> compositeAlphaFlags = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001553 vk::CompositeAlphaFlagBitsKHR::eOpaque,
1554 vk::CompositeAlphaFlagBitsKHR::ePreMultiplied,
1555 vk::CompositeAlphaFlagBitsKHR::ePostMultiplied,
1556 vk::CompositeAlphaFlagBitsKHR::eInherit,
1557 };
Charles Giessenc2f1a942022-02-06 23:38:39 -07001558 for (const auto &compositeAlphaFlag : compositeAlphaFlags) {
1559 if (surfCapabilities.supportedCompositeAlpha & compositeAlphaFlag) {
1560 compositeAlpha = compositeAlphaFlag;
Dave Houlton5fa47912018-02-16 11:02:26 -07001561 break;
1562 }
1563 }
1564
Charles Giessen87dd88d2022-02-03 13:46:29 -07001565 auto swapchain_return = device.createSwapchainKHR(vk::SwapchainCreateInfoKHR()
1566 .setSurface(surface)
1567 .setMinImageCount(desiredNumOfSwapchainImages)
1568 .setImageFormat(format)
1569 .setImageColorSpace(color_space)
1570 .setImageExtent({swapchainExtent.width, swapchainExtent.height})
1571 .setImageArrayLayers(1)
1572 .setImageUsage(vk::ImageUsageFlagBits::eColorAttachment)
1573 .setImageSharingMode(vk::SharingMode::eExclusive)
1574 .setPreTransform(preTransform)
1575 .setCompositeAlpha(compositeAlpha)
1576 .setPresentMode(swapchainPresentMode)
1577 .setClipped(true)
1578 .setOldSwapchain(oldSwapchain));
1579 VERIFY(swapchain_return.result == vk::Result::eSuccess);
1580 swapchain = swapchain_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001581
1582 // If we just re-created an existing swapchain, we should destroy the
1583 // old
1584 // swapchain at this point.
1585 // Note: destroying the swapchain also cleans up all its associated
1586 // presentable images once the platform is done with them.
1587 if (oldSwapchain) {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001588 device.destroySwapchainKHR(oldSwapchain);
Dave Houlton5fa47912018-02-16 11:02:26 -07001589 }
1590
Charles Giessen87dd88d2022-02-03 13:46:29 -07001591 auto swapchain_images_return = device.getSwapchainImagesKHR(swapchain);
1592 VERIFY(swapchain_images_return.result == vk::Result::eSuccess);
1593 swapchain_image_resources.resize(swapchain_images_return.value.size());
Dave Houlton5fa47912018-02-16 11:02:26 -07001594
Charles Giessen87dd88d2022-02-03 13:46:29 -07001595 for (uint32_t i = 0; i < swapchain_image_resources.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001596 auto color_image_view = vk::ImageViewCreateInfo()
1597 .setViewType(vk::ImageViewType::e2D)
1598 .setFormat(format)
1599 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
1600
Charles Giessen87dd88d2022-02-03 13:46:29 -07001601 swapchain_image_resources[i].image = swapchain_images_return.value[i];
Dave Houlton5fa47912018-02-16 11:02:26 -07001602
1603 color_image_view.image = swapchain_image_resources[i].image;
1604
Charles Giessen87dd88d2022-02-03 13:46:29 -07001605 auto image_view_return = device.createImageView(color_image_view);
1606 VERIFY(image_view_return.result == vk::Result::eSuccess);
1607 swapchain_image_resources[i].view = image_view_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001608 }
1609}
1610
1611void Demo::prepare_cube_data_buffers() {
1612 mat4x4 VP;
1613 mat4x4_mul(VP, projection_matrix, view_matrix);
1614
1615 mat4x4 MVP;
1616 mat4x4_mul(MVP, VP, model_matrix);
1617
1618 vktexcube_vs_uniform data;
1619 memcpy(data.mvp, MVP, sizeof(MVP));
1620 // dumpMatrix("MVP", MVP)
1621
1622 for (int32_t i = 0; i < 12 * 3; i++) {
1623 data.position[i][0] = g_vertex_buffer_data[i * 3];
1624 data.position[i][1] = g_vertex_buffer_data[i * 3 + 1];
1625 data.position[i][2] = g_vertex_buffer_data[i * 3 + 2];
1626 data.position[i][3] = 1.0f;
1627 data.attr[i][0] = g_uv_buffer_data[2 * i];
1628 data.attr[i][1] = g_uv_buffer_data[2 * i + 1];
1629 data.attr[i][2] = 0;
1630 data.attr[i][3] = 0;
1631 }
1632
1633 auto const buf_info = vk::BufferCreateInfo().setSize(sizeof(data)).setUsage(vk::BufferUsageFlagBits::eUniformBuffer);
1634
Charles Giessen87dd88d2022-02-03 13:46:29 -07001635 for (auto &swapchain_image_resource : swapchain_image_resources) {
1636 auto result = device.createBuffer(&buf_info, nullptr, &swapchain_image_resource.uniform_buffer);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001637 VERIFY(result == vk::Result::eSuccess);
1638
1639 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001640 device.getBufferMemoryRequirements(swapchain_image_resource.uniform_buffer, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001641
Dave Houlton5fa47912018-02-16 11:02:26 -07001642 auto mem_alloc = vk::MemoryAllocateInfo().setAllocationSize(mem_reqs.size).setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001643
Dave Houlton5fa47912018-02-16 11:02:26 -07001644 bool const pass = memory_type_from_properties(
1645 mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001646 mem_alloc.memoryTypeIndex);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001647 VERIFY(pass);
1648
Charles Giessen87dd88d2022-02-03 13:46:29 -07001649 result = device.allocateMemory(&mem_alloc, nullptr, &swapchain_image_resource.uniform_memory);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001650 VERIFY(result == vk::Result::eSuccess);
1651
Charles Giessen87dd88d2022-02-03 13:46:29 -07001652 result = device.mapMemory(swapchain_image_resource.uniform_memory, 0, VK_WHOLE_SIZE, vk::MemoryMapFlags(),
1653 &swapchain_image_resource.uniform_memory_ptr);
Tony-LunarG37af49f2019-12-19 12:04:19 -07001654 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001655
Charles Giessen87dd88d2022-02-03 13:46:29 -07001656 memcpy(swapchain_image_resource.uniform_memory_ptr, &data, sizeof data);
Dave Houlton5fa47912018-02-16 11:02:26 -07001657
Charles Giessen87dd88d2022-02-03 13:46:29 -07001658 result = device.bindBufferMemory(swapchain_image_resource.uniform_buffer, swapchain_image_resource.uniform_memory, 0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001659 VERIFY(result == vk::Result::eSuccess);
1660 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001661}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001662
Dave Houlton5fa47912018-02-16 11:02:26 -07001663void Demo::prepare_depth() {
1664 depth.format = vk::Format::eD16Unorm;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001665
Dave Houlton5fa47912018-02-16 11:02:26 -07001666 auto const image = vk::ImageCreateInfo()
1667 .setImageType(vk::ImageType::e2D)
1668 .setFormat(depth.format)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001669 .setExtent({width, height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07001670 .setMipLevels(1)
1671 .setArrayLayers(1)
1672 .setSamples(vk::SampleCountFlagBits::e1)
1673 .setTiling(vk::ImageTiling::eOptimal)
1674 .setUsage(vk::ImageUsageFlagBits::eDepthStencilAttachment)
1675 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07001676 .setInitialLayout(vk::ImageLayout::eUndefined);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001677
Dave Houlton5fa47912018-02-16 11:02:26 -07001678 auto result = device.createImage(&image, nullptr, &depth.image);
1679 VERIFY(result == vk::Result::eSuccess);
1680
1681 vk::MemoryRequirements mem_reqs;
1682 device.getImageMemoryRequirements(depth.image, &mem_reqs);
1683
1684 depth.mem_alloc.setAllocationSize(mem_reqs.size);
1685 depth.mem_alloc.setMemoryTypeIndex(0);
1686
1687 auto const pass = memory_type_from_properties(mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eDeviceLocal,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001688 depth.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07001689 VERIFY(pass);
1690
1691 result = device.allocateMemory(&depth.mem_alloc, nullptr, &depth.mem);
1692 VERIFY(result == vk::Result::eSuccess);
1693
1694 result = device.bindImageMemory(depth.image, depth.mem, 0);
1695 VERIFY(result == vk::Result::eSuccess);
1696
Mark Young43c08f82021-11-30 16:38:25 -07001697 auto view = vk::ImageViewCreateInfo()
Charles Giessen87dd88d2022-02-03 13:46:29 -07001698 .setImage(depth.image)
1699 .setViewType(vk::ImageViewType::e2D)
1700 .setFormat(depth.format)
1701 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eDepth, 0, 1, 0, 1));
Mark Young43c08f82021-11-30 16:38:25 -07001702 if (force_errors) {
1703 // Intentionally force a bad pNext value to generate a validation layer error
1704 view.pNext = &image;
1705 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001706 result = device.createImageView(&view, nullptr, &depth.view);
1707 VERIFY(result == vk::Result::eSuccess);
1708}
1709
1710void Demo::prepare_descriptor_layout() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001711 std::array<vk::DescriptorSetLayoutBinding, 2> const layout_bindings = {
1712 vk::DescriptorSetLayoutBinding()
1713 .setBinding(0)
1714 .setDescriptorType(vk::DescriptorType::eUniformBuffer)
1715 .setDescriptorCount(1)
1716 .setStageFlags(vk::ShaderStageFlagBits::eVertex)
1717 .setPImmutableSamplers(nullptr),
1718 vk::DescriptorSetLayoutBinding()
1719 .setBinding(1)
1720 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1721 .setDescriptorCount(texture_count)
1722 .setStageFlags(vk::ShaderStageFlagBits::eFragment)
1723 .setPImmutableSamplers(nullptr)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001724
Charles Giessen87dd88d2022-02-03 13:46:29 -07001725 auto const descriptor_layout = vk::DescriptorSetLayoutCreateInfo().setBindings(layout_bindings);
Dave Houlton5fa47912018-02-16 11:02:26 -07001726
1727 auto result = device.createDescriptorSetLayout(&descriptor_layout, nullptr, &desc_layout);
1728 VERIFY(result == vk::Result::eSuccess);
1729
Charles Giessen87dd88d2022-02-03 13:46:29 -07001730 auto const pPipelineLayoutCreateInfo = vk::PipelineLayoutCreateInfo().setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001731
1732 result = device.createPipelineLayout(&pPipelineLayoutCreateInfo, nullptr, &pipeline_layout);
1733 VERIFY(result == vk::Result::eSuccess);
1734}
1735
1736void Demo::prepare_descriptor_pool() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001737 std::array<vk::DescriptorPoolSize, 2> const poolSizes = {
1738 vk::DescriptorPoolSize()
1739 .setType(vk::DescriptorType::eUniformBuffer)
1740 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size())),
Dave Houlton5fa47912018-02-16 11:02:26 -07001741 vk::DescriptorPoolSize()
1742 .setType(vk::DescriptorType::eCombinedImageSampler)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001743 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size()) * texture_count)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001744
1745 auto const descriptor_pool =
Charles Giessen87dd88d2022-02-03 13:46:29 -07001746 vk::DescriptorPoolCreateInfo().setMaxSets(static_cast<uint32_t>(swapchain_image_resources.size())).setPoolSizes(poolSizes);
Dave Houlton5fa47912018-02-16 11:02:26 -07001747
1748 auto result = device.createDescriptorPool(&descriptor_pool, nullptr, &desc_pool);
1749 VERIFY(result == vk::Result::eSuccess);
1750}
1751
1752void Demo::prepare_descriptor_set() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001753 auto const alloc_info = vk::DescriptorSetAllocateInfo().setDescriptorPool(desc_pool).setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001754
Charles Giessen87dd88d2022-02-03 13:46:29 -07001755 auto buffer_info = vk::DescriptorBufferInfo().setOffset(0).setRange(sizeof(vktexcube_vs_uniform));
Dave Houlton5fa47912018-02-16 11:02:26 -07001756
Charles Giessen87dd88d2022-02-03 13:46:29 -07001757 std::array<vk::DescriptorImageInfo, texture_count> tex_descs;
Dave Houlton5fa47912018-02-16 11:02:26 -07001758 for (uint32_t i = 0; i < texture_count; i++) {
1759 tex_descs[i].setSampler(textures[i].sampler);
1760 tex_descs[i].setImageView(textures[i].view);
Karl Schultze88bc842018-09-11 16:23:14 -06001761 tex_descs[i].setImageLayout(vk::ImageLayout::eShaderReadOnlyOptimal);
Dave Houlton5fa47912018-02-16 11:02:26 -07001762 }
1763
Charles Giessenc2f1a942022-02-06 23:38:39 -07001764 std::array<vk::WriteDescriptorSet, 2> writes;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001765 writes[0].setDescriptorCount(1).setDescriptorType(vk::DescriptorType::eUniformBuffer).setPBufferInfo(&buffer_info);
Charles Giessen87dd88d2022-02-03 13:46:29 -07001766 writes[1]
1767 .setDstBinding(1)
1768 .setDescriptorCount(texture_count)
1769 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1770 .setImageInfo(tex_descs);
Dave Houlton5fa47912018-02-16 11:02:26 -07001771
Charles Giessen87dd88d2022-02-03 13:46:29 -07001772 for (auto &swapchain_image_resource : swapchain_image_resources) {
1773 auto result = device.allocateDescriptorSets(&alloc_info, &swapchain_image_resource.descriptor_set);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001774 VERIFY(result == vk::Result::eSuccess);
1775
Charles Giessen87dd88d2022-02-03 13:46:29 -07001776 buffer_info.setBuffer(swapchain_image_resource.uniform_buffer);
1777 writes[0].setDstSet(swapchain_image_resource.descriptor_set);
1778 writes[1].setDstSet(swapchain_image_resource.descriptor_set);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001779 device.updateDescriptorSets(writes, {});
Dave Houlton5fa47912018-02-16 11:02:26 -07001780 }
1781}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001782
Dave Houlton5fa47912018-02-16 11:02:26 -07001783void Demo::prepare_framebuffers() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001784 std::array<vk::ImageView, 2> attachments;
Dave Houlton5fa47912018-02-16 11:02:26 -07001785 attachments[1] = depth.view;
1786
Charles Giessen87dd88d2022-02-03 13:46:29 -07001787 for (auto &swapchain_image_resource : swapchain_image_resources) {
1788 attachments[0] = swapchain_image_resource.view;
1789 auto const framebuffer_return = device.createFramebuffer(vk::FramebufferCreateInfo()
1790 .setRenderPass(render_pass)
1791 .setAttachments(attachments)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001792 .setWidth(width)
1793 .setHeight(height)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001794 .setLayers(1));
1795 VERIFY(framebuffer_return.result == vk::Result::eSuccess);
1796 swapchain_image_resource.framebuffer = framebuffer_return.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001797 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001798}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001799
Dave Houlton5fa47912018-02-16 11:02:26 -07001800vk::ShaderModule Demo::prepare_fs() {
1801 const uint32_t fragShaderCode[] = {
Petr Kraus9a4eb6a2017-11-30 14:49:20 +01001802#include "cube.frag.inc"
Dave Houlton5fa47912018-02-16 11:02:26 -07001803 };
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001804
Dave Houlton5fa47912018-02-16 11:02:26 -07001805 frag_shader_module = prepare_shader_module(fragShaderCode, sizeof(fragShaderCode));
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001806
Dave Houlton5fa47912018-02-16 11:02:26 -07001807 return frag_shader_module;
1808}
1809
1810void Demo::prepare_pipeline() {
1811 vk::PipelineCacheCreateInfo const pipelineCacheInfo;
1812 auto result = device.createPipelineCache(&pipelineCacheInfo, nullptr, &pipelineCache);
1813 VERIFY(result == vk::Result::eSuccess);
1814
Charles Giessen87dd88d2022-02-03 13:46:29 -07001815 std::array<vk::PipelineShaderStageCreateInfo, 2> const shaderStageInfo = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001816 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eVertex).setModule(prepare_vs()).setPName("main"),
1817 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eFragment).setModule(prepare_fs()).setPName("main")};
1818
1819 vk::PipelineVertexInputStateCreateInfo const vertexInputInfo;
1820
1821 auto const inputAssemblyInfo = vk::PipelineInputAssemblyStateCreateInfo().setTopology(vk::PrimitiveTopology::eTriangleList);
1822
1823 // TODO: Where are pViewports and pScissors set?
1824 auto const viewportInfo = vk::PipelineViewportStateCreateInfo().setViewportCount(1).setScissorCount(1);
1825
1826 auto const rasterizationInfo = vk::PipelineRasterizationStateCreateInfo()
1827 .setDepthClampEnable(VK_FALSE)
1828 .setRasterizerDiscardEnable(VK_FALSE)
1829 .setPolygonMode(vk::PolygonMode::eFill)
1830 .setCullMode(vk::CullModeFlagBits::eBack)
1831 .setFrontFace(vk::FrontFace::eCounterClockwise)
1832 .setDepthBiasEnable(VK_FALSE)
1833 .setLineWidth(1.0f);
1834
1835 auto const multisampleInfo = vk::PipelineMultisampleStateCreateInfo();
1836
1837 auto const stencilOp =
1838 vk::StencilOpState().setFailOp(vk::StencilOp::eKeep).setPassOp(vk::StencilOp::eKeep).setCompareOp(vk::CompareOp::eAlways);
1839
1840 auto const depthStencilInfo = vk::PipelineDepthStencilStateCreateInfo()
1841 .setDepthTestEnable(VK_TRUE)
1842 .setDepthWriteEnable(VK_TRUE)
1843 .setDepthCompareOp(vk::CompareOp::eLessOrEqual)
1844 .setDepthBoundsTestEnable(VK_FALSE)
1845 .setStencilTestEnable(VK_FALSE)
1846 .setFront(stencilOp)
1847 .setBack(stencilOp);
1848
Charles Giessen87dd88d2022-02-03 13:46:29 -07001849 std::array<vk::PipelineColorBlendAttachmentState, 1> const colorBlendAttachments = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001850 vk::PipelineColorBlendAttachmentState().setColorWriteMask(vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG |
1851 vk::ColorComponentFlagBits::eB | vk::ColorComponentFlagBits::eA)};
1852
Charles Giessen87dd88d2022-02-03 13:46:29 -07001853 auto const colorBlendInfo = vk::PipelineColorBlendStateCreateInfo().setAttachments(colorBlendAttachments);
Dave Houlton5fa47912018-02-16 11:02:26 -07001854
Charles Giessen87dd88d2022-02-03 13:46:29 -07001855 std::array<vk::DynamicState, 2> const dynamicStates = {vk::DynamicState::eViewport, vk::DynamicState::eScissor};
Dave Houlton5fa47912018-02-16 11:02:26 -07001856
Charles Giessen87dd88d2022-02-03 13:46:29 -07001857 auto const dynamicStateInfo = vk::PipelineDynamicStateCreateInfo().setDynamicStates(dynamicStates);
Dave Houlton5fa47912018-02-16 11:02:26 -07001858
Charles Giessenc2f1a942022-02-06 23:38:39 -07001859 auto pipline_return = device.createGraphicsPipelines(pipelineCache, vk::GraphicsPipelineCreateInfo()
1860 .setStages(shaderStageInfo)
1861 .setPVertexInputState(&vertexInputInfo)
1862 .setPInputAssemblyState(&inputAssemblyInfo)
1863 .setPViewportState(&viewportInfo)
1864 .setPRasterizationState(&rasterizationInfo)
1865 .setPMultisampleState(&multisampleInfo)
1866 .setPDepthStencilState(&depthStencilInfo)
1867 .setPColorBlendState(&colorBlendInfo)
1868 .setPDynamicState(&dynamicStateInfo)
1869 .setLayout(pipeline_layout)
1870 .setRenderPass(render_pass));
Dave Houlton5fa47912018-02-16 11:02:26 -07001871 VERIFY(result == vk::Result::eSuccess);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001872 pipeline = pipline_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001873
Charles Giessenc2f1a942022-02-06 23:38:39 -07001874 device.destroyShaderModule(frag_shader_module);
1875 device.destroyShaderModule(vert_shader_module);
Dave Houlton5fa47912018-02-16 11:02:26 -07001876}
1877
1878void Demo::prepare_render_pass() {
1879 // The initial layout for the color and depth attachments will be LAYOUT_UNDEFINED
1880 // because at the start of the renderpass, we don't care about their contents.
1881 // At the start of the subpass, the color attachment's layout will be transitioned
1882 // to LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth stencil attachment's layout
1883 // will be transitioned to LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL. At the end of
1884 // the renderpass, the color attachment's layout will be transitioned to
1885 // LAYOUT_PRESENT_SRC_KHR to be ready to present. This is all done as part of
1886 // the renderpass, no barriers are necessary.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001887 std::array<vk::AttachmentDescription, 2> const attachments = {
1888 vk::AttachmentDescription()
1889 .setFormat(format)
1890 .setSamples(vk::SampleCountFlagBits::e1)
1891 .setLoadOp(vk::AttachmentLoadOp::eClear)
1892 .setStoreOp(vk::AttachmentStoreOp::eStore)
1893 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
1894 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
1895 .setInitialLayout(vk::ImageLayout::eUndefined)
1896 .setFinalLayout(vk::ImageLayout::ePresentSrcKHR),
1897 vk::AttachmentDescription()
1898 .setFormat(depth.format)
1899 .setSamples(vk::SampleCountFlagBits::e1)
1900 .setLoadOp(vk::AttachmentLoadOp::eClear)
1901 .setStoreOp(vk::AttachmentStoreOp::eDontCare)
1902 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
1903 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
1904 .setInitialLayout(vk::ImageLayout::eUndefined)
1905 .setFinalLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001906
1907 auto const color_reference = vk::AttachmentReference().setAttachment(0).setLayout(vk::ImageLayout::eColorAttachmentOptimal);
1908
1909 auto const depth_reference =
1910 vk::AttachmentReference().setAttachment(1).setLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal);
1911
1912 auto const subpass = vk::SubpassDescription()
1913 .setPipelineBindPoint(vk::PipelineBindPoint::eGraphics)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001914 .setColorAttachments(color_reference)
1915 .setPDepthStencilAttachment(&depth_reference);
Dave Houlton5fa47912018-02-16 11:02:26 -07001916
Tony-LunarG495604b2019-06-13 15:32:05 -06001917 vk::PipelineStageFlags stages = vk::PipelineStageFlagBits::eEarlyFragmentTests | vk::PipelineStageFlagBits::eLateFragmentTests;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001918 std::array<vk::SubpassDependency, 2> const dependencies = {
Tony-LunarG495604b2019-06-13 15:32:05 -06001919 vk::SubpassDependency() // Depth buffer is shared between swapchain images
1920 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
1921 .setDstSubpass(0)
1922 .setSrcStageMask(stages)
1923 .setDstStageMask(stages)
1924 .setSrcAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentWrite)
1925 .setDstAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentRead | vk::AccessFlagBits::eDepthStencilAttachmentWrite)
1926 .setDependencyFlags(vk::DependencyFlags()),
1927 vk::SubpassDependency() // Image layout transition
1928 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
1929 .setDstSubpass(0)
1930 .setSrcStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
1931 .setDstStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
1932 .setSrcAccessMask(vk::AccessFlagBits())
1933 .setDstAccessMask(vk::AccessFlagBits::eColorAttachmentWrite | vk::AccessFlagBits::eColorAttachmentRead)
1934 .setDependencyFlags(vk::DependencyFlags()),
1935 };
1936
Charles Giessen87dd88d2022-02-03 13:46:29 -07001937 const auto render_pass_result = device.createRenderPass(
1938 vk::RenderPassCreateInfo().setAttachments(attachments).setSubpasses(subpass).setDependencies(dependencies));
1939 VERIFY(render_pass_result.result == vk::Result::eSuccess);
1940 render_pass = render_pass_result.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001941}
1942
1943vk::ShaderModule Demo::prepare_shader_module(const uint32_t *code, size_t size) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001944 const auto shader_module_return = device.createShaderModule(vk::ShaderModuleCreateInfo().setCodeSize(size).setPCode(code));
1945 VERIFY(shader_module_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001946
Charles Giessen87dd88d2022-02-03 13:46:29 -07001947 return shader_module_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001948}
1949
Charles Giessen87dd88d2022-02-03 13:46:29 -07001950void Demo::prepare_texture_buffer(const char *filename, texture_object &tex_obj) {
1951 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07001952
1953 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001954 ERR_EXIT("Failed to load textures", "Load Texture Failure");
1955 }
1956
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001957 auto const buffer_create_info = vk::BufferCreateInfo()
Charles Giessen3bcefe52022-02-21 11:57:16 -07001958 .setSize(tex_obj.tex_width * tex_obj.tex_height * 4)
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001959 .setUsage(vk::BufferUsageFlagBits::eTransferSrc)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001960 .setSharingMode(vk::SharingMode::eExclusive);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001961
Charles Giessen87dd88d2022-02-03 13:46:29 -07001962 auto result = device.createBuffer(&buffer_create_info, nullptr, &tex_obj.buffer);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001963 VERIFY(result == vk::Result::eSuccess);
1964
1965 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001966 device.getBufferMemoryRequirements(tex_obj.buffer, &mem_reqs);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001967
Charles Giessen87dd88d2022-02-03 13:46:29 -07001968 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
1969 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001970
1971 vk::MemoryPropertyFlags requirements = vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001972 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, requirements, tex_obj.mem_alloc.memoryTypeIndex);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001973 VERIFY(pass == true);
1974
Charles Giessen87dd88d2022-02-03 13:46:29 -07001975 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &(tex_obj.mem));
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001976 VERIFY(result == vk::Result::eSuccess);
1977
Charles Giessen87dd88d2022-02-03 13:46:29 -07001978 result = device.bindBufferMemory(tex_obj.buffer, tex_obj.mem, 0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001979 VERIFY(result == vk::Result::eSuccess);
1980
1981 vk::SubresourceLayout layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07001982 layout.rowPitch = tex_obj.tex_width * 4;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001983 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001984 VERIFY(data.result == vk::Result::eSuccess);
1985
Charles Giessen3bcefe52022-02-21 11:57:16 -07001986 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001987 fprintf(stderr, "Error loading texture: %s\n", filename);
1988 }
1989
Charles Giessen87dd88d2022-02-03 13:46:29 -07001990 device.unmapMemory(tex_obj.mem);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001991}
1992
Charles Giessen87dd88d2022-02-03 13:46:29 -07001993void Demo::prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
Dave Houlton5fa47912018-02-16 11:02:26 -07001994 vk::MemoryPropertyFlags required_props) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001995 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07001996 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001997 ERR_EXIT("Failed to load textures", "Load Texture Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001998 }
1999
Dave Houlton5fa47912018-02-16 11:02:26 -07002000 auto const image_create_info = vk::ImageCreateInfo()
2001 .setImageType(vk::ImageType::e2D)
2002 .setFormat(vk::Format::eR8G8B8A8Unorm)
Charles Giessen3bcefe52022-02-21 11:57:16 -07002003 .setExtent({tex_obj.tex_width, tex_obj.tex_height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07002004 .setMipLevels(1)
2005 .setArrayLayers(1)
2006 .setSamples(vk::SampleCountFlagBits::e1)
2007 .setTiling(tiling)
2008 .setUsage(usage)
2009 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07002010 .setInitialLayout(vk::ImageLayout::ePreinitialized);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002011
Charles Giessen87dd88d2022-02-03 13:46:29 -07002012 auto result = device.createImage(&image_create_info, nullptr, &tex_obj.image);
Dave Houlton5fa47912018-02-16 11:02:26 -07002013 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002014
Dave Houlton5fa47912018-02-16 11:02:26 -07002015 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002016 device.getImageMemoryRequirements(tex_obj.image, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002017
Charles Giessen87dd88d2022-02-03 13:46:29 -07002018 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
2019 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002020
Charles Giessen87dd88d2022-02-03 13:46:29 -07002021 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, required_props, tex_obj.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07002022 VERIFY(pass == true);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002023
Charles Giessen87dd88d2022-02-03 13:46:29 -07002024 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &tex_obj.mem);
Dave Houlton5fa47912018-02-16 11:02:26 -07002025 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002026
Charles Giessen87dd88d2022-02-03 13:46:29 -07002027 result = device.bindImageMemory(tex_obj.image, tex_obj.mem, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002028 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002029
Dave Houlton5fa47912018-02-16 11:02:26 -07002030 if (required_props & vk::MemoryPropertyFlagBits::eHostVisible) {
2031 auto const subres = vk::ImageSubresource().setAspectMask(vk::ImageAspectFlagBits::eColor).setMipLevel(0).setArrayLayer(0);
2032 vk::SubresourceLayout layout;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002033 device.getImageSubresourceLayout(tex_obj.image, &subres, &layout);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002034
Charles Giessen87dd88d2022-02-03 13:46:29 -07002035 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002036 VERIFY(data.result == vk::Result::eSuccess);
2037
Charles Giessen3bcefe52022-02-21 11:57:16 -07002038 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002039 fprintf(stderr, "Error loading texture: %s\n", filename);
2040 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002041
Charles Giessen87dd88d2022-02-03 13:46:29 -07002042 device.unmapMemory(tex_obj.mem);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002043 }
2044
Charles Giessen87dd88d2022-02-03 13:46:29 -07002045 tex_obj.imageLayout = vk::ImageLayout::eShaderReadOnlyOptimal;
Dave Houlton5fa47912018-02-16 11:02:26 -07002046}
2047
2048void Demo::prepare_textures() {
2049 vk::Format const tex_format = vk::Format::eR8G8B8A8Unorm;
2050 vk::FormatProperties props;
2051 gpu.getFormatProperties(tex_format, &props);
2052
2053 for (uint32_t i = 0; i < texture_count; i++) {
2054 if ((props.linearTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) && !use_staging_buffer) {
2055 /* Device can texture using linear textures */
Charles Giessen87dd88d2022-02-03 13:46:29 -07002056 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eLinear, vk::ImageUsageFlagBits::eSampled,
Dave Houlton5fa47912018-02-16 11:02:26 -07002057 vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent);
2058 // Nothing in the pipeline needs to be complete to start, and don't allow fragment
2059 // shader to run until layout transition completes
2060 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2061 textures[i].imageLayout, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2062 vk::PipelineStageFlagBits::eFragmentShader);
2063 staging_texture.image = vk::Image();
2064 } else if (props.optimalTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) {
2065 /* Must use staging buffer to copy linear texture to optimized */
2066
Charles Giessen87dd88d2022-02-03 13:46:29 -07002067 prepare_texture_buffer(tex_files[i], staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07002068
Charles Giessen87dd88d2022-02-03 13:46:29 -07002069 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eOptimal,
Dave Houlton5fa47912018-02-16 11:02:26 -07002070 vk::ImageUsageFlagBits::eTransferDst | vk::ImageUsageFlagBits::eSampled,
2071 vk::MemoryPropertyFlagBits::eDeviceLocal);
2072
Dave Houlton5fa47912018-02-16 11:02:26 -07002073 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2074 vk::ImageLayout::eTransferDstOptimal, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2075 vk::PipelineStageFlagBits::eTransfer);
2076
2077 auto const subresource = vk::ImageSubresourceLayers()
2078 .setAspectMask(vk::ImageAspectFlagBits::eColor)
2079 .setMipLevel(0)
2080 .setBaseArrayLayer(0)
2081 .setLayerCount(1);
2082
Charles Giessen87dd88d2022-02-03 13:46:29 -07002083 auto const copy_region = vk::BufferImageCopy()
2084 .setBufferOffset(0)
2085 .setBufferRowLength(staging_texture.tex_width)
2086 .setBufferImageHeight(staging_texture.tex_height)
2087 .setImageSubresource(subresource)
2088 .setImageOffset({0, 0, 0})
Charles Giessen3bcefe52022-02-21 11:57:16 -07002089 .setImageExtent({staging_texture.tex_width, staging_texture.tex_height, 1});
Dave Houlton5fa47912018-02-16 11:02:26 -07002090
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002091 cmd.copyBufferToImage(staging_texture.buffer, textures[i].image, vk::ImageLayout::eTransferDstOptimal, 1, &copy_region);
Dave Houlton5fa47912018-02-16 11:02:26 -07002092
2093 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::eTransferDstOptimal,
2094 textures[i].imageLayout, vk::AccessFlagBits::eTransferWrite, vk::PipelineStageFlagBits::eTransfer,
2095 vk::PipelineStageFlagBits::eFragmentShader);
2096 } else {
2097 assert(!"No support for R8G8B8A8_UNORM as texture image format");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002098 }
2099
Dave Houlton5fa47912018-02-16 11:02:26 -07002100 auto const samplerInfo = vk::SamplerCreateInfo()
2101 .setMagFilter(vk::Filter::eNearest)
2102 .setMinFilter(vk::Filter::eNearest)
2103 .setMipmapMode(vk::SamplerMipmapMode::eNearest)
2104 .setAddressModeU(vk::SamplerAddressMode::eClampToEdge)
2105 .setAddressModeV(vk::SamplerAddressMode::eClampToEdge)
2106 .setAddressModeW(vk::SamplerAddressMode::eClampToEdge)
2107 .setMipLodBias(0.0f)
2108 .setAnisotropyEnable(VK_FALSE)
2109 .setMaxAnisotropy(1)
2110 .setCompareEnable(VK_FALSE)
2111 .setCompareOp(vk::CompareOp::eNever)
2112 .setMinLod(0.0f)
2113 .setMaxLod(0.0f)
2114 .setBorderColor(vk::BorderColor::eFloatOpaqueWhite)
2115 .setUnnormalizedCoordinates(VK_FALSE);
2116
2117 auto result = device.createSampler(&samplerInfo, nullptr, &textures[i].sampler);
2118 VERIFY(result == vk::Result::eSuccess);
2119
2120 auto const viewInfo = vk::ImageViewCreateInfo()
2121 .setImage(textures[i].image)
2122 .setViewType(vk::ImageViewType::e2D)
2123 .setFormat(tex_format)
2124 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
2125
2126 result = device.createImageView(&viewInfo, nullptr, &textures[i].view);
2127 VERIFY(result == vk::Result::eSuccess);
2128 }
2129}
2130
2131vk::ShaderModule Demo::prepare_vs() {
2132 const uint32_t vertShaderCode[] = {
2133#include "cube.vert.inc"
2134 };
2135
2136 vert_shader_module = prepare_shader_module(vertShaderCode, sizeof(vertShaderCode));
2137
2138 return vert_shader_module;
2139}
2140
Charles Giessen87dd88d2022-02-03 13:46:29 -07002141void Demo::destroy_swapchain_related_resources() {
2142 device.destroyDescriptorPool(desc_pool);
Dave Houlton5fa47912018-02-16 11:02:26 -07002143
Charles Giessen87dd88d2022-02-03 13:46:29 -07002144 device.destroyPipeline(pipeline);
2145 device.destroyPipelineCache(pipelineCache);
2146 device.destroyRenderPass(render_pass);
2147 device.destroyPipelineLayout(pipeline_layout);
2148 device.destroyDescriptorSetLayout(desc_layout);
2149
2150 for (const auto &tex : textures) {
2151 device.destroyImageView(tex.view);
2152 device.destroyImage(tex.image);
2153 device.freeMemory(tex.mem);
2154 device.destroySampler(tex.sampler);
2155 }
2156
2157 device.destroyImageView(depth.view);
2158 device.destroyImage(depth.image);
2159 device.freeMemory(depth.mem);
2160
2161 for (const auto &resource : swapchain_image_resources) {
2162 device.destroyFramebuffer(resource.framebuffer);
2163 device.destroyImageView(resource.view);
2164 device.freeCommandBuffers(cmd_pool, {resource.cmd});
2165 device.destroyBuffer(resource.uniform_buffer);
2166 device.unmapMemory(resource.uniform_memory);
2167 device.freeMemory(resource.uniform_memory);
2168 }
2169
2170 device.destroyCommandPool(cmd_pool);
2171 if (separate_present_queue) {
2172 device.destroyCommandPool(present_cmd_pool);
2173 }
2174}
2175
2176void Demo::resize() {
Dave Houlton5fa47912018-02-16 11:02:26 -07002177 // Don't react to resize until after first initialization.
2178 if (!prepared) {
2179 return;
2180 }
2181
2182 // In order to properly resize the window, we must re-create the
2183 // swapchain
2184 // AND redo the command buffers, etc.
2185 //
2186 // First, perform part of the cleanup() function:
2187 prepared = false;
2188 auto result = device.waitIdle();
2189 VERIFY(result == vk::Result::eSuccess);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002190 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -07002191
2192 // Second, re-perform the prepare() function, which will re-create the
2193 // swapchain.
2194 prepare();
2195}
2196
2197void Demo::set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
2198 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages) {
2199 assert(cmd);
2200
2201 auto DstAccessMask = [](vk::ImageLayout const &layout) {
2202 vk::AccessFlags flags;
2203
2204 switch (layout) {
2205 case vk::ImageLayout::eTransferDstOptimal:
2206 // Make sure anything that was copying from this image has
2207 // completed
2208 flags = vk::AccessFlagBits::eTransferWrite;
2209 break;
2210 case vk::ImageLayout::eColorAttachmentOptimal:
2211 flags = vk::AccessFlagBits::eColorAttachmentWrite;
2212 break;
2213 case vk::ImageLayout::eDepthStencilAttachmentOptimal:
2214 flags = vk::AccessFlagBits::eDepthStencilAttachmentWrite;
2215 break;
2216 case vk::ImageLayout::eShaderReadOnlyOptimal:
2217 // Make sure any Copy or CPU writes to image are flushed
2218 flags = vk::AccessFlagBits::eShaderRead | vk::AccessFlagBits::eInputAttachmentRead;
2219 break;
2220 case vk::ImageLayout::eTransferSrcOptimal:
2221 flags = vk::AccessFlagBits::eTransferRead;
2222 break;
2223 case vk::ImageLayout::ePresentSrcKHR:
2224 flags = vk::AccessFlagBits::eMemoryRead;
2225 break;
2226 default:
2227 break;
2228 }
2229
2230 return flags;
2231 };
2232
Charles Giessen87dd88d2022-02-03 13:46:29 -07002233 cmd.pipelineBarrier(src_stages, dest_stages, vk::DependencyFlagBits(), {}, {},
2234 vk::ImageMemoryBarrier()
2235 .setSrcAccessMask(srcAccessMask)
2236 .setDstAccessMask(DstAccessMask(newLayout))
2237 .setOldLayout(oldLayout)
2238 .setNewLayout(newLayout)
2239 .setSrcQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2240 .setDstQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2241 .setImage(image)
2242 .setSubresourceRange(vk::ImageSubresourceRange(aspectMask, 0, 1, 0, 1)));
Dave Houlton5fa47912018-02-16 11:02:26 -07002243}
2244
2245void Demo::update_data_buffer() {
2246 mat4x4 VP;
2247 mat4x4_mul(VP, projection_matrix, view_matrix);
2248
2249 // Rotate around the Y axis
2250 mat4x4 Model;
2251 mat4x4_dup(Model, model_matrix);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002252 mat4x4_rotate_Y(model_matrix, Model, static_cast<float>(degreesToRadians(spin_angle)));
Arman Uguray3ae08892021-05-25 00:07:24 -07002253 mat4x4_orthonormalize(model_matrix, model_matrix);
Dave Houlton5fa47912018-02-16 11:02:26 -07002254
2255 mat4x4 MVP;
2256 mat4x4_mul(MVP, VP, model_matrix);
2257
Tony-LunarG37af49f2019-12-19 12:04:19 -07002258 memcpy(swapchain_image_resources[current_buffer].uniform_memory_ptr, (const void *)&MVP[0][0], sizeof(MVP));
Dave Houlton5fa47912018-02-16 11:02:26 -07002259}
2260
Karl Schultzb7940402018-05-29 13:09:22 -06002261/* Convert ppm image data from header file into RGBA texture image */
2262#include "lunarg.ppm.h"
Charles Giessen3bcefe52022-02-21 11:57:16 -07002263bool Demo::loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout &layout, uint32_t &width, uint32_t &height) {
Karl Schultzb7940402018-05-29 13:09:22 -06002264 (void)filename;
2265 char *cPtr;
2266 cPtr = (char *)lunarg_ppm;
2267 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "P6\n", 3)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002268 return false;
2269 }
Karl Schultzb7940402018-05-29 13:09:22 -06002270 while (strncmp(cPtr++, "\n", 1))
2271 ;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002272 sscanf(cPtr, "%u %u", &width, &height);
Charles Giessenc2f1a942022-02-06 23:38:39 -07002273 if (rgba_data == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002274 return true;
2275 }
Karl Schultzb7940402018-05-29 13:09:22 -06002276 while (strncmp(cPtr++, "\n", 1))
2277 ;
2278 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "255\n", 4)) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002279 return false;
2280 }
Karl Schultzb7940402018-05-29 13:09:22 -06002281 while (strncmp(cPtr++, "\n", 1))
2282 ;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002283 for (uint32_t y = 0; y < height; y++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002284 uint8_t *rowPtr = rgba_data;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002285 for (uint32_t x = 0; x < width; x++) {
Karl Schultzb7940402018-05-29 13:09:22 -06002286 memcpy(rowPtr, cPtr, 3);
Dave Houlton5fa47912018-02-16 11:02:26 -07002287 rowPtr[3] = 255; /* Alpha of 1 */
2288 rowPtr += 4;
Karl Schultzb7940402018-05-29 13:09:22 -06002289 cPtr += 3;
Dave Houlton5fa47912018-02-16 11:02:26 -07002290 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07002291 rgba_data += layout.rowPitch;
Dave Houlton5fa47912018-02-16 11:02:26 -07002292 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002293 return true;
2294}
2295
Charles Giessen87dd88d2022-02-03 13:46:29 -07002296bool Demo::memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002297 // Search memtypes to find first index with those properties
2298 for (uint32_t i = 0; i < VK_MAX_MEMORY_TYPES; i++) {
2299 if ((typeBits & 1) == 1) {
2300 // Type is available, does it match user properties?
2301 if ((memory_properties.memoryTypes[i].propertyFlags & requirements_mask) == requirements_mask) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002302 typeIndex = i;
Dave Houlton5fa47912018-02-16 11:02:26 -07002303 return true;
2304 }
2305 }
2306 typeBits >>= 1;
2307 }
2308
2309 // No memory types matched, return failure
2310 return false;
2311}
2312
Charles Giessen7dc2dd52022-02-03 13:55:48 -07002313vk::SurfaceFormatKHR Demo::pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats) {
2314 // Prefer non-SRGB formats...
2315 for (const auto &surface_format : surface_formats) {
2316 const vk::Format format = surface_format.format;
2317
2318 if (format == vk::Format::eR8G8B8A8Unorm || format == vk::Format::eB8G8R8A8Unorm ||
2319 format == vk::Format::eA2B10G10R10UnormPack32 || format == vk::Format::eA2R10G10B10UnormPack32 ||
2320 format == vk::Format::eR16G16B16A16Sfloat) {
2321 return surface_format;
2322 }
2323 }
2324
2325 printf("Can't find our preferred formats... Falling back to first exposed format. Rendering may be incorrect.\n");
2326
2327 assert(surface_formats.size() >= 1);
2328 return surface_formats[0];
2329}
2330
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002331#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07002332void Demo::run() {
2333 if (!prepared) {
2334 return;
2335 }
2336
2337 draw();
2338 curFrame++;
2339
Petr Krausd88e4e52019-01-23 18:45:04 +01002340 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002341 PostQuitMessage(validation_error);
2342 }
2343}
2344
2345void Demo::create_window() {
2346 WNDCLASSEX win_class;
2347
2348 // Initialize the window class structure:
2349 win_class.cbSize = sizeof(WNDCLASSEX);
2350 win_class.style = CS_HREDRAW | CS_VREDRAW;
2351 win_class.lpfnWndProc = WndProc;
2352 win_class.cbClsExtra = 0;
2353 win_class.cbWndExtra = 0;
2354 win_class.hInstance = connection; // hInstance
2355 win_class.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
2356 win_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
2357 win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
2358 win_class.lpszMenuName = nullptr;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002359 win_class.lpszClassName = name.c_str();
Dave Houlton5fa47912018-02-16 11:02:26 -07002360 win_class.hIconSm = LoadIcon(nullptr, IDI_WINLOGO);
2361
2362 // Register window class:
2363 if (!RegisterClassEx(&win_class)) {
2364 // It didn't work, so try to give a useful error:
2365 printf("Unexpected error trying to start the application!\n");
2366 fflush(stdout);
2367 exit(1);
2368 }
2369
2370 // Create window with the registered class:
2371 RECT wr = {0, 0, static_cast<LONG>(width), static_cast<LONG>(height)};
2372 AdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
2373 window = CreateWindowEx(0,
Charles Giessen87dd88d2022-02-03 13:46:29 -07002374 name.c_str(), // class name
2375 name.c_str(), // app name
Dave Houlton5fa47912018-02-16 11:02:26 -07002376 WS_OVERLAPPEDWINDOW | // window style
2377 WS_VISIBLE | WS_SYSMENU,
2378 100, 100, // x/y coords
2379 wr.right - wr.left, // width
2380 wr.bottom - wr.top, // height
2381 nullptr, // handle to parent
2382 nullptr, // handle to menu
2383 connection, // hInstance
2384 nullptr); // no extra parameters
2385
2386 if (!window) {
2387 // It didn't work, so try to give a useful error:
2388 printf("Cannot create a window in which to draw!\n");
2389 fflush(stdout);
2390 exit(1);
2391 }
2392
2393 // Window client area size must be at least 1 pixel high, to prevent
2394 // crash.
2395 minsize.x = GetSystemMetrics(SM_CXMINTRACK);
2396 minsize.y = GetSystemMetrics(SM_CYMINTRACK) + 1;
2397}
2398#elif defined(VK_USE_PLATFORM_XLIB_KHR)
2399
2400void Demo::create_xlib_window() {
2401 const char *display_envar = getenv("DISPLAY");
2402 if (display_envar == nullptr || display_envar[0] == '\0') {
2403 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
2404 fflush(stdout);
2405 exit(1);
2406 }
2407
2408 XInitThreads();
2409 display = XOpenDisplay(nullptr);
2410 long visualMask = VisualScreenMask;
2411 int numberOfVisuals;
2412 XVisualInfo vInfoTemplate = {};
2413 vInfoTemplate.screen = DefaultScreen(display);
2414 XVisualInfo *visualInfo = XGetVisualInfo(display, visualMask, &vInfoTemplate, &numberOfVisuals);
2415
2416 Colormap colormap = XCreateColormap(display, RootWindow(display, vInfoTemplate.screen), visualInfo->visual, AllocNone);
2417
2418 XSetWindowAttributes windowAttributes = {};
2419 windowAttributes.colormap = colormap;
2420 windowAttributes.background_pixel = 0xFFFFFFFF;
2421 windowAttributes.border_pixel = 0;
2422 windowAttributes.event_mask = KeyPressMask | KeyReleaseMask | StructureNotifyMask | ExposureMask;
2423
2424 xlib_window =
2425 XCreateWindow(display, RootWindow(display, vInfoTemplate.screen), 0, 0, width, height, 0, visualInfo->depth, InputOutput,
2426 visualInfo->visual, CWBackPixel | CWBorderPixel | CWEventMask | CWColormap, &windowAttributes);
2427
2428 XSelectInput(display, xlib_window, ExposureMask | KeyPressMask);
2429 XMapWindow(display, xlib_window);
2430 XFlush(display);
2431 xlib_wm_delete_window = XInternAtom(display, "WM_DELETE_WINDOW", False);
2432}
2433
2434void Demo::handle_xlib_event(const XEvent *event) {
2435 switch (event->type) {
2436 case ClientMessage:
2437 if ((Atom)event->xclient.data.l[0] == xlib_wm_delete_window) {
2438 quit = true;
2439 }
2440 break;
2441 case KeyPress:
2442 switch (event->xkey.keycode) {
2443 case 0x9: // Escape
2444 quit = true;
2445 break;
2446 case 0x71: // left arrow key
2447 spin_angle -= spin_increment;
2448 break;
2449 case 0x72: // right arrow key
2450 spin_angle += spin_increment;
2451 break;
2452 case 0x41: // space bar
2453 pause = !pause;
2454 break;
2455 }
2456 break;
2457 case ConfigureNotify:
2458 if (((int32_t)width != event->xconfigure.width) || ((int32_t)height != event->xconfigure.height)) {
2459 width = event->xconfigure.width;
2460 height = event->xconfigure.height;
2461 resize();
2462 }
2463 break;
2464 default:
2465 break;
2466 }
2467}
2468
2469void Demo::run_xlib() {
2470 while (!quit) {
2471 XEvent event;
2472
2473 if (pause) {
2474 XNextEvent(display, &event);
2475 handle_xlib_event(&event);
2476 }
2477 while (XPending(display) > 0) {
2478 XNextEvent(display, &event);
2479 handle_xlib_event(&event);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002480 }
2481
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002482 draw();
2483 curFrame++;
2484
Dave Houlton5fa47912018-02-16 11:02:26 -07002485 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2486 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002487 }
2488 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002489}
Tony Barbour153cb062016-12-07 13:43:36 -07002490#elif defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002491
Dave Houlton5fa47912018-02-16 11:02:26 -07002492void Demo::handle_xcb_event(const xcb_generic_event_t *event) {
2493 uint8_t event_code = event->response_type & 0x7f;
2494 switch (event_code) {
2495 case XCB_EXPOSE:
2496 // TODO: Resize window
2497 break;
2498 case XCB_CLIENT_MESSAGE:
2499 if ((*(xcb_client_message_event_t *)event).data.data32[0] == (*atom_wm_delete_window).atom) {
2500 quit = true;
2501 }
2502 break;
2503 case XCB_KEY_RELEASE: {
2504 const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002505
Dave Houlton5fa47912018-02-16 11:02:26 -07002506 switch (key->detail) {
2507 case 0x9: // Escape
2508 quit = true;
2509 break;
2510 case 0x71: // left arrow key
2511 spin_angle -= spin_increment;
2512 break;
2513 case 0x72: // right arrow key
2514 spin_angle += spin_increment;
2515 break;
2516 case 0x41: // space bar
2517 pause = !pause;
2518 break;
2519 }
2520 } break;
2521 case XCB_CONFIGURE_NOTIFY: {
2522 const xcb_configure_notify_event_t *cfg = (const xcb_configure_notify_event_t *)event;
2523 if ((width != cfg->width) || (height != cfg->height)) {
2524 width = cfg->width;
2525 height = cfg->height;
2526 resize();
2527 }
2528 } break;
2529 default:
2530 break;
2531 }
2532}
2533
2534void Demo::run_xcb() {
2535 xcb_flush(connection);
2536
2537 while (!quit) {
2538 xcb_generic_event_t *event;
2539
2540 if (pause) {
2541 event = xcb_wait_for_event(connection);
2542 } else {
2543 event = xcb_poll_for_event(connection);
2544 }
2545 while (event) {
2546 handle_xcb_event(event);
2547 free(event);
2548 event = xcb_poll_for_event(connection);
2549 }
2550
2551 draw();
2552 curFrame++;
2553 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2554 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002555 }
2556 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002557}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002558
Dave Houlton5fa47912018-02-16 11:02:26 -07002559void Demo::create_xcb_window() {
2560 uint32_t value_mask, value_list[32];
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002561
Dave Houlton5fa47912018-02-16 11:02:26 -07002562 xcb_window = xcb_generate_id(connection);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002563
Dave Houlton5fa47912018-02-16 11:02:26 -07002564 value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
2565 value_list[0] = screen->black_pixel;
2566 value_list[1] = XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002567
Dave Houlton5fa47912018-02-16 11:02:26 -07002568 xcb_create_window(connection, XCB_COPY_FROM_PARENT, xcb_window, screen->root, 0, 0, width, height, 0,
2569 XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
2570
2571 /* Magic code that will send notification when window is destroyed */
2572 xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
2573 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
2574
2575 xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
2576 atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
2577
2578 xcb_change_property(connection, XCB_PROP_MODE_REPLACE, xcb_window, (*reply).atom, 4, 32, 1, &(*atom_wm_delete_window).atom);
2579
2580 free(reply);
2581
2582 xcb_map_window(connection, xcb_window);
2583
2584 // Force the x/y coordinates to 100,100 results are identical in
2585 // consecutive
2586 // runs
Charles Giessen87dd88d2022-02-03 13:46:29 -07002587 std::array<uint32_t, 2> const coords = {100, 100};
2588 xcb_configure_window(connection, xcb_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, coords.data());
Dave Houlton5fa47912018-02-16 11:02:26 -07002589}
2590#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2591
2592void Demo::run() {
2593 while (!quit) {
2594 if (pause) {
2595 wl_display_dispatch(display);
2596 } else {
2597 wl_display_dispatch_pending(display);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002598 draw();
2599 curFrame++;
Jeremy Hayes9d304782016-10-09 11:48:12 -06002600 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002601 quit = true;
2602 }
2603 }
2604 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002605}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002606
Manuel Stoecklac939332019-06-26 20:55:53 -04002607static void handle_surface_configure(void *data, xdg_surface *xdg_surface, uint32_t serial) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002608 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002609 xdg_surface_ack_configure(xdg_surface, serial);
Charles Giessen3bcefe52022-02-21 11:57:16 -07002610 if (demo.xdg_surface_has_been_configured) {
2611 demo.resize();
Manuel Stoecklac939332019-06-26 20:55:53 -04002612 }
Charles Giessen3bcefe52022-02-21 11:57:16 -07002613 demo.xdg_surface_has_been_configured = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002614}
2615
2616static const xdg_surface_listener surface_listener = {handle_surface_configure};
2617
2618static void handle_toplevel_configure(void *data, xdg_toplevel *xdg_toplevel, int32_t width, int32_t height,
2619 struct wl_array *states) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002620 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002621 /* zero values imply the program may choose its own size, so in that case
2622 * stay with the existing value (which on startup is the default) */
2623 if (width > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002624 demo.width = static_cast<uint32_t>(width);
Manuel Stoecklac939332019-06-26 20:55:53 -04002625 }
2626 if (height > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002627 demo.height = static_cast<uint32_t>(height);
Manuel Stoecklac939332019-06-26 20:55:53 -04002628 }
2629 // This will be followed by a surface configure
2630}
2631
2632static void handle_toplevel_close(void *data, xdg_toplevel *xdg_toplevel) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002633 Demo &demo = *static_cast<Demo *>(data);
2634 demo.quit = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002635}
2636
2637static const xdg_toplevel_listener toplevel_listener = {handle_toplevel_configure, handle_toplevel_close};
2638
Dave Houlton5fa47912018-02-16 11:02:26 -07002639void Demo::create_window() {
Manuel Stoecklac939332019-06-26 20:55:53 -04002640 if (!wm_base) {
2641 printf("Compositor did not provide the standard protocol xdg-wm-base\n");
2642 fflush(stdout);
2643 exit(1);
2644 }
2645
Dave Houlton5fa47912018-02-16 11:02:26 -07002646 window = wl_compositor_create_surface(compositor);
2647 if (!window) {
2648 printf("Can not create wayland_surface from compositor!\n");
2649 fflush(stdout);
2650 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002651 }
2652
Manuel Stoecklac939332019-06-26 20:55:53 -04002653 window_surface = xdg_wm_base_get_xdg_surface(wm_base, window);
2654 if (!window_surface) {
2655 printf("Can not get xdg_surface from wayland_surface!\n");
Dave Houlton5fa47912018-02-16 11:02:26 -07002656 fflush(stdout);
2657 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002658 }
Manuel Stoecklac939332019-06-26 20:55:53 -04002659 window_toplevel = xdg_surface_get_toplevel(window_surface);
2660 if (!window_toplevel) {
2661 printf("Can not allocate xdg_toplevel for xdg_surface!\n");
2662 fflush(stdout);
2663 exit(1);
2664 }
2665 xdg_surface_add_listener(window_surface, &surface_listener, this);
2666 xdg_toplevel_add_listener(window_toplevel, &toplevel_listener, this);
2667 xdg_toplevel_set_title(window_toplevel, APP_SHORT_NAME);
2668 if (xdg_decoration_mgr) {
2669 // if supported, let the compositor render titlebars for us
2670 toplevel_decoration = zxdg_decoration_manager_v1_get_toplevel_decoration(xdg_decoration_mgr, window_toplevel);
2671 zxdg_toplevel_decoration_v1_set_mode(toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
2672 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002673
Manuel Stoecklac939332019-06-26 20:55:53 -04002674 wl_surface_commit(window);
Dave Houlton5fa47912018-02-16 11:02:26 -07002675}
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002676#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
2677
2678void Demo::handle_directfb_event(const DFBInputEvent *event) {
2679 if (event->type != DIET_KEYPRESS) return;
2680 switch (event->key_symbol) {
2681 case DIKS_ESCAPE: // Escape
2682 quit = true;
2683 break;
2684 case DIKS_CURSOR_LEFT: // left arrow key
2685 spin_angle -= spin_increment;
2686 break;
2687 case DIKS_CURSOR_RIGHT: // right arrow key
2688 spin_angle += spin_increment;
2689 break;
2690 case DIKS_SPACE: // space bar
2691 pause = !pause;
2692 break;
2693 default:
2694 break;
2695 }
2696}
2697
2698void Demo::run_directfb() {
2699 while (!quit) {
2700 DFBInputEvent event;
2701
2702 if (pause) {
2703 event_buffer->WaitForEvent(event_buffer);
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002704 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002705 } else {
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002706 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002707
2708 draw();
2709 curFrame++;
2710 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2711 quit = true;
2712 }
2713 }
2714 }
2715}
2716
2717void Demo::create_directfb_window() {
2718 DFBResult ret;
2719
Charles Giessenc2f1a942022-02-06 23:38:39 -07002720 ret = DirectFBInit(nullptr, nullptr);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002721 if (ret) {
2722 printf("DirectFBInit failed to initialize DirectFB!\n");
2723 fflush(stdout);
2724 exit(1);
2725 }
2726
2727 ret = DirectFBCreate(&dfb);
2728 if (ret) {
2729 printf("DirectFBCreate failed to create main interface of DirectFB!\n");
2730 fflush(stdout);
2731 exit(1);
2732 }
2733
2734 DFBSurfaceDescription desc;
2735 desc.flags = (DFBSurfaceDescriptionFlags)(DSDESC_CAPS | DSDESC_WIDTH | DSDESC_HEIGHT);
2736 desc.caps = DSCAPS_PRIMARY;
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002737 desc.width = width;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002738 desc.height = height;
2739 ret = dfb->CreateSurface(dfb, &desc, &window);
2740 if (ret) {
2741 printf("CreateSurface failed to create DirectFB surface interface!\n");
2742 fflush(stdout);
2743 exit(1);
2744 }
2745
2746 ret = dfb->CreateInputEventBuffer(dfb, DICAPS_KEYS, DFB_FALSE, &event_buffer);
2747 if (ret) {
2748 printf("CreateInputEventBuffer failed to create DirectFB event buffer interface!\n");
2749 fflush(stdout);
2750 exit(1);
2751 }
2752}
Bill Hollings0a0625a2019-07-15 17:39:18 -04002753#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -06002754void Demo::run() {
2755 draw();
2756 curFrame++;
2757 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2758 quit = true;
2759 }
2760}
Damien Leone600c3052017-01-31 10:26:07 -07002761#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2762
Dave Houlton5fa47912018-02-16 11:02:26 -07002763vk::Result Demo::create_display_surface() {
Charles Giessenc2f1a942022-02-06 23:38:39 -07002764 auto display_properties_return = gpu.getDisplayPropertiesKHR();
2765 VERIFY((display_properties_return.result == vk::Result::eSuccess) ||
2766 (display_properties_return.result == vk::Result::eIncomplete));
Damien Leone600c3052017-01-31 10:26:07 -07002767
Charles Giessenc2f1a942022-02-06 23:38:39 -07002768 auto display = display_properties_return.value.at(0).display;
Dave Houlton5fa47912018-02-16 11:02:26 -07002769
Charles Giessenc2f1a942022-02-06 23:38:39 -07002770 auto display_mode_props_return = gpu.getDisplayModePropertiesKHR(display);
2771 VERIFY(display_mode_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002772
Charles Giessenc2f1a942022-02-06 23:38:39 -07002773 if (display_mode_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002774 printf("Cannot find any mode for the display!\n");
2775 fflush(stdout);
2776 exit(1);
2777 }
Charles Giessenc2f1a942022-02-06 23:38:39 -07002778 auto display_mode_prop = display_mode_props_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002779
2780 // Get the list of planes
Charles Giessenc2f1a942022-02-06 23:38:39 -07002781 auto display_plane_props_return = gpu.getDisplayPlanePropertiesKHR();
2782 VERIFY(display_plane_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002783
Charles Giessenc2f1a942022-02-06 23:38:39 -07002784 if (display_plane_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002785 printf("Cannot find any plane!\n");
2786 fflush(stdout);
2787 exit(1);
2788 }
2789
Charles Giessenc2f1a942022-02-06 23:38:39 -07002790 vk::Bool32 found_plane = VK_FALSE;
Dave Houlton5fa47912018-02-16 11:02:26 -07002791 // Find a plane compatible with the display
Charles Giessenc2f1a942022-02-06 23:38:39 -07002792 for (uint32_t plane_index = 0; plane_index < display_plane_props_return.value.size(); plane_index++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002793 // Disqualify planes that are bound to a different display
2794 if (plane_props[plane_index].currentDisplay && (plane_props[plane_index].currentDisplay != display)) {
2795 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002796 }
2797
Charles Giessenc2f1a942022-02-06 23:38:39 -07002798 auto display_plane_supported_displays_return = gpu.getDisplayPlaneSupportedDisplaysKHR(plane_index);
2799 VERIFY(display_plane_supported_displays_return.result == vk::Result::eSuccess);
Damien Leone600c3052017-01-31 10:26:07 -07002800
Charles Giessenc2f1a942022-02-06 23:38:39 -07002801 if (display_plane_supported_displays_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002802 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002803 }
2804
Charles Giessenc2f1a942022-02-06 23:38:39 -07002805 for (const auto &supported_display : display_plane_supported_displays_return.value) {
2806 if (supported_display == display) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002807 found_plane = VK_TRUE;
Damien Leone600c3052017-01-31 10:26:07 -07002808 break;
2809 }
2810 }
2811
Dave Houlton5fa47912018-02-16 11:02:26 -07002812 if (found_plane) {
2813 break;
Damien Leone600c3052017-01-31 10:26:07 -07002814 }
2815 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002816
2817 if (!found_plane) {
2818 printf("Cannot find a plane compatible with the display!\n");
2819 fflush(stdout);
2820 exit(1);
2821 }
2822
Charles Giessenc2f1a942022-02-06 23:38:39 -07002823 vk::DisplayPlaneCapabilitiesKHR planeCaps = gpu.getDisplayPlaneCapabilitiesKHR(mode_props.displayMode, plane_index);
Dave Houlton5fa47912018-02-16 11:02:26 -07002824 // Find a supported alpha mode
2825 vk::DisplayPlaneAlphaFlagBitsKHR alphaMode = vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002826 std::array<vk::DisplayPlaneAlphaFlagBitsKHR, 4> alphaModes = {
Dave Houlton5fa47912018-02-16 11:02:26 -07002827 vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque,
2828 vk::DisplayPlaneAlphaFlagBitsKHR::eGlobal,
2829 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixel,
2830 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixelPremultiplied,
2831 };
Charles Giessen87dd88d2022-02-03 13:46:29 -07002832 for (const auto &alpha_mode : alphaModes) {
2833 if (planeCaps.supportedAlpha & alpha_mode) {
2834 alphaMode = alpha_mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07002835 break;
2836 }
2837 }
2838
Charles Giessenc2f1a942022-02-06 23:38:39 -07002839 vk::Extent2D image_extent{};
2840 image_extent.setWidth(mode_props.parameters.visibleRegion.width).setHeight(mode_props.parameters.visibleRegion.height);
Dave Houlton5fa47912018-02-16 11:02:26 -07002841
2842 auto const createInfo = vk::DisplaySurfaceCreateInfoKHR()
2843 .setDisplayMode(mode_props.displayMode)
2844 .setPlaneIndex(plane_index)
2845 .setPlaneStackIndex(plane_props[plane_index].currentStackIndex)
2846 .setGlobalAlpha(1.0f)
2847 .setAlphaMode(alphaMode)
2848 .setImageExtent(image_extent);
2849
2850 return inst.createDisplayPlaneSurfaceKHR(&createInfo, nullptr, &surface);
2851}
2852
2853void Demo::run_display() {
2854 while (!quit) {
2855 draw();
2856 curFrame++;
2857
Petr Krausd88e4e52019-01-23 18:45:04 +01002858 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002859 quit = true;
2860 }
2861 }
2862}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002863#endif
2864
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002865#if _WIN32
2866// Include header required for parsing the command line options.
2867#include <shellapi.h>
2868
2869Demo demo;
2870
2871// MS-Windows event handling function:
Jeremy Hayes9d304782016-10-09 11:48:12 -06002872LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
2873 switch (uMsg) {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002874 case WM_CLOSE:
2875 PostQuitMessage(validation_error);
2876 break;
2877 case WM_PAINT:
2878 demo.run();
2879 break;
2880 case WM_GETMINMAXINFO: // set window's minimum size
2881 ((MINMAXINFO *)lParam)->ptMinTrackSize = demo.minsize;
2882 return 0;
Aaron Hagan500b9c32018-10-03 21:56:29 -04002883 case WM_ERASEBKGND:
2884 return 1;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002885 case WM_SIZE:
2886 // Resize the application to the new window size, except when
2887 // it was minimized. Vulkan doesn't support images or swapchains
2888 // with width=0 and height=0.
2889 if (wParam != SIZE_MINIMIZED) {
2890 demo.width = lParam & 0xffff;
2891 demo.height = (lParam & 0xffff0000) >> 16;
2892 demo.resize();
2893 }
2894 break;
Petr Krausd88e4e52019-01-23 18:45:04 +01002895 case WM_KEYDOWN:
2896 switch (wParam) {
2897 case VK_ESCAPE:
2898 PostQuitMessage(validation_error);
2899 break;
2900 case VK_LEFT:
2901 demo.spin_angle -= demo.spin_increment;
2902 break;
2903 case VK_RIGHT:
2904 demo.spin_angle += demo.spin_increment;
2905 break;
2906 case VK_SPACE:
2907 demo.pause = !demo.pause;
2908 break;
2909 }
2910 return 0;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002911 default:
2912 break;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002913 }
2914
2915 return (DefWindowProc(hWnd, uMsg, wParam, lParam));
2916}
2917
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07002918int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR pCmdLine, int nCmdShow) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002919 // TODO: Gah.. refactor. This isn't 1989.
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002920 MSG msg; // message
2921 bool done; // flag saying when app is complete
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002922 int argc;
2923 char **argv;
2924
Jamie Madillb2ff6502017-03-15 16:17:46 -04002925 // Ensure wParam is initialized.
2926 msg.wParam = 0;
2927
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002928 // Use the CommandLine functions to get the command line arguments.
2929 // Unfortunately, Microsoft outputs
2930 // this information as wide characters for Unicode, and we simply want the
2931 // Ascii version to be compatible
2932 // with the non-Windows side. So, we have to convert the information to
2933 // Ascii character strings.
2934 LPWSTR *commandLineArgs = CommandLineToArgvW(GetCommandLineW(), &argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06002935 if (nullptr == commandLineArgs) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002936 argc = 0;
2937 }
2938
Jeremy Hayes9d304782016-10-09 11:48:12 -06002939 if (argc > 0) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002940 argv = (char **)malloc(sizeof(char *) * argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06002941 if (argv == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002942 argc = 0;
Jeremy Hayes9d304782016-10-09 11:48:12 -06002943 } else {
2944 for (int iii = 0; iii < argc; iii++) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002945 size_t wideCharLen = wcslen(commandLineArgs[iii]);
2946 size_t numConverted = 0;
2947
2948 argv[iii] = (char *)malloc(sizeof(char) * (wideCharLen + 1));
Jeremy Hayes9d304782016-10-09 11:48:12 -06002949 if (argv[iii] != nullptr) {
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07002950 wcstombs_s(&numConverted, argv[iii], wideCharLen + 1, commandLineArgs[iii], wideCharLen + 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002951 }
2952 }
2953 }
Jeremy Hayes9d304782016-10-09 11:48:12 -06002954 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002955 argv = nullptr;
2956 }
2957
2958 demo.init(argc, argv);
2959
2960 // Free up the items we had to allocate for the command line arguments.
Jeremy Hayes9d304782016-10-09 11:48:12 -06002961 if (argc > 0 && argv != nullptr) {
2962 for (int iii = 0; iii < argc; iii++) {
2963 if (argv[iii] != nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002964 free(argv[iii]);
2965 }
2966 }
2967 free(argv);
2968 }
2969
2970 demo.connection = hInstance;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002971 demo.name = "Vulkan Cube";
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002972 demo.create_window();
2973 demo.init_vk_swapchain();
2974
2975 demo.prepare();
2976
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002977 done = false; // initialize loop condition variable
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002978
2979 // main message loop
Jeremy Hayes9d304782016-10-09 11:48:12 -06002980 while (!done) {
Petr Krausd88e4e52019-01-23 18:45:04 +01002981 if (demo.pause) {
2982 const BOOL succ = WaitMessage();
2983
2984 if (!succ) {
2985 const auto &suppress_popups = demo.suppress_popups;
2986 ERR_EXIT("WaitMessage() failed on paused demo", "event loop error");
2987 }
2988 }
2989
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002990 PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE);
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002991 if (msg.message == WM_QUIT) // check for a quit message
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002992 {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07002993 done = true; // if found, quit app
Jeremy Hayes9d304782016-10-09 11:48:12 -06002994 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002995 /* Translate and dispatch to event queue*/
2996 TranslateMessage(&msg);
2997 DispatchMessage(&msg);
2998 }
2999 RedrawWindow(demo.window, nullptr, nullptr, RDW_INTERNALPAINT);
3000 }
3001
3002 demo.cleanup();
3003
Charles Giessen87dd88d2022-02-03 13:46:29 -07003004 return static_cast<int>(msg.wParam);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003005}
3006
Eleni Maria Stea8b86fba2021-07-03 17:12:30 +03003007#elif defined(__linux__) || defined(__FreeBSD__)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003008
Jeremy Hayes9d304782016-10-09 11:48:12 -06003009int main(int argc, char **argv) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003010 Demo demo;
3011
3012 demo.init(argc, argv);
3013
Tony Barbour153cb062016-12-07 13:43:36 -07003014#if defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003015 demo.create_xcb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003016#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Tony Barbour78d6b572016-11-14 14:46:33 -07003017 demo.use_xlib = true;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003018 demo.create_xlib_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003019#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003020 demo.create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003021#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3022 demo.create_directfb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003023#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003024
3025 demo.init_vk_swapchain();
3026
3027 demo.prepare();
3028
Tony Barbour153cb062016-12-07 13:43:36 -07003029#if defined(VK_USE_PLATFORM_XCB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003030 demo.run_xcb();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003031#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003032 demo.run_xlib();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003033#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003034 demo.run();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003035#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3036 demo.run_directfb();
Damien Leone600c3052017-01-31 10:26:07 -07003037#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3038 demo.run_display();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003039#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003040
3041 demo.cleanup();
3042
3043 return validation_error;
3044}
3045
Bill Hollings0a0625a2019-07-15 17:39:18 -04003046#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05003047
3048// Global function invoked from NS or UI views and controllers to create demo
Charles Giessen87dd88d2022-02-03 13:46:29 -07003049static void demo_main(Demo &demo, void *caMetalLayer, int argc, const char *argv[]) {
Karl Schultz9ceac062017-12-12 10:33:01 -05003050 demo.init(argc, (char **)argv);
Bill Hollings0a0625a2019-07-15 17:39:18 -04003051 demo.caMetalLayer = caMetalLayer;
Karl Schultz9ceac062017-12-12 10:33:01 -05003052 demo.init_vk_swapchain();
3053 demo.prepare();
3054 demo.spin_angle = 0.4f;
3055}
3056
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003057#else
3058#error "Platform not supported"
3059#endif