blob: 9000078932e9b572b13cc856b6cd5c133f877487 [file] [log] [blame]
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001/*
Tony-LunarG495604b2019-06-13 15:32:05 -06002 * Copyright (c) 2015-2019 The Khronos Group Inc.
3 * Copyright (c) 2015-2019 Valve Corporation
4 * Copyright (c) 2015-2019 LunarG, Inc.
Dave Houlton5fa47912018-02-16 11:02:26 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Jeremy Hayes <jeremy@lunarg.com>
Charles Giessen74f007d2022-02-08 14:04:45 -070019 * Author: Charles Giessen <charles@lunarg.com>
Dave Houlton5fa47912018-02-16 11:02:26 -070020 */
Richard S. Wright Jra7825742021-01-06 16:02:12 -050021
Jeremy Hayesf56427a2016-09-07 15:55:11 -060022#if defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XCB_KHR)
23#include <X11/Xutil.h>
Joey Bzdek15eb0702017-06-07 09:40:36 -060024#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
25#include <linux/input.h>
Manuel Stoecklac939332019-06-26 20:55:53 -040026#include "xdg-shell-client-header.h"
27#include "xdg-decoration-client-header.h"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060028#endif
29
30#include <cassert>
Petr Krausbc0ab752017-12-09 00:22:39 +010031#include <cinttypes>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060032#include <cstdio>
33#include <cstdlib>
34#include <cstring>
35#include <csignal>
Charles Giessenc2f1a942022-02-06 23:38:39 -070036
Tony-LunarGd74734f2019-06-04 14:11:43 -060037#include <sstream>
Charles Giessenc2f1a942022-02-06 23:38:39 -070038#include <iostream>
Jeremy Hayesf56427a2016-09-07 15:55:11 -060039#include <memory>
40
41#define VULKAN_HPP_NO_EXCEPTIONS
Shannon McPherson2abb6992019-04-05 10:46:16 -060042#define VULKAN_HPP_TYPESAFE_CONVERSION
Jeremy Hayesf56427a2016-09-07 15:55:11 -060043#include <vulkan/vulkan.hpp>
44#include <vulkan/vk_sdk_platform.h>
45
46#include "linmath.h"
47
48#ifndef NDEBUG
49#define VERIFY(x) assert(x)
50#else
51#define VERIFY(x) ((void)(x))
52#endif
53
Charles Giessen87dd88d2022-02-03 13:46:29 -070054#define APP_SHORT_NAME "vkcubepp"
Jeremy Hayesf56427a2016-09-07 15:55:11 -060055
56// Allow a maximum of two outstanding presentation operations.
Charles Giessenc2f1a942022-02-06 23:38:39 -070057constexpr uint32_t FRAME_LAG = 2;
Jeremy Hayesf56427a2016-09-07 15:55:11 -060058
59#ifdef _WIN32
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070060#define ERR_EXIT(err_msg, err_class) \
61 do { \
62 if (!suppress_popups) MessageBox(nullptr, err_msg, err_class, MB_OK); \
63 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060064 } while (0)
65#else
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070066#define ERR_EXIT(err_msg, err_class) \
67 do { \
Robert Morell4ccc6522017-02-01 14:51:00 -080068 printf("%s\n", err_msg); \
Mark Lobodzinski85dbd822017-01-26 13:34:13 -070069 fflush(stdout); \
70 exit(1); \
Jeremy Hayesf56427a2016-09-07 15:55:11 -060071 } while (0)
72#endif
73
Charles Giessen74f007d2022-02-08 14:04:45 -070074// easier to use the C function for extension functions
75PFN_vkCreateDebugUtilsMessengerEXT pfnVkCreateDebugUtilsMessengerEXT;
76PFN_vkDestroyDebugUtilsMessengerEXT pfnVkDestroyDebugUtilsMessengerEXT;
77VKAPI_ATTR VkResult VKAPI_CALL vkCreateDebugUtilsMessengerEXT(VkInstance instance,
78 const VkDebugUtilsMessengerCreateInfoEXT *pCreateInfo,
79 const VkAllocationCallbacks *pAllocator,
80 VkDebugUtilsMessengerEXT *pMessenger) {
81 return pfnVkCreateDebugUtilsMessengerEXT(instance, pCreateInfo, pAllocator, pMessenger);
82}
83
84VKAPI_ATTR void VKAPI_CALL vkDestroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessengerEXT messenger,
85 VkAllocationCallbacks const *pAllocator) {
86 return pfnVkDestroyDebugUtilsMessengerEXT(instance, messenger, pAllocator);
87}
88
Jeremy Hayes9d304782016-10-09 11:48:12 -060089struct texture_object {
Jeremy Hayesf56427a2016-09-07 15:55:11 -060090 vk::Sampler sampler;
91
92 vk::Image image;
Tony-LunarGbc9fc052018-09-21 13:47:06 -060093 vk::Buffer buffer;
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -070094 vk::ImageLayout imageLayout{vk::ImageLayout::eUndefined};
Jeremy Hayesf56427a2016-09-07 15:55:11 -060095
96 vk::MemoryAllocateInfo mem_alloc;
97 vk::DeviceMemory mem;
98 vk::ImageView view;
99
Charles Giessen3bcefe52022-02-21 11:57:16 -0700100 uint32_t tex_width{0};
101 uint32_t tex_height{0};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600102};
103
Jeremy Hayes9d304782016-10-09 11:48:12 -0600104static char const *const tex_files[] = {"lunarg.ppm"};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600105
106static int validation_error = 0;
107
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600108struct vktexcube_vs_uniform {
109 // Must start with MVP
110 float mvp[4][4];
111 float position[12 * 3][4];
112 float attr[12 * 3][4];
113};
114
115//--------------------------------------------------------------------------------------
116// Mesh and VertexFormat Data
117//--------------------------------------------------------------------------------------
118// clang-format off
119static const float g_vertex_buffer_data[] = {
120 -1.0f,-1.0f,-1.0f, // -X side
121 -1.0f,-1.0f, 1.0f,
122 -1.0f, 1.0f, 1.0f,
123 -1.0f, 1.0f, 1.0f,
124 -1.0f, 1.0f,-1.0f,
125 -1.0f,-1.0f,-1.0f,
126
127 -1.0f,-1.0f,-1.0f, // -Z side
128 1.0f, 1.0f,-1.0f,
129 1.0f,-1.0f,-1.0f,
130 -1.0f,-1.0f,-1.0f,
131 -1.0f, 1.0f,-1.0f,
132 1.0f, 1.0f,-1.0f,
133
134 -1.0f,-1.0f,-1.0f, // -Y side
135 1.0f,-1.0f,-1.0f,
136 1.0f,-1.0f, 1.0f,
137 -1.0f,-1.0f,-1.0f,
138 1.0f,-1.0f, 1.0f,
139 -1.0f,-1.0f, 1.0f,
140
141 -1.0f, 1.0f,-1.0f, // +Y side
142 -1.0f, 1.0f, 1.0f,
143 1.0f, 1.0f, 1.0f,
144 -1.0f, 1.0f,-1.0f,
145 1.0f, 1.0f, 1.0f,
146 1.0f, 1.0f,-1.0f,
147
148 1.0f, 1.0f,-1.0f, // +X side
149 1.0f, 1.0f, 1.0f,
150 1.0f,-1.0f, 1.0f,
151 1.0f,-1.0f, 1.0f,
152 1.0f,-1.0f,-1.0f,
153 1.0f, 1.0f,-1.0f,
154
155 -1.0f, 1.0f, 1.0f, // +Z side
156 -1.0f,-1.0f, 1.0f,
157 1.0f, 1.0f, 1.0f,
158 -1.0f,-1.0f, 1.0f,
159 1.0f,-1.0f, 1.0f,
160 1.0f, 1.0f, 1.0f,
161};
162
163static const float g_uv_buffer_data[] = {
164 0.0f, 1.0f, // -X side
165 1.0f, 1.0f,
166 1.0f, 0.0f,
167 1.0f, 0.0f,
168 0.0f, 0.0f,
169 0.0f, 1.0f,
170
171 1.0f, 1.0f, // -Z side
172 0.0f, 0.0f,
173 0.0f, 1.0f,
174 1.0f, 1.0f,
175 1.0f, 0.0f,
176 0.0f, 0.0f,
177
178 1.0f, 0.0f, // -Y side
179 1.0f, 1.0f,
180 0.0f, 1.0f,
181 1.0f, 0.0f,
182 0.0f, 1.0f,
183 0.0f, 0.0f,
184
185 1.0f, 0.0f, // +Y side
186 0.0f, 0.0f,
187 0.0f, 1.0f,
188 1.0f, 0.0f,
189 0.0f, 1.0f,
190 1.0f, 1.0f,
191
192 1.0f, 0.0f, // +X side
193 0.0f, 0.0f,
194 0.0f, 1.0f,
195 0.0f, 1.0f,
196 1.0f, 1.0f,
197 1.0f, 0.0f,
198
199 0.0f, 0.0f, // +Z side
200 0.0f, 1.0f,
201 1.0f, 0.0f,
202 0.0f, 1.0f,
203 1.0f, 1.0f,
204 1.0f, 0.0f,
205};
Jeremy Hayes9d304782016-10-09 11:48:12 -0600206// clang-format on
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600207
Charles Giessen87dd88d2022-02-03 13:46:29 -0700208struct SwapchainImageResources {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600209 vk::Image image;
210 vk::CommandBuffer cmd;
211 vk::CommandBuffer graphics_to_present_cmd;
212 vk::ImageView view;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600213 vk::Buffer uniform_buffer;
214 vk::DeviceMemory uniform_memory;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700215 void *uniform_memory_ptr = nullptr;
Jeremy Hayes00399e32017-06-14 15:07:32 -0600216 vk::Framebuffer framebuffer;
217 vk::DescriptorSet descriptor_set;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700218};
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600219
Joey Bzdekbaf66472017-06-07 09:37:37 -0600220struct Demo {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700221 void build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700222 vk::Bool32 check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600223 void cleanup();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700224 void destroy_swapchain_related_resources();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600225 void create_device();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700226 void destroy_texture(texture_object &tex_objs);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600227 void draw();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700228 void draw_build_cmd(const SwapchainImageResources &swapchain_image_resource);
229 void prepare_init_cmd();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600230 void flush_init_cmd();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700231 void init(int argc, char **argv);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600232 void init_connection();
233 void init_vk();
234 void init_vk_swapchain();
235 void prepare();
236 void prepare_buffers();
237 void prepare_cube_data_buffers();
238 void prepare_depth();
239 void prepare_descriptor_layout();
240 void prepare_descriptor_pool();
241 void prepare_descriptor_set();
242 void prepare_framebuffers();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700243 vk::ShaderModule prepare_shader_module(const uint32_t *code, size_t size);
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100244 vk::ShaderModule prepare_vs();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600245 vk::ShaderModule prepare_fs();
246 void prepare_pipeline();
247 void prepare_render_pass();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700248 void prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
249 vk::MemoryPropertyFlags required_props);
250 void prepare_texture_buffer(const char *filename, texture_object &tex_obj);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600251 void prepare_textures();
Petr Kraus9a4eb6a2017-11-30 14:49:20 +0100252
Joey Bzdekbaf66472017-06-07 09:37:37 -0600253 void resize();
Tony-LunarG6cebf142019-09-11 14:32:23 -0600254 void create_surface();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700255 void set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
256 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600257 void update_data_buffer();
Charles Giessen3bcefe52022-02-21 11:57:16 -0700258 bool loadTexture(const char *filename, uint8_t *rgba_data, vk::SubresourceLayout &layout, uint32_t &width, uint32_t &height);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700259 bool memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex);
Charles Giessen7dc2dd52022-02-03 13:55:48 -0700260 vk::SurfaceFormatKHR pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600261
Charles Giessen74f007d2022-02-08 14:04:45 -0700262 static VKAPI_ATTR VkBool32 VKAPI_CALL debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
263 VkDebugUtilsMessageTypeFlagsEXT messageType,
264 const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData,
265 void *pUserData);
266
Joey Bzdekbaf66472017-06-07 09:37:37 -0600267#if defined(VK_USE_PLATFORM_WIN32_KHR)
268 void run();
269 void create_window();
270#elif defined(VK_USE_PLATFORM_XLIB_KHR)
271 void create_xlib_window();
Charles Giessenc2f1a942022-02-06 23:38:39 -0700272 void handle_xlib_event(const XEvent *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600273 void run_xlib();
274#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700275 void handle_xcb_event(const xcb_generic_event_t *event);
Joey Bzdekbaf66472017-06-07 09:37:37 -0600276 void run_xcb();
277 void create_xcb_window();
278#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
279 void run();
280 void create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200281#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700282 void handle_directfb_event(const DFBInputEvent *event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200283 void run_directfb();
284 void create_directfb_window();
Bill Hollings0a0625a2019-07-15 17:39:18 -0400285#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -0600286 void run();
Joey Bzdekbaf66472017-06-07 09:37:37 -0600287#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
288 vk::Result create_display_surface();
289 void run_display();
290#endif
291
Charles Giessenc2f1a942022-02-06 23:38:39 -0700292 std::string name = "vkcubepp"; // Name to put on the window/icon
Joey Bzdekbaf66472017-06-07 09:37:37 -0600293#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700294 HINSTANCE connection = nullptr; // hInstance - Windows Instance
295 HWND window = nullptr; // hWnd - window handle
296 POINT minsize = {0, 0}; // minimum window size
Joey Bzdekbaf66472017-06-07 09:37:37 -0600297#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700298 Window xlib_window = 0;
299 Atom xlib_wm_delete_window = 0;
300 Display *display = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600301#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700302 xcb_window_t xcb_window = 0;
303 xcb_screen_t *screen = nullptr;
304 xcb_connection_t *connection = nullptr;
305 xcb_intern_atom_reply_t *atom_wm_delete_window = nullptr;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600306#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700307 wl_display *display = nullptr;
308 wl_registry *registry = nullptr;
309 wl_compositor *compositor = nullptr;
310 wl_surface *window = nullptr;
311 xdg_wm_base *wm_base = nullptr;
312 zxdg_decoration_manager_v1 *xdg_decoration_mgr = nullptr;
313 zxdg_toplevel_decoration_v1 *toplevel_decoration = nullptr;
314 xdg_surface *window_surface = nullptr;
315 bool xdg_surface_has_been_configured = false;
316 xdg_toplevel *window_toplevel = nullptr;
317 wl_seat *seat = nullptr;
318 wl_pointer *pointer = nullptr;
319 wl_keyboard *keyboard = nullptr;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200320#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700321 IDirectFB *dfb = nullptr;
322 IDirectFBSurface *window = nullptr;
323 IDirectFBEventBuffer *event_buffer = nullptr;
Bill Hollings0a0625a2019-07-15 17:39:18 -0400324#elif defined(VK_USE_PLATFORM_METAL_EXT)
325 void *caMetalLayer;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600326#endif
327
328 vk::SurfaceKHR surface;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700329 bool prepared = false;
330 bool use_staging_buffer = false;
331 bool use_xlib = false;
332 bool separate_present_queue = false;
333 int32_t gpu_number = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600334
335 vk::Instance inst;
Charles Giessen74f007d2022-02-08 14:04:45 -0700336 vk::DebugUtilsMessengerEXT debug_messenger;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600337 vk::PhysicalDevice gpu;
338 vk::Device device;
339 vk::Queue graphics_queue;
340 vk::Queue present_queue;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700341 uint32_t graphics_queue_family_index = 0;
342 uint32_t present_queue_family_index = 0;
343 std::array<vk::Semaphore, FRAME_LAG> image_acquired_semaphores;
344 std::array<vk::Semaphore, FRAME_LAG> draw_complete_semaphores;
345 std::array<vk::Semaphore, FRAME_LAG> image_ownership_semaphores;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600346 vk::PhysicalDeviceProperties gpu_props;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700347 std::vector<vk::QueueFamilyProperties> queue_props;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600348 vk::PhysicalDeviceMemoryProperties memory_properties;
349
Charles Giessen87dd88d2022-02-03 13:46:29 -0700350 std::vector<const char *> enabled_instance_extensions;
351 std::vector<const char *> enabled_layers;
352 std::vector<const char *> enabled_device_extensions;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600353
Charles Giessen3bcefe52022-02-21 11:57:16 -0700354 uint32_t width = 0;
355 uint32_t height = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600356 vk::Format format;
357 vk::ColorSpaceKHR color_space;
358
Joey Bzdekbaf66472017-06-07 09:37:37 -0600359 vk::SwapchainKHR swapchain;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700360 std::vector<SwapchainImageResources> swapchain_image_resources;
361 vk::PresentModeKHR presentMode = vk::PresentModeKHR::eFifo;
362 std::array<vk::Fence, FRAME_LAG> fences;
363 uint32_t frame_index = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600364
365 vk::CommandPool cmd_pool;
366 vk::CommandPool present_cmd_pool;
367
368 struct {
369 vk::Format format;
370 vk::Image image;
371 vk::MemoryAllocateInfo mem_alloc;
372 vk::DeviceMemory mem;
373 vk::ImageView view;
374 } depth;
375
376 static int32_t const texture_count = 1;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700377 std::array<texture_object, texture_count> textures;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600378 texture_object staging_texture;
379
380 struct {
381 vk::Buffer buf;
382 vk::MemoryAllocateInfo mem_alloc;
383 vk::DeviceMemory mem;
384 vk::DescriptorBufferInfo buffer_info;
385 } uniform_data;
386
387 vk::CommandBuffer cmd; // Buffer for initialization commands
388 vk::PipelineLayout pipeline_layout;
389 vk::DescriptorSetLayout desc_layout;
390 vk::PipelineCache pipelineCache;
391 vk::RenderPass render_pass;
392 vk::Pipeline pipeline;
393
Charles Giessenc2f1a942022-02-06 23:38:39 -0700394 mat4x4 projection_matrix = {};
395 mat4x4 view_matrix = {};
396 mat4x4 model_matrix = {};
Joey Bzdekbaf66472017-06-07 09:37:37 -0600397
Charles Giessen87dd88d2022-02-03 13:46:29 -0700398 float spin_angle = 0.0f;
399 float spin_increment = 0.0f;
400 bool pause = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600401
402 vk::ShaderModule vert_shader_module;
403 vk::ShaderModule frag_shader_module;
404
405 vk::DescriptorPool desc_pool;
406 vk::DescriptorSet desc_set;
407
Charles Giessen87dd88d2022-02-03 13:46:29 -0700408 std::vector<vk::Framebuffer> framebuffers;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600409
Charles Giessen87dd88d2022-02-03 13:46:29 -0700410 bool quit = false;
411 uint32_t curFrame = 0;
412 uint32_t frameCount = 0;
413 bool validate = false;
Charles Giessen74f007d2022-02-08 14:04:45 -0700414 bool in_callback = false;
415 bool use_debug_messenger = false;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700416 bool use_break = false;
417 bool suppress_popups = false;
418 bool force_errors = false;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600419
Charles Giessen87dd88d2022-02-03 13:46:29 -0700420 uint32_t current_buffer = 0;
Joey Bzdekbaf66472017-06-07 09:37:37 -0600421};
422
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600423#ifdef _WIN32
424// MS-Windows event handling function:
425LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
426#endif
427
Karl Schultz23cc2182016-11-23 17:15:17 -0700428#if defined(VK_USE_PLATFORM_WAYLAND_KHR)
Joey Bzdek15eb0702017-06-07 09:40:36 -0600429static void pointer_handle_enter(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t sx,
430 wl_fixed_t sy) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700431
Joey Bzdek15eb0702017-06-07 09:40:36 -0600432static void pointer_handle_leave(void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) {}
Karl Schultz23cc2182016-11-23 17:15:17 -0700433
Joey Bzdek15eb0702017-06-07 09:40:36 -0600434static void pointer_handle_motion(void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) {}
435
436static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button,
437 uint32_t state) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700438 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600439 if (button == BTN_LEFT && state == WL_POINTER_BUTTON_STATE_PRESSED) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700440 xdg_toplevel_move(demo.window_toplevel, demo.seat, serial);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600441 }
442}
443
444static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) {}
445
446static const struct wl_pointer_listener pointer_listener = {
447 pointer_handle_enter, pointer_handle_leave, pointer_handle_motion, pointer_handle_button, pointer_handle_axis,
448};
449
450static void keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) {}
451
452static void keyboard_handle_enter(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface,
453 struct wl_array *keys) {}
454
455static void keyboard_handle_leave(void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) {}
456
457static void keyboard_handle_key(void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key,
458 uint32_t state) {
459 if (state != WL_KEYBOARD_KEY_STATE_RELEASED) return;
Charles Giessen3bcefe52022-02-21 11:57:16 -0700460 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600461 switch (key) {
462 case KEY_ESC: // Escape
Charles Giessen3bcefe52022-02-21 11:57:16 -0700463 demo.quit = true;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600464 break;
465 case KEY_LEFT: // left arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700466 demo.spin_angle -= demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600467 break;
468 case KEY_RIGHT: // right arrow key
Charles Giessen3bcefe52022-02-21 11:57:16 -0700469 demo.spin_angle += demo.spin_increment;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600470 break;
471 case KEY_SPACE: // space bar
Charles Giessen3bcefe52022-02-21 11:57:16 -0700472 demo.pause = !demo.pause;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600473 break;
474 }
475}
476
477static void keyboard_handle_modifiers(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed,
478 uint32_t mods_latched, uint32_t mods_locked, uint32_t group) {}
479
480static const struct wl_keyboard_listener keyboard_listener = {
481 keyboard_handle_keymap, keyboard_handle_enter, keyboard_handle_leave, keyboard_handle_key, keyboard_handle_modifiers,
482};
483
484static void seat_handle_capabilities(void *data, wl_seat *seat, uint32_t caps) {
485 // Subscribe to pointer events
Charles Giessen3bcefe52022-02-21 11:57:16 -0700486 Demo &demo = *static_cast<Demo *>(data);
487 if ((caps & WL_SEAT_CAPABILITY_POINTER) && !demo.pointer) {
488 demo.pointer = wl_seat_get_pointer(seat);
Charles Giessene494de72022-03-31 10:07:22 -0600489 wl_pointer_add_listener(demo.pointer, &pointer_listener, &demo);
Charles Giessen3bcefe52022-02-21 11:57:16 -0700490 } else if (!(caps & WL_SEAT_CAPABILITY_POINTER) && demo.pointer) {
491 wl_pointer_destroy(demo.pointer);
492 demo.pointer = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600493 }
494 // Subscribe to keyboard events
495 if (caps & WL_SEAT_CAPABILITY_KEYBOARD) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700496 demo.keyboard = wl_seat_get_keyboard(seat);
Charles Giessene494de72022-03-31 10:07:22 -0600497 wl_keyboard_add_listener(demo.keyboard, &keyboard_listener, &demo);
shironeko689140c2022-05-19 10:21:07 -0400498 } else if (!(caps & WL_SEAT_CAPABILITY_KEYBOARD) && demo.keyboard) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700499 wl_keyboard_destroy(demo.keyboard);
500 demo.keyboard = nullptr;
Joey Bzdek15eb0702017-06-07 09:40:36 -0600501 }
502}
503
504static const wl_seat_listener seat_listener = {
505 seat_handle_capabilities,
506};
507
Manuel Stoecklac939332019-06-26 20:55:53 -0400508static void wm_base_ping(void *data, xdg_wm_base *xdg_wm_base, uint32_t serial) { xdg_wm_base_pong(xdg_wm_base, serial); }
509
510static const struct xdg_wm_base_listener wm_base_listener = {wm_base_ping};
511
Joey Bzdek15eb0702017-06-07 09:40:36 -0600512static void registry_handle_global(void *data, wl_registry *registry, uint32_t id, const char *interface, uint32_t version) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700513 Demo &demo = *static_cast<Demo *>(data);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600514 // pickup wayland objects when they appear
Manuel Stoecklac939332019-06-26 20:55:53 -0400515 if (strcmp(interface, wl_compositor_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700516 demo.compositor = (wl_compositor *)wl_registry_bind(registry, id, &wl_compositor_interface, 1);
Manuel Stoecklac939332019-06-26 20:55:53 -0400517 } else if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700518 demo.wm_base = (xdg_wm_base *)wl_registry_bind(registry, id, &xdg_wm_base_interface, 1);
519 xdg_wm_base_add_listener(demo.wm_base, &wm_base_listener, nullptr);
Manuel Stoecklac939332019-06-26 20:55:53 -0400520 } else if (strcmp(interface, wl_seat_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700521 demo.seat = (wl_seat *)wl_registry_bind(registry, id, &wl_seat_interface, 1);
Charles Giessene494de72022-03-31 10:07:22 -0600522 wl_seat_add_listener(demo.seat, &seat_listener, &demo);
Manuel Stoecklac939332019-06-26 20:55:53 -0400523 } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700524 demo.xdg_decoration_mgr =
Manuel Stoecklac939332019-06-26 20:55:53 -0400525 (zxdg_decoration_manager_v1 *)wl_registry_bind(registry, id, &zxdg_decoration_manager_v1_interface, 1);
Joey Bzdek15eb0702017-06-07 09:40:36 -0600526 }
527}
528
529static void registry_handle_global_remove(void *data, wl_registry *registry, uint32_t name) {}
530
531static const wl_registry_listener registry_listener = {registry_handle_global, registry_handle_global_remove};
Karl Schultz23cc2182016-11-23 17:15:17 -0700532#endif
533
Charles Giessenc2f1a942022-02-06 23:38:39 -0700534void Demo::build_image_ownership_cmd(const SwapchainImageResources &swapchain_image_resource) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700535 auto result = swapchain_image_resource.graphics_to_present_cmd.begin(
536 vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700537 VERIFY(result == vk::Result::eSuccess);
538
539 auto const image_ownership_barrier =
540 vk::ImageMemoryBarrier()
541 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600542 .setDstAccessMask(vk::AccessFlags())
Dave Houlton5fa47912018-02-16 11:02:26 -0700543 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
544 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
545 .setSrcQueueFamilyIndex(graphics_queue_family_index)
546 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700547 .setImage(swapchain_image_resource.image)
Dave Houlton5fa47912018-02-16 11:02:26 -0700548 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
549
Charles Giessen87dd88d2022-02-03 13:46:29 -0700550 swapchain_image_resource.graphics_to_present_cmd.pipelineBarrier(vk::PipelineStageFlagBits::eBottomOfPipe,
551 vk::PipelineStageFlagBits::eBottomOfPipe,
552 vk::DependencyFlagBits(), {}, {}, image_ownership_barrier);
Dave Houlton5fa47912018-02-16 11:02:26 -0700553
Charles Giessen87dd88d2022-02-03 13:46:29 -0700554 result = swapchain_image_resource.graphics_to_present_cmd.end();
Dave Houlton5fa47912018-02-16 11:02:26 -0700555 VERIFY(result == vk::Result::eSuccess);
556}
557
Charles Giessen87dd88d2022-02-03 13:46:29 -0700558vk::Bool32 Demo::check_layers(const std::vector<const char *> &check_names, const std::vector<vk::LayerProperties> &layers) {
559 for (const auto &name : check_names) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700560 vk::Bool32 found = VK_FALSE;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700561 for (const auto &layer : layers) {
562 if (!strcmp(name, layer.layerName)) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700563 found = VK_TRUE;
564 break;
565 }
566 }
567 if (!found) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700568 fprintf(stderr, "Cannot find layer: %s\n", name);
Dave Houlton5fa47912018-02-16 11:02:26 -0700569 return 0;
570 }
571 }
572 return VK_TRUE;
573}
574
575void Demo::cleanup() {
576 prepared = false;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700577 auto result = device.waitIdle();
578 VERIFY(result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700579
Charles Giessen87dd88d2022-02-03 13:46:29 -0700580 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -0700581 // Wait for fences from present operations
582 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700583 device.destroyFence(fences[i]);
584 device.destroySemaphore(image_acquired_semaphores[i]);
585 device.destroySemaphore(draw_complete_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700586 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700587 device.destroySemaphore(image_ownership_semaphores[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -0700588 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600589 }
590
Charles Giessen87dd88d2022-02-03 13:46:29 -0700591 device.destroySwapchainKHR(swapchain);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600592
Charles Giessen87dd88d2022-02-03 13:46:29 -0700593 device.destroy();
594 inst.destroySurfaceKHR(surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700595
596#if defined(VK_USE_PLATFORM_XLIB_KHR)
597 XDestroyWindow(display, xlib_window);
598 XCloseDisplay(display);
599#elif defined(VK_USE_PLATFORM_XCB_KHR)
600 xcb_destroy_window(connection, xcb_window);
601 xcb_disconnect(connection);
602 free(atom_wm_delete_window);
603#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
shironeko689140c2022-05-19 10:21:07 -0400604 if (keyboard) wl_keyboard_destroy(keyboard);
605 if (pointer) wl_pointer_destroy(pointer);
606 if (seat) wl_seat_destroy(seat);
Manuel Stoecklac939332019-06-26 20:55:53 -0400607 xdg_toplevel_destroy(window_toplevel);
608 xdg_surface_destroy(window_surface);
Dave Houlton5fa47912018-02-16 11:02:26 -0700609 wl_surface_destroy(window);
Manuel Stoecklac939332019-06-26 20:55:53 -0400610 xdg_wm_base_destroy(wm_base);
611 if (xdg_decoration_mgr) {
612 zxdg_toplevel_decoration_v1_destroy(toplevel_decoration);
613 zxdg_decoration_manager_v1_destroy(xdg_decoration_mgr);
614 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700615 wl_compositor_destroy(compositor);
616 wl_registry_destroy(registry);
617 wl_display_disconnect(display);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +0200618#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
619 event_buffer->Release(event_buffer);
620 window->Release(window);
621 dfb->Release(dfb);
Dave Houlton5fa47912018-02-16 11:02:26 -0700622#endif
Charles Giessen74f007d2022-02-08 14:04:45 -0700623 if (use_debug_messenger) {
624 inst.destroyDebugUtilsMessengerEXT(debug_messenger);
625 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700626 inst.destroy();
Dave Houlton5fa47912018-02-16 11:02:26 -0700627}
628
629void Demo::create_device() {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700630 float priorities = 0.0;
Dave Houlton5fa47912018-02-16 11:02:26 -0700631
Charles Giessen87dd88d2022-02-03 13:46:29 -0700632 std::vector<vk::DeviceQueueCreateInfo> queues;
633 queues.push_back(vk::DeviceQueueCreateInfo().setQueueFamilyIndex(graphics_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700634
635 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700636 queues.push_back(
637 vk::DeviceQueueCreateInfo().setQueueFamilyIndex(present_queue_family_index).setQueuePriorities(priorities));
Dave Houlton5fa47912018-02-16 11:02:26 -0700638 }
639
Charles Giessen87dd88d2022-02-03 13:46:29 -0700640 auto deviceInfo = vk::DeviceCreateInfo().setQueueCreateInfos(queues).setPEnabledExtensionNames(enabled_device_extensions);
641 auto device_return = gpu.createDevice(deviceInfo);
642 VERIFY(device_return.result == vk::Result::eSuccess);
643 device = device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -0700644}
645
Charles Giessen87dd88d2022-02-03 13:46:29 -0700646void Demo::destroy_texture(texture_object &tex_objs) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700647 // clean up staging resources
Charles Giessen87dd88d2022-02-03 13:46:29 -0700648 device.freeMemory(tex_objs.mem);
649 if (tex_objs.image) device.destroyImage(tex_objs.image);
650 if (tex_objs.buffer) device.destroyBuffer(tex_objs.buffer);
Dave Houlton5fa47912018-02-16 11:02:26 -0700651}
652
653void Demo::draw() {
654 // Ensure no more than FRAME_LAG renderings are outstanding
Charles Giessen87dd88d2022-02-03 13:46:29 -0700655 device.waitForFences(fences[frame_index], VK_TRUE, UINT64_MAX);
Mike Schuchardt7bcbfd32020-05-07 15:33:52 -0700656 device.resetFences({fences[frame_index]});
Dave Houlton5fa47912018-02-16 11:02:26 -0700657
Charles Giessenc2f1a942022-02-06 23:38:39 -0700658 vk::Result acquire_result;
Dave Houlton5fa47912018-02-16 11:02:26 -0700659 do {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700660 acquire_result =
Dave Houlton5fa47912018-02-16 11:02:26 -0700661 device.acquireNextImageKHR(swapchain, UINT64_MAX, image_acquired_semaphores[frame_index], vk::Fence(), &current_buffer);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700662 if (acquire_result == vk::Result::eErrorOutOfDateKHR) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700663 // demo.swapchain is out of date (e.g. the window was resized) and
Dave Houlton5fa47912018-02-16 11:02:26 -0700664 // must be recreated:
665 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700666 } else if (acquire_result == vk::Result::eSuboptimalKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700667 // swapchain is not as optimal as it could be, but the platform's
668 // presentation engine will still present the image correctly.
669 break;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700670 } else if (acquire_result == vk::Result::eErrorSurfaceLostKHR) {
671 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600672 create_surface();
673 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700674 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700675 VERIFY(acquire_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700676 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700677 } while (acquire_result != vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700678
679 update_data_buffer();
680
681 // Wait for the image acquired semaphore to be signaled to ensure
682 // that the image won't be rendered to until the presentation
683 // engine has fully released ownership to the application, and it is
684 // okay to render to the image.
685 vk::PipelineStageFlags const pipe_stage_flags = vk::PipelineStageFlagBits::eColorAttachmentOutput;
Dave Houlton5fa47912018-02-16 11:02:26 -0700686
Charles Giessen87dd88d2022-02-03 13:46:29 -0700687 auto submit_result = graphics_queue.submit(vk::SubmitInfo()
688 .setWaitDstStageMask(pipe_stage_flags)
689 .setWaitSemaphores(image_acquired_semaphores[frame_index])
690 .setCommandBuffers(swapchain_image_resources[current_buffer].cmd)
691 .setSignalSemaphores(draw_complete_semaphores[frame_index]),
692 fences[frame_index]);
693 VERIFY(submit_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700694
695 if (separate_present_queue) {
696 // If we are using separate queues, change image ownership to the
697 // present queue before presenting, waiting for the draw complete
698 // semaphore and signalling the ownership released semaphore when
699 // finished
Charles Giessen87dd88d2022-02-03 13:46:29 -0700700 auto change_owner_result =
701 present_queue.submit(vk::SubmitInfo()
702 .setWaitDstStageMask(pipe_stage_flags)
703 .setWaitSemaphores(draw_complete_semaphores[frame_index])
704 .setCommandBuffers(swapchain_image_resources[current_buffer].graphics_to_present_cmd)
705 .setSignalSemaphores(image_ownership_semaphores[frame_index]));
706 VERIFY(change_owner_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700707 }
708
Juan Ramos8d2d3e22022-10-19 16:51:58 -0600709 const auto presentInfo = vk::PresentInfoKHR()
710 .setWaitSemaphores(separate_present_queue ? image_ownership_semaphores[frame_index]
711 : draw_complete_semaphores[frame_index])
712 .setSwapchains(swapchain)
713 .setImageIndices(current_buffer);
714
Dave Houlton5fa47912018-02-16 11:02:26 -0700715 // If we are using separate queues we have to wait for image ownership,
716 // otherwise wait for draw complete
Juan Ramos8d2d3e22022-10-19 16:51:58 -0600717 auto present_result = present_queue.presentKHR(&presentInfo);
Dave Houlton5fa47912018-02-16 11:02:26 -0700718 frame_index += 1;
719 frame_index %= FRAME_LAG;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700720 if (present_result == vk::Result::eErrorOutOfDateKHR) {
Dave Houlton5fa47912018-02-16 11:02:26 -0700721 // swapchain is out of date (e.g. the window was resized) and
722 // must be recreated:
723 resize();
Charles Giessen87dd88d2022-02-03 13:46:29 -0700724 } else if (present_result == vk::Result::eSuboptimalKHR) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600725 // SUBOPTIMAL could be due to resize
726 vk::SurfaceCapabilitiesKHR surfCapabilities;
Charles Giessen87dd88d2022-02-03 13:46:29 -0700727 auto caps_result = gpu.getSurfaceCapabilitiesKHR(surface, &surfCapabilities);
728 VERIFY(caps_result == vk::Result::eSuccess);
Charles Giessen3bcefe52022-02-21 11:57:16 -0700729 if (surfCapabilities.currentExtent.width != width || surfCapabilities.currentExtent.height != height) {
Tony-LunarGa8e96342021-06-04 15:12:55 -0600730 resize();
731 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700732 } else if (present_result == vk::Result::eErrorSurfaceLostKHR) {
733 inst.destroySurfaceKHR(surface);
Tony-LunarG6cebf142019-09-11 14:32:23 -0600734 create_surface();
735 resize();
Dave Houlton5fa47912018-02-16 11:02:26 -0700736 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700737 VERIFY(present_result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -0700738 }
739}
740
Charles Giessen87dd88d2022-02-03 13:46:29 -0700741void Demo::draw_build_cmd(const SwapchainImageResources &swapchain_image_resource) {
742 const auto commandBuffer = swapchain_image_resource.cmd;
Dave Houlton5fa47912018-02-16 11:02:26 -0700743 vk::ClearValue const clearValues[2] = {vk::ClearColorValue(std::array<float, 4>({{0.2f, 0.2f, 0.2f, 0.2f}})),
744 vk::ClearDepthStencilValue(1.0f, 0u)};
745
Charles Giessen87dd88d2022-02-03 13:46:29 -0700746 auto result = commandBuffer.begin(vk::CommandBufferBeginInfo().setFlags(vk::CommandBufferUsageFlagBits::eSimultaneousUse));
Dave Houlton5fa47912018-02-16 11:02:26 -0700747 VERIFY(result == vk::Result::eSuccess);
748
Charles Giessen87dd88d2022-02-03 13:46:29 -0700749 commandBuffer.beginRenderPass(vk::RenderPassBeginInfo()
750 .setRenderPass(render_pass)
751 .setFramebuffer(swapchain_image_resource.framebuffer)
Charles Giessen3bcefe52022-02-21 11:57:16 -0700752 .setRenderArea(vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)))
Charles Giessen87dd88d2022-02-03 13:46:29 -0700753 .setClearValueCount(2)
754 .setPClearValues(clearValues),
755 vk::SubpassContents::eInline);
756
Dave Houlton5fa47912018-02-16 11:02:26 -0700757 commandBuffer.bindPipeline(vk::PipelineBindPoint::eGraphics, pipeline);
Charles Giessen87dd88d2022-02-03 13:46:29 -0700758 commandBuffer.bindDescriptorSets(vk::PipelineBindPoint::eGraphics, pipeline_layout, 0, swapchain_image_resource.descriptor_set,
Charles Giessenc2f1a942022-02-06 23:38:39 -0700759 {});
Jeremy Kniager979b5312019-11-22 14:55:57 -0700760 float viewport_dimension;
761 float viewport_x = 0.0f;
762 float viewport_y = 0.0f;
763 if (width < height) {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700764 viewport_dimension = static_cast<float>(width);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700765 viewport_y = (height - width) / 2.0f;
766 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -0700767 viewport_dimension = static_cast<float>(height);
Jeremy Kniager979b5312019-11-22 14:55:57 -0700768 viewport_x = (width - height) / 2.0f;
769 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700770
Charles Giessen87dd88d2022-02-03 13:46:29 -0700771 commandBuffer.setViewport(0, vk::Viewport()
772 .setX(viewport_x)
773 .setY(viewport_y)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700774 .setWidth(viewport_dimension)
775 .setHeight(viewport_dimension)
776 .setMinDepth(0.0f)
777 .setMaxDepth(1.0f));
Charles Giessen87dd88d2022-02-03 13:46:29 -0700778
Charles Giessen3bcefe52022-02-21 11:57:16 -0700779 commandBuffer.setScissor(0, vk::Rect2D(vk::Offset2D{}, vk::Extent2D(width, height)));
Dave Houlton5fa47912018-02-16 11:02:26 -0700780 commandBuffer.draw(12 * 3, 1, 0, 0);
781 // Note that ending the renderpass changes the image's layout from
782 // COLOR_ATTACHMENT_OPTIMAL to PRESENT_SRC_KHR
783 commandBuffer.endRenderPass();
784
785 if (separate_present_queue) {
786 // We have to transfer ownership from the graphics queue family to
787 // the
788 // present queue family to be able to present. Note that we don't
789 // have
790 // to transfer from present queue family back to graphics queue
791 // family at
792 // the start of the next frame because we don't care about the
793 // image's
794 // contents at that point.
Charles Giessen87dd88d2022-02-03 13:46:29 -0700795 commandBuffer.pipelineBarrier(
796 vk::PipelineStageFlagBits::eBottomOfPipe, vk::PipelineStageFlagBits::eBottomOfPipe, vk::DependencyFlagBits(), {}, {},
Jeremy Hayes9d304782016-10-09 11:48:12 -0600797 vk::ImageMemoryBarrier()
798 .setSrcAccessMask(vk::AccessFlags())
Tony-LunarG4ba65cd2018-05-30 14:53:14 -0600799 .setDstAccessMask(vk::AccessFlags())
Jeremy Hayes9d304782016-10-09 11:48:12 -0600800 .setOldLayout(vk::ImageLayout::ePresentSrcKHR)
801 .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
802 .setSrcQueueFamilyIndex(graphics_queue_family_index)
803 .setDstQueueFamilyIndex(present_queue_family_index)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700804 .setImage(swapchain_image_resource.image)
805 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1)));
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600806 }
807
Dave Houlton5fa47912018-02-16 11:02:26 -0700808 result = commandBuffer.end();
809 VERIFY(result == vk::Result::eSuccess);
810}
811
Charles Giessen87dd88d2022-02-03 13:46:29 -0700812void Demo::prepare_init_cmd() {
813 auto cmd_pool_return = device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(graphics_queue_family_index));
814 VERIFY(cmd_pool_return.result == vk::Result::eSuccess);
815 cmd_pool = cmd_pool_return.value;
816
817 auto cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
818 .setCommandPool(cmd_pool)
819 .setLevel(vk::CommandBufferLevel::ePrimary)
820 .setCommandBufferCount(1));
821 VERIFY(cmd_return.result == vk::Result::eSuccess);
822 cmd = cmd_return.value[0];
823
824 auto result = cmd.begin(vk::CommandBufferBeginInfo());
825 VERIFY(result == vk::Result::eSuccess);
826}
827
Dave Houlton5fa47912018-02-16 11:02:26 -0700828void Demo::flush_init_cmd() {
Dave Houlton5fa47912018-02-16 11:02:26 -0700829 auto result = cmd.end();
830 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600831
Mark Young43c08f82021-11-30 16:38:25 -0700832 auto fenceInfo = vk::FenceCreateInfo();
833 if (force_errors) {
834 // Remove sType to intentionally force validation layer errors.
835 fenceInfo.sType = vk::StructureType::eRenderPassBeginInfo;
836 }
Charles Giessen87dd88d2022-02-03 13:46:29 -0700837 auto fence_return = device.createFence(fenceInfo);
838 VERIFY(fence_return.result == vk::Result::eSuccess);
839 auto fence = fence_return.value;
840
841 result = graphics_queue.submit(vk::SubmitInfo().setCommandBuffers(cmd), fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700842 VERIFY(result == vk::Result::eSuccess);
843
Charles Giessen87dd88d2022-02-03 13:46:29 -0700844 result = device.waitForFences(fence, VK_TRUE, UINT64_MAX);
Dave Houlton5fa47912018-02-16 11:02:26 -0700845 VERIFY(result == vk::Result::eSuccess);
846
Charles Giessen87dd88d2022-02-03 13:46:29 -0700847 device.freeCommandBuffers(cmd_pool, cmd);
848 device.destroyFence(fence);
Dave Houlton5fa47912018-02-16 11:02:26 -0700849}
850
851void Demo::init(int argc, char **argv) {
852 vec3 eye = {0.0f, 3.0f, 5.0f};
853 vec3 origin = {0, 0, 0};
854 vec3 up = {0.0f, 1.0f, 0.0};
855
856 presentMode = vk::PresentModeKHR::eFifo;
857 frameCount = UINT32_MAX;
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100858 width = 500;
859 height = 500;
Dave Houlton5fa47912018-02-16 11:02:26 -0700860 use_xlib = false;
Witold Baryluka3b988f2021-01-07 19:03:02 +0000861 /* Autodetect suitable / best GPU by default */
862 gpu_number = -1;
Tony-LunarG6cebf142019-09-11 14:32:23 -0600863
Dave Houlton5fa47912018-02-16 11:02:26 -0700864 for (int i = 1; i < argc; i++) {
865 if (strcmp(argv[i], "--use_staging") == 0) {
866 use_staging_buffer = true;
867 continue;
868 }
869 if ((strcmp(argv[i], "--present_mode") == 0) && (i < argc - 1)) {
Charles Giessen3bcefe52022-02-21 11:57:16 -0700870 presentMode = static_cast<vk::PresentModeKHR>(atoi(argv[i + 1]));
Dave Houlton5fa47912018-02-16 11:02:26 -0700871 i++;
872 continue;
873 }
874 if (strcmp(argv[i], "--break") == 0) {
875 use_break = true;
876 continue;
877 }
878 if (strcmp(argv[i], "--validate") == 0) {
879 validate = true;
880 continue;
881 }
882 if (strcmp(argv[i], "--xlib") == 0) {
883 fprintf(stderr, "--xlib is deprecated and no longer does anything");
884 continue;
885 }
886 if (strcmp(argv[i], "--c") == 0 && frameCount == UINT32_MAX && i < argc - 1 &&
887 sscanf(argv[i + 1], "%" SCNu32, &frameCount) == 1) {
888 i++;
889 continue;
890 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700891 if (strcmp(argv[i], "--width") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &width) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100892 i++;
893 continue;
894 }
Charles Giessen3bcefe52022-02-21 11:57:16 -0700895 if (strcmp(argv[i], "--height") == 0 && i < argc - 1 && sscanf(argv[i + 1], "%" SCNu32, &height) == 1) {
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100896 i++;
897 continue;
898 }
Dave Houlton5fa47912018-02-16 11:02:26 -0700899 if (strcmp(argv[i], "--suppress_popups") == 0) {
900 suppress_popups = true;
901 continue;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600902 }
Tony-LunarG50e737c2020-07-16 14:26:03 -0600903 if ((strcmp(argv[i], "--gpu_number") == 0) && (i < argc - 1)) {
904 gpu_number = atoi(argv[i + 1]);
Witold Baryluka3b988f2021-01-07 19:03:02 +0000905 assert(gpu_number >= 0);
Tony-LunarG50e737c2020-07-16 14:26:03 -0600906 i++;
907 continue;
908 }
Mark Young43c08f82021-11-30 16:38:25 -0700909 if (strcmp(argv[i], "--force_errors") == 0) {
910 force_errors = true;
911 continue;
912 }
Tony-LunarGd74734f2019-06-04 14:11:43 -0600913 std::stringstream usage;
914 usage << "Usage:\n " << APP_SHORT_NAME << "\t[--use_staging] [--validate]\n"
915 << "\t[--break] [--c <framecount>] [--suppress_popups]\n"
Tony-LunarG50e737c2020-07-16 14:26:03 -0600916 << "\t[--gpu_number <index of physical device>]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600917 << "\t[--present_mode <present mode enum>]\n"
Nicolas Caramelli7c25ce92021-01-08 17:46:07 +0100918 << "\t[--width <width>] [--height <height>]\n"
Mark Young43c08f82021-11-30 16:38:25 -0700919 << "\t[--force_errors]\n"
Tony-LunarGd74734f2019-06-04 14:11:43 -0600920 << "\t<present_mode_enum>\n"
921 << "\t\tVK_PRESENT_MODE_IMMEDIATE_KHR = " << VK_PRESENT_MODE_IMMEDIATE_KHR << "\n"
922 << "\t\tVK_PRESENT_MODE_MAILBOX_KHR = " << VK_PRESENT_MODE_MAILBOX_KHR << "\n"
923 << "\t\tVK_PRESENT_MODE_FIFO_KHR = " << VK_PRESENT_MODE_FIFO_KHR << "\n"
Witold Baryluka3b988f2021-01-07 19:03:02 +0000924 << "\t\tVK_PRESENT_MODE_FIFO_RELAXED_KHR = " << VK_PRESENT_MODE_FIFO_RELAXED_KHR << "\n";
Tony-LunarGd74734f2019-06-04 14:11:43 -0600925
926#if defined(_WIN32)
Charles Giessenc2f1a942022-02-06 23:38:39 -0700927 if (!suppress_popups) MessageBox(nullptr, usage.str().c_str(), "Usage Error", MB_OK);
Tony-LunarGd74734f2019-06-04 14:11:43 -0600928#else
929 std::cerr << usage.str();
930 std::cerr.flush();
931#endif
Dave Houlton5fa47912018-02-16 11:02:26 -0700932 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600933 }
934
Dave Houlton5fa47912018-02-16 11:02:26 -0700935 if (!use_xlib) {
936 init_connection();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600937 }
938
Dave Houlton5fa47912018-02-16 11:02:26 -0700939 init_vk();
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600940
Dave Houlton5fa47912018-02-16 11:02:26 -0700941 spin_angle = 4.0f;
942 spin_increment = 0.2f;
943 pause = false;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600944
Charles Giessen87dd88d2022-02-03 13:46:29 -0700945 mat4x4_perspective(projection_matrix, static_cast<float>(degreesToRadians(45.0f)), 1.0f, 0.1f, 100.0f);
Dave Houlton5fa47912018-02-16 11:02:26 -0700946 mat4x4_look_at(view_matrix, eye, origin, up);
947 mat4x4_identity(model_matrix);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600948
Dave Houlton5fa47912018-02-16 11:02:26 -0700949 projection_matrix[1][1] *= -1; // Flip projection matrix from GL to Vulkan orientation.
950}
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600951
Dave Houlton5fa47912018-02-16 11:02:26 -0700952void Demo::init_connection() {
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600953#if defined(VK_USE_PLATFORM_XCB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -0700954 const xcb_setup_t *setup;
955 xcb_screen_iterator_t iter;
956 int scr;
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600957
Dave Houlton5fa47912018-02-16 11:02:26 -0700958 const char *display_envar = getenv("DISPLAY");
959 if (display_envar == nullptr || display_envar[0] == '\0') {
960 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
961 fflush(stdout);
962 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600963 }
964
Dave Houlton5fa47912018-02-16 11:02:26 -0700965 connection = xcb_connect(nullptr, &scr);
966 if (xcb_connection_has_error(connection) > 0) {
C Stout05c61712021-08-20 13:19:01 -0700967 printf("Cannot connect to XCB.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700968 fflush(stdout);
969 exit(1);
970 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600971
Dave Houlton5fa47912018-02-16 11:02:26 -0700972 setup = xcb_get_setup(connection);
973 iter = xcb_setup_roots_iterator(setup);
974 while (scr-- > 0) xcb_screen_next(&iter);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600975
Dave Houlton5fa47912018-02-16 11:02:26 -0700976 screen = iter.data;
977#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
978 display = wl_display_connect(nullptr);
Jeremy Hayesf56427a2016-09-07 15:55:11 -0600979
Dave Houlton5fa47912018-02-16 11:02:26 -0700980 if (display == nullptr) {
C Stout05c61712021-08-20 13:19:01 -0700981 printf("Cannot connect to wayland.\nExiting ...\n");
Dave Houlton5fa47912018-02-16 11:02:26 -0700982 fflush(stdout);
983 exit(1);
984 }
985
986 registry = wl_display_get_registry(display);
987 wl_registry_add_listener(registry, &registry_listener, this);
988 wl_display_dispatch(display);
Dave Houlton5fa47912018-02-16 11:02:26 -0700989#endif
990}
Tony-LunarG27c21242021-03-11 16:28:19 -0700991#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -0700992int find_display_gpu(int gpu_number, const std::vector<vk::PhysicalDevice> &physical_devices) {
Tony-LunarG27c21242021-03-11 16:28:19 -0700993 uint32_t display_count = 0;
Tony-LunarG27c21242021-03-11 16:28:19 -0700994 int gpu_return = gpu_number;
995 if (gpu_number >= 0) {
Charles Giessenc2f1a942022-02-06 23:38:39 -0700996 auto display_props_return = physical_devices[gpu_number].getDisplayPropertiesKHR();
997 VERIFY(display_props_return.result == vk::Result::eSuccess);
Charles Giessen431f3b52022-03-30 16:17:29 -0600998 display_count = display_props_return.value.size();
Tony-LunarG27c21242021-03-11 16:28:19 -0700999 } else {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001000 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001001 auto display_props_return = physical_devices[i].getDisplayPropertiesKHR();
1002 VERIFY(display_props_return.result == vk::Result::eSuccess);
1003 if (display_props_return.value.size() > 0) {
Charles Giessen431f3b52022-03-30 16:17:29 -06001004 display_count = display_props_return.value.size();
Tony-LunarG27c21242021-03-11 16:28:19 -07001005 gpu_return = i;
1006 break;
1007 }
1008 }
1009 }
1010 if (display_count > 0)
1011 return gpu_return;
1012 else
1013 return -1;
1014}
1015#endif
Charles Giessen74f007d2022-02-08 14:04:45 -07001016VKAPI_ATTR VkBool32 VKAPI_CALL Demo::debug_messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
1017 VkDebugUtilsMessageTypeFlagsEXT messageType,
1018 const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData,
1019 void *pUserData) {
1020 std::ostringstream message;
1021 Demo &demo = *static_cast<Demo *>(pUserData);
1022
1023 if (demo.use_break) {
1024#ifndef WIN32
1025 raise(SIGTRAP);
1026#else
1027 DebugBreak();
1028#endif
1029 }
1030 message << vk::to_string(vk::DebugUtilsMessageSeverityFlagBitsEXT(messageSeverity));
1031 message << " : " + vk::to_string(vk::DebugUtilsMessageTypeFlagsEXT(messageType));
1032
1033 if (vk::DebugUtilsMessageTypeFlagsEXT(messageType) & vk::DebugUtilsMessageTypeFlagBitsEXT::eValidation) {
1034 validation_error = 1;
1035 }
1036
1037 message << " - Message Id Number: " << std::to_string(pCallbackData->messageIdNumber);
1038 message << " | Message Id Name: " << pCallbackData->pMessageIdName << "\n\t" << pCallbackData->pMessage << "\n";
1039
1040 if (pCallbackData->objectCount > 0) {
1041 message << "\n\tObjects - " << pCallbackData->objectCount << "\n";
1042 for (uint32_t object = 0; object < pCallbackData->objectCount; ++object) {
1043 if (NULL != pCallbackData->pObjects[object].pObjectName && strlen(pCallbackData->pObjects[object].pObjectName) > 0) {
1044 message << "\t\tObject[" << object << "] - "
1045 << vk::to_string(vk::ObjectType(pCallbackData->pObjects[object].objectType)) << ", Handle "
1046 << pCallbackData->pObjects[object].objectHandle << ", Name \""
1047 << pCallbackData->pObjects[object].pObjectName << "\"\n";
1048 } else {
1049 message << "\t\tObject[" << object << "] - "
1050 << vk::to_string(vk::ObjectType(pCallbackData->pObjects[object].objectType)) << ", Handle "
1051 << pCallbackData->pObjects[object].objectHandle << "\n";
1052 }
1053 }
1054 }
1055 if (pCallbackData->cmdBufLabelCount > 0) {
1056 message << "\n\tCommand Buffer Labels - " << pCallbackData->cmdBufLabelCount << "\n";
1057 for (uint32_t cmd_buf_label = 0; cmd_buf_label < pCallbackData->cmdBufLabelCount; ++cmd_buf_label) {
1058 message << "\t\tLabel[" << cmd_buf_label << "] - " << pCallbackData->pCmdBufLabels[cmd_buf_label].pLabelName << " { "
1059 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[0] << ", "
1060 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[1] << ", "
1061 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[2] << ", "
1062 << pCallbackData->pCmdBufLabels[cmd_buf_label].color[2] << "}\n";
1063 }
1064 }
1065
1066#ifdef _WIN32
1067
1068 if (!demo.suppress_popups) {
1069 demo.in_callback = true;
1070 auto message_string = message.str();
1071 MessageBox(NULL, message_string.c_str(), "Alert", MB_OK);
1072 demo.in_callback = false;
1073 }
1074
1075#elif defined(ANDROID)
1076
1077 if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) {
1078 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message.str());
1079 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
1080 __android_log_print(ANDROID_LOG_WARN, APP_SHORT_NAME, "%s", message.str());
1081 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
1082 __android_log_print(ANDROID_LOG_ERROR, APP_SHORT_NAME, "%s", message.str());
1083 } else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) {
1084 __android_log_print(ANDROID_LOG_VERBOSE, APP_SHORT_NAME, "%s", message.str());
1085 } else {
1086 __android_log_print(ANDROID_LOG_INFO, APP_SHORT_NAME, "%s", message.str());
1087 }
1088
1089#else
1090 std::cout << message.str() << std::endl; // use endl to force a flush
1091#endif
1092 return false; // Don't bail out, but keep going.
1093}
1094
Dave Houlton5fa47912018-02-16 11:02:26 -07001095void Demo::init_vk() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001096 std::vector<char const *> instance_validation_layers = {"VK_LAYER_KHRONOS_validation"};
Dave Houlton5fa47912018-02-16 11:02:26 -07001097
Dave Houlton5fa47912018-02-16 11:02:26 -07001098 // Look for validation layers
1099 vk::Bool32 validation_found = VK_FALSE;
1100 if (validate) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001101 auto layers = vk::enumerateInstanceLayerProperties();
1102 VERIFY(layers.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001103
Charles Giessen87dd88d2022-02-03 13:46:29 -07001104 validation_found = check_layers(instance_validation_layers, layers.value);
1105 if (validation_found) {
1106 enabled_layers.push_back("VK_LAYER_KHRONOS_validation");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001107 }
1108
Charles Giessen87dd88d2022-02-03 13:46:29 -07001109 else {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001110 ERR_EXIT(
Dave Houlton5fa47912018-02-16 11:02:26 -07001111 "vkEnumerateInstanceLayerProperties failed to find required validation layer.\n\n"
1112 "Please look at the Getting Started guide for additional information.\n",
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07001113 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001114 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001115 }
1116
Dave Houlton5fa47912018-02-16 11:02:26 -07001117 /* Look for instance extensions */
1118 vk::Bool32 surfaceExtFound = VK_FALSE;
1119 vk::Bool32 platformSurfaceExtFound = VK_FALSE;
Charles Giessen5f3ce242022-04-11 14:39:06 -06001120 bool portabilityEnumerationActive = false;
Dave Houlton5fa47912018-02-16 11:02:26 -07001121
Charles Giessen87dd88d2022-02-03 13:46:29 -07001122 auto instance_extensions_return = vk::enumerateInstanceExtensionProperties();
1123 VERIFY(instance_extensions_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001124
Charles Giessen87dd88d2022-02-03 13:46:29 -07001125 for (const auto &extension : instance_extensions_return.value) {
1126 if (!strcmp(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, extension.extensionName)) {
1127 enabled_instance_extensions.push_back(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME);
Charles Giessen74f007d2022-02-08 14:04:45 -07001128 } else if (!strcmp(VK_EXT_DEBUG_UTILS_EXTENSION_NAME, extension.extensionName)) {
1129 use_debug_messenger = true;
1130 enabled_instance_extensions.push_back(VK_EXT_DEBUG_UTILS_EXTENSION_NAME);
Charles Giessen5f3ce242022-04-11 14:39:06 -06001131 } else if (!strcmp(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME, extension.extensionName)) {
1132 // We want cube to be able to enumerate drivers that support the portability_subset extension, so we have to enable the
1133 // portability enumeration extension.
1134 portabilityEnumerationActive = true;
Charles Giessendd7e8d22022-05-26 15:26:32 -06001135 enabled_instance_extensions.push_back(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001136 } else if (!strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001137 surfaceExtFound = 1;
1138 enabled_instance_extensions.push_back(VK_KHR_SURFACE_EXTENSION_NAME);
1139 }
1140#if defined(VK_USE_PLATFORM_WIN32_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001141 else if (!strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001142 platformSurfaceExtFound = 1;
1143 enabled_instance_extensions.push_back(VK_KHR_WIN32_SURFACE_EXTENSION_NAME);
1144 }
1145#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001146 else if (!strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001147 platformSurfaceExtFound = 1;
1148 enabled_instance_extensions.push_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME);
1149 }
1150#elif defined(VK_USE_PLATFORM_XCB_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001151 else if (!strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001152 platformSurfaceExtFound = 1;
1153 enabled_instance_extensions.push_back(VK_KHR_XCB_SURFACE_EXTENSION_NAME);
1154 }
1155#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001156 else if (!strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001157 platformSurfaceExtFound = 1;
1158 enabled_instance_extensions.push_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME);
1159 }
1160#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001161 else if (!strcmp(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001162 platformSurfaceExtFound = 1;
1163 enabled_instance_extensions.push_back(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME);
1164 }
1165#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001166 else if (!strcmp(VK_KHR_DISPLAY_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001167 platformSurfaceExtFound = 1;
1168 enabled_instance_extensions.push_back(VK_KHR_DISPLAY_EXTENSION_NAME);
1169 }
1170#elif defined(VK_USE_PLATFORM_METAL_EXT)
Charles Giessenc2f1a942022-02-06 23:38:39 -07001171 else if (!strcmp(VK_EXT_METAL_SURFACE_EXTENSION_NAME, extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001172 platformSurfaceExtFound = 1;
1173 enabled_instance_extensions.push_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
1174 }
1175#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001176 }
1177
1178 if (!surfaceExtFound) {
1179 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_SURFACE_EXTENSION_NAME
1180 " extension.\n\n"
1181 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1182 "Please look at the Getting Started guide for additional information.\n",
1183 "vkCreateInstance Failure");
1184 }
1185
1186 if (!platformSurfaceExtFound) {
1187#if defined(VK_USE_PLATFORM_WIN32_KHR)
1188 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WIN32_SURFACE_EXTENSION_NAME
1189 " extension.\n\n"
1190 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1191 "Please look at the Getting Started guide for additional information.\n",
1192 "vkCreateInstance Failure");
1193#elif defined(VK_USE_PLATFORM_XCB_KHR)
1194 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XCB_SURFACE_EXTENSION_NAME
1195 " extension.\n\n"
1196 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1197 "Please look at the Getting Started guide for additional information.\n",
1198 "vkCreateInstance Failure");
1199#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1200 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME
1201 " extension.\n\n"
1202 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1203 "Please look at the Getting Started guide for additional information.\n",
1204 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001205#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001206 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_XLIB_SURFACE_EXTENSION_NAME
1207 " extension.\n\n"
1208 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1209 "Please look at the Getting Started guide for additional information.\n",
1210 "vkCreateInstance Failure");
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001211#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1212 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME
1213 " extension.\n\n"
1214 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1215 "Please look at the Getting Started guide for additional information.\n",
1216 "vkCreateInstance Failure");
Damien Leone600c3052017-01-31 10:26:07 -07001217#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07001218 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_KHR_DISPLAY_EXTENSION_NAME
1219 " extension.\n\n"
1220 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1221 "Please look at the Getting Started guide for additional information.\n",
1222 "vkCreateInstance Failure");
Bill Hollings0a0625a2019-07-15 17:39:18 -04001223#elif defined(VK_USE_PLATFORM_METAL_EXT)
1224 ERR_EXIT("vkEnumerateInstanceExtensionProperties failed to find the " VK_EXT_METAL_SURFACE_EXTENSION_NAME
Karl Schultz9ceac062017-12-12 10:33:01 -05001225 " extension.\n\nDo you have a compatible "
1226 "Vulkan installable client driver (ICD) installed?\nPlease "
1227 "look at the Getting Started guide for additional "
1228 "information.\n",
1229 "vkCreateInstance Failure");
Tony Barbour153cb062016-12-07 13:43:36 -07001230#endif
Dave Houlton5fa47912018-02-16 11:02:26 -07001231 }
Charles Giessen74f007d2022-02-08 14:04:45 -07001232
1233 vk::DebugUtilsMessageSeverityFlagsEXT severityFlags(vk::DebugUtilsMessageSeverityFlagBitsEXT::eWarning |
1234 vk::DebugUtilsMessageSeverityFlagBitsEXT::eError);
1235 vk::DebugUtilsMessageTypeFlagsEXT messageTypeFlags(vk::DebugUtilsMessageTypeFlagBitsEXT::eGeneral |
1236 vk::DebugUtilsMessageTypeFlagBitsEXT::ePerformance |
1237 vk::DebugUtilsMessageTypeFlagBitsEXT::eValidation);
1238 auto debug_utils_create_info = vk::DebugUtilsMessengerCreateInfoEXT({}, severityFlags, messageTypeFlags,
1239 &debug_messenger_callback, static_cast<void *>(this));
1240
Dave Houlton5fa47912018-02-16 11:02:26 -07001241 auto const app = vk::ApplicationInfo()
1242 .setPApplicationName(APP_SHORT_NAME)
1243 .setApplicationVersion(0)
1244 .setPEngineName(APP_SHORT_NAME)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001245 .setEngineVersion(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001246 auto const inst_info = vk::InstanceCreateInfo()
Charles Giessen5f3ce242022-04-11 14:39:06 -06001247 .setFlags(portabilityEnumerationActive ? vk::InstanceCreateFlagBits::eEnumeratePortabilityKHR
1248 : static_cast<vk::InstanceCreateFlagBits>(0))
Charles Giessen74f007d2022-02-08 14:04:45 -07001249 .setPNext((use_debug_messenger && validate) ? &debug_utils_create_info : nullptr)
Dave Houlton5fa47912018-02-16 11:02:26 -07001250 .setPApplicationInfo(&app)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001251 .setPEnabledLayerNames(enabled_layers)
1252 .setPEnabledExtensionNames(enabled_instance_extensions);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001253
Charles Giessen87dd88d2022-02-03 13:46:29 -07001254 auto instance_result = vk::createInstance(inst_info);
1255 if (instance_result.result == vk::Result::eErrorIncompatibleDriver) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001256 ERR_EXIT(
1257 "Cannot find a compatible Vulkan installable client driver (ICD).\n\n"
1258 "Please look at the Getting Started guide for additional information.\n",
1259 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001260 } else if (instance_result.result == vk::Result::eErrorExtensionNotPresent) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001261 ERR_EXIT(
1262 "Cannot find a specified extension library.\n"
1263 "Make sure your layers path is set appropriately.\n",
1264 "vkCreateInstance Failure");
Charles Giessen87dd88d2022-02-03 13:46:29 -07001265 } else if (instance_result.result != vk::Result::eSuccess) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001266 ERR_EXIT(
1267 "vkCreateInstance failed.\n\n"
1268 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1269 "Please look at the Getting Started guide for additional information.\n",
1270 "vkCreateInstance Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001271 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07001272 inst = instance_result.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001273
Charles Giessen74f007d2022-02-08 14:04:45 -07001274 if (use_debug_messenger) {
1275 pfnVkCreateDebugUtilsMessengerEXT =
1276 reinterpret_cast<PFN_vkCreateDebugUtilsMessengerEXT>(inst.getProcAddr("vkCreateDebugUtilsMessengerEXT"));
1277 pfnVkDestroyDebugUtilsMessengerEXT =
1278 reinterpret_cast<PFN_vkDestroyDebugUtilsMessengerEXT>(inst.getProcAddr("vkDestroyDebugUtilsMessengerEXT"));
1279 VERIFY(pfnVkCreateDebugUtilsMessengerEXT != nullptr && pfnVkDestroyDebugUtilsMessengerEXT != nullptr);
1280 auto create_debug_messenger_return = inst.createDebugUtilsMessengerEXT(debug_utils_create_info);
1281 VERIFY(create_debug_messenger_return.result == vk::Result::eSuccess);
1282 debug_messenger = create_debug_messenger_return.value;
1283 }
1284
Charles Giessen87dd88d2022-02-03 13:46:29 -07001285 auto physical_device_return = inst.enumeratePhysicalDevices();
1286 VERIFY(physical_device_return.result == vk::Result::eSuccess);
1287 auto physical_devices = physical_device_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001288
Charles Giessen87dd88d2022-02-03 13:46:29 -07001289 if (physical_devices.size() <= 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001290 ERR_EXIT(
1291 "vkEnumeratePhysicalDevices reported zero accessible devices.\n\n"
1292 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1293 "Please look at the Getting Started guide for additional information.\n",
1294 "vkEnumeratePhysicalDevices Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001295 }
1296
Charles Giessen87dd88d2022-02-03 13:46:29 -07001297 if (gpu_number >= 0 && !(static_cast<uint32_t>(gpu_number) < physical_devices.size())) {
1298 fprintf(stderr, "GPU %d specified is not present, GPU count = %zu\n", gpu_number, physical_devices.size());
Witold Baryluka3b988f2021-01-07 19:03:02 +00001299 ERR_EXIT("Specified GPU number is not present", "User Error");
1300 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001301#if defined(VK_USE_PLATFORM_DISPLAY_KHR)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001302 gpu_number = find_display_gpu(gpu_number, physical_devices);
Tony-LunarG27c21242021-03-11 16:28:19 -07001303 if (gpu_number < 0) {
1304 printf("Cannot find any display!\n");
1305 fflush(stdout);
1306 exit(1);
1307 }
1308#else
Witold Baryluka3b988f2021-01-07 19:03:02 +00001309 /* Try to auto select most suitable device */
1310 if (gpu_number == -1) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001311 constexpr uint32_t device_type_count = static_cast<uint32_t>(vk::PhysicalDeviceType::eCpu) + 1;
1312 std::array<uint32_t, device_type_count> count_device_type{};
Witold Baryluka3b988f2021-01-07 19:03:02 +00001313
Charles Giessen87dd88d2022-02-03 13:46:29 -07001314 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001315 const auto physicalDeviceProperties = physical_devices[i].getProperties();
Charles Giessen87dd88d2022-02-03 13:46:29 -07001316 assert(physicalDeviceProperties.deviceType <= vk::PhysicalDeviceType::eCpu);
Witold Baryluka3b988f2021-01-07 19:03:02 +00001317 count_device_type[static_cast<int>(physicalDeviceProperties.deviceType)]++;
1318 }
1319
Charles Giessen87dd88d2022-02-03 13:46:29 -07001320 std::array<vk::PhysicalDeviceType, device_type_count> const device_type_preference = {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001321 vk::PhysicalDeviceType::eDiscreteGpu, vk::PhysicalDeviceType::eIntegratedGpu, vk::PhysicalDeviceType::eVirtualGpu,
1322 vk::PhysicalDeviceType::eCpu, vk::PhysicalDeviceType::eOther};
Charles Giessen87dd88d2022-02-03 13:46:29 -07001323
Witold Baryluka3b988f2021-01-07 19:03:02 +00001324 vk::PhysicalDeviceType search_for_device_type = vk::PhysicalDeviceType::eDiscreteGpu;
1325 for (uint32_t i = 0; i < sizeof(device_type_preference) / sizeof(vk::PhysicalDeviceType); i++) {
1326 if (count_device_type[static_cast<int>(device_type_preference[i])]) {
1327 search_for_device_type = device_type_preference[i];
1328 break;
1329 }
1330 }
1331
Charles Giessen87dd88d2022-02-03 13:46:29 -07001332 for (uint32_t i = 0; i < physical_devices.size(); i++) {
Witold Baryluka3b988f2021-01-07 19:03:02 +00001333 const auto physicalDeviceProperties = physical_devices[i].getProperties();
1334 if (physicalDeviceProperties.deviceType == search_for_device_type) {
1335 gpu_number = i;
1336 break;
1337 }
1338 }
1339 }
Tony-LunarG27c21242021-03-11 16:28:19 -07001340#endif
Witold Baryluka3b988f2021-01-07 19:03:02 +00001341 assert(gpu_number >= 0);
1342 gpu = physical_devices[gpu_number];
1343 {
1344 auto physicalDeviceProperties = gpu.getProperties();
1345 fprintf(stderr, "Selected GPU %d: %s, type: %s\n", gpu_number, physicalDeviceProperties.deviceName.data(),
1346 to_string(physicalDeviceProperties.deviceType).c_str());
1347 }
Witold Baryluka3b988f2021-01-07 19:03:02 +00001348
Dave Houlton5fa47912018-02-16 11:02:26 -07001349 /* Look for device extensions */
Dave Houlton5fa47912018-02-16 11:02:26 -07001350 vk::Bool32 swapchainExtFound = VK_FALSE;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001351
Charles Giessen87dd88d2022-02-03 13:46:29 -07001352 auto device_extension_return = gpu.enumerateDeviceExtensionProperties();
1353 VERIFY(device_extension_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07001354
Charles Giessen87dd88d2022-02-03 13:46:29 -07001355 for (const auto &extension : device_extension_return.value) {
1356 if (!strcmp(VK_KHR_SWAPCHAIN_EXTENSION_NAME, extension.extensionName)) {
1357 swapchainExtFound = 1;
1358 enabled_device_extensions.push_back(VK_KHR_SWAPCHAIN_EXTENSION_NAME);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001359 } else if (!strcmp("VK_KHR_portability_subset", extension.extensionName)) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001360 enabled_device_extensions.push_back("VK_KHR_portability_subset");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001361 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001362 }
Jeremy Hayes6ae1f8a2016-11-16 14:47:13 -07001363
Dave Houlton5fa47912018-02-16 11:02:26 -07001364 if (!swapchainExtFound) {
1365 ERR_EXIT("vkEnumerateDeviceExtensionProperties failed to find the " VK_KHR_SWAPCHAIN_EXTENSION_NAME
1366 " extension.\n\n"
1367 "Do you have a compatible Vulkan installable client driver (ICD) installed?\n"
1368 "Please look at the Getting Started guide for additional information.\n",
1369 "vkCreateInstance Failure");
1370 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001371
Dave Houlton5fa47912018-02-16 11:02:26 -07001372 gpu.getProperties(&gpu_props);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001373
Dave Houlton5fa47912018-02-16 11:02:26 -07001374 /* Call with nullptr data to get count */
Charles Giessen87dd88d2022-02-03 13:46:29 -07001375 queue_props = gpu.getQueueFamilyProperties();
1376 assert(queue_props.size() >= 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001377
Dave Houlton5fa47912018-02-16 11:02:26 -07001378 // Query fine-grained feature support for this device.
1379 // If app has specific feature requirements it should check supported
1380 // features based on this query
1381 vk::PhysicalDeviceFeatures physDevFeatures;
1382 gpu.getFeatures(&physDevFeatures);
1383}
1384
Tony-LunarG6cebf142019-09-11 14:32:23 -06001385void Demo::create_surface() {
Dave Houlton5fa47912018-02-16 11:02:26 -07001386// Create a WSI surface for the window:
1387#if defined(VK_USE_PLATFORM_WIN32_KHR)
1388 {
1389 auto const createInfo = vk::Win32SurfaceCreateInfoKHR().setHinstance(connection).setHwnd(window);
1390
1391 auto result = inst.createWin32SurfaceKHR(&createInfo, nullptr, &surface);
1392 VERIFY(result == vk::Result::eSuccess);
1393 }
1394#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
1395 {
1396 auto const createInfo = vk::WaylandSurfaceCreateInfoKHR().setDisplay(display).setSurface(window);
1397
1398 auto result = inst.createWaylandSurfaceKHR(&createInfo, nullptr, &surface);
1399 VERIFY(result == vk::Result::eSuccess);
1400 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001401#elif defined(VK_USE_PLATFORM_XLIB_KHR)
1402 {
1403 auto const createInfo = vk::XlibSurfaceCreateInfoKHR().setDpy(display).setWindow(xlib_window);
1404
1405 auto result = inst.createXlibSurfaceKHR(&createInfo, nullptr, &surface);
1406 VERIFY(result == vk::Result::eSuccess);
1407 }
1408#elif defined(VK_USE_PLATFORM_XCB_KHR)
1409 {
1410 auto const createInfo = vk::XcbSurfaceCreateInfoKHR().setConnection(connection).setWindow(xcb_window);
1411
1412 auto result = inst.createXcbSurfaceKHR(&createInfo, nullptr, &surface);
1413 VERIFY(result == vk::Result::eSuccess);
1414 }
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02001415#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
1416 {
1417 auto const createInfo = vk::DirectFBSurfaceCreateInfoEXT().setDfb(dfb).setSurface(window);
1418
1419 auto result = inst.createDirectFBSurfaceEXT(&createInfo, nullptr, &surface);
1420 VERIFY(result == vk::Result::eSuccess);
1421 }
Bill Hollings0a0625a2019-07-15 17:39:18 -04001422#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05001423 {
Bill Hollings0a0625a2019-07-15 17:39:18 -04001424 auto const createInfo = vk::MetalSurfaceCreateInfoEXT().setPLayer(static_cast<CAMetalLayer *>(caMetalLayer));
Karl Schultz9ceac062017-12-12 10:33:01 -05001425
Bill Hollings0a0625a2019-07-15 17:39:18 -04001426 auto result = inst.createMetalSurfaceEXT(&createInfo, nullptr, &surface);
Karl Schultz9ceac062017-12-12 10:33:01 -05001427 VERIFY(result == vk::Result::eSuccess);
1428 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001429#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
1430 {
1431 auto result = create_display_surface();
1432 VERIFY(result == vk::Result::eSuccess);
1433 }
1434#endif
Tony-LunarG6cebf142019-09-11 14:32:23 -06001435}
1436
1437void Demo::init_vk_swapchain() {
1438 create_surface();
Dave Houlton5fa47912018-02-16 11:02:26 -07001439 // Iterate over each queue to learn whether it supports presenting:
Charles Giessenc2f1a942022-02-06 23:38:39 -07001440 std::vector<vk::Bool32> supportsPresent;
1441 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
1442 auto supports = gpu.getSurfaceSupportKHR(i, surface);
1443 VERIFY(supports.result == vk::Result::eSuccess);
1444 supportsPresent.push_back(supports.value);
Dave Houlton5fa47912018-02-16 11:02:26 -07001445 }
1446
1447 uint32_t graphicsQueueFamilyIndex = UINT32_MAX;
1448 uint32_t presentQueueFamilyIndex = UINT32_MAX;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001449 for (uint32_t i = 0; i < static_cast<uint32_t>(queue_props.size()); i++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001450 if (queue_props[i].queueFlags & vk::QueueFlagBits::eGraphics) {
1451 if (graphicsQueueFamilyIndex == UINT32_MAX) {
1452 graphicsQueueFamilyIndex = i;
1453 }
1454
1455 if (supportsPresent[i] == VK_TRUE) {
1456 graphicsQueueFamilyIndex = i;
1457 presentQueueFamilyIndex = i;
Jeremy Hayes00399e32017-06-14 15:07:32 -06001458 break;
1459 }
1460 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001461 }
Jeremy Hayes00399e32017-06-14 15:07:32 -06001462
Dave Houlton5fa47912018-02-16 11:02:26 -07001463 if (presentQueueFamilyIndex == UINT32_MAX) {
1464 // If didn't find a queue that supports both graphics and present,
1465 // then
1466 // find a separate present queue.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001467 for (uint32_t i = 0; i < queue_props.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001468 if (supportsPresent[i] == VK_TRUE) {
1469 presentQueueFamilyIndex = i;
1470 break;
1471 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001472 }
1473 }
1474
Dave Houlton5fa47912018-02-16 11:02:26 -07001475 // Generate error if could not find both a graphics and a present queue
1476 if (graphicsQueueFamilyIndex == UINT32_MAX || presentQueueFamilyIndex == UINT32_MAX) {
1477 ERR_EXIT("Could not find both graphics and present queues\n", "Swapchain Initialization Failure");
1478 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001479
Dave Houlton5fa47912018-02-16 11:02:26 -07001480 graphics_queue_family_index = graphicsQueueFamilyIndex;
1481 present_queue_family_index = presentQueueFamilyIndex;
1482 separate_present_queue = (graphics_queue_family_index != present_queue_family_index);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001483
Dave Houlton5fa47912018-02-16 11:02:26 -07001484 create_device();
Jeremy Hayes00399e32017-06-14 15:07:32 -06001485
Charles Giessenc2f1a942022-02-06 23:38:39 -07001486 graphics_queue = device.getQueue(graphics_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001487 if (!separate_present_queue) {
1488 present_queue = graphics_queue;
1489 } else {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001490 present_queue = device.getQueue(present_queue_family_index, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07001491 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001492
Dave Houlton5fa47912018-02-16 11:02:26 -07001493 // Get the list of VkFormat's that are supported:
Charles Giessen87dd88d2022-02-03 13:46:29 -07001494 auto surface_formats_return = gpu.getSurfaceFormatsKHR(surface);
1495 VERIFY(surface_formats_return.result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001496
Charles Giessen7dc2dd52022-02-03 13:55:48 -07001497 vk::SurfaceFormatKHR surfaceFormat = pick_surface_format(surface_formats_return.value);
1498 format = surfaceFormat.format;
1499 color_space = surfaceFormat.colorSpace;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001500
Dave Houlton5fa47912018-02-16 11:02:26 -07001501 quit = false;
1502 curFrame = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001503
Dave Houlton5fa47912018-02-16 11:02:26 -07001504 // Create semaphores to synchronize acquiring presentable buffers before
1505 // rendering and waiting for drawing to be complete before presenting
1506 auto const semaphoreCreateInfo = vk::SemaphoreCreateInfo();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001507
Dave Houlton5fa47912018-02-16 11:02:26 -07001508 // Create fences that we can use to throttle if we get too far
1509 // ahead of the image presents
1510 auto const fence_ci = vk::FenceCreateInfo().setFlags(vk::FenceCreateFlagBits::eSignaled);
1511 for (uint32_t i = 0; i < FRAME_LAG; i++) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001512 vk::Result result = device.createFence(&fence_ci, nullptr, &fences[i]);
Dave Houlton5fa47912018-02-16 11:02:26 -07001513 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001514
Dave Houlton5fa47912018-02-16 11:02:26 -07001515 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_acquired_semaphores[i]);
1516 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001517
Dave Houlton5fa47912018-02-16 11:02:26 -07001518 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &draw_complete_semaphores[i]);
1519 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001520
Dave Houlton5fa47912018-02-16 11:02:26 -07001521 if (separate_present_queue) {
1522 result = device.createSemaphore(&semaphoreCreateInfo, nullptr, &image_ownership_semaphores[i]);
Jeremy Hayes00399e32017-06-14 15:07:32 -06001523 VERIFY(result == vk::Result::eSuccess);
1524 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001525 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001526 frame_index = 0;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001527
Dave Houlton5fa47912018-02-16 11:02:26 -07001528 // Get Memory information and properties
Charles Giessen87dd88d2022-02-03 13:46:29 -07001529 memory_properties = gpu.getMemoryProperties();
Dave Houlton5fa47912018-02-16 11:02:26 -07001530}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001531
Dave Houlton5fa47912018-02-16 11:02:26 -07001532void Demo::prepare() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001533 prepare_init_cmd();
Dave Houlton5fa47912018-02-16 11:02:26 -07001534
1535 prepare_buffers();
1536 prepare_depth();
1537 prepare_textures();
1538 prepare_cube_data_buffers();
1539
1540 prepare_descriptor_layout();
1541 prepare_render_pass();
1542 prepare_pipeline();
1543
Charles Giessen87dd88d2022-02-03 13:46:29 -07001544 for (auto &swapchain_image_resource : swapchain_image_resources) {
1545 auto alloc_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1546 .setCommandPool(cmd_pool)
1547 .setLevel(vk::CommandBufferLevel::ePrimary)
1548 .setCommandBufferCount(1));
1549 VERIFY(alloc_return.result == vk::Result::eSuccess);
1550 swapchain_image_resource.cmd = alloc_return.value[0];
Dave Houlton5fa47912018-02-16 11:02:26 -07001551 }
1552
1553 if (separate_present_queue) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001554 auto present_cmd_pool_return =
1555 device.createCommandPool(vk::CommandPoolCreateInfo().setQueueFamilyIndex(present_queue_family_index));
1556 VERIFY(present_cmd_pool_return.result == vk::Result::eSuccess);
1557 present_cmd_pool = present_cmd_pool_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001558
Charles Giessen87dd88d2022-02-03 13:46:29 -07001559 for (auto &swapchain_image_resource : swapchain_image_resources) {
1560 auto alloc_cmd_return = device.allocateCommandBuffers(vk::CommandBufferAllocateInfo()
1561 .setCommandPool(present_cmd_pool)
1562 .setLevel(vk::CommandBufferLevel::ePrimary)
1563 .setCommandBufferCount(1));
1564 VERIFY(alloc_cmd_return.result == vk::Result::eSuccess);
1565 swapchain_image_resource.graphics_to_present_cmd = alloc_cmd_return.value[0];
1566 build_image_ownership_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001567 }
1568 }
1569
1570 prepare_descriptor_pool();
1571 prepare_descriptor_set();
1572
1573 prepare_framebuffers();
1574
Charles Giessen87dd88d2022-02-03 13:46:29 -07001575 for (const auto &swapchain_image_resource : swapchain_image_resources) {
1576 draw_build_cmd(swapchain_image_resource);
Dave Houlton5fa47912018-02-16 11:02:26 -07001577 }
1578
1579 /*
1580 * Prepare functions above may generate pipeline commands
1581 * that need to be flushed before beginning the render loop.
1582 */
1583 flush_init_cmd();
Tony-LunarGbc9fc052018-09-21 13:47:06 -06001584 if (staging_texture.buffer) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001585 destroy_texture(staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07001586 }
1587
1588 current_buffer = 0;
1589 prepared = true;
1590}
1591
1592void Demo::prepare_buffers() {
1593 vk::SwapchainKHR oldSwapchain = swapchain;
1594
1595 // Check the surface capabilities and formats
Charles Giessen87dd88d2022-02-03 13:46:29 -07001596 auto surface_capabilities_return = gpu.getSurfaceCapabilitiesKHR(surface);
1597 VERIFY(surface_capabilities_return.result == vk::Result::eSuccess);
1598 auto surfCapabilities = surface_capabilities_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001599
Charles Giessen87dd88d2022-02-03 13:46:29 -07001600 auto present_modes_return = gpu.getSurfacePresentModesKHR(surface);
1601 VERIFY(present_modes_return.result == vk::Result::eSuccess);
1602 auto present_modes = present_modes_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001603
1604 vk::Extent2D swapchainExtent;
1605 // width and height are either both -1, or both not -1.
Charles Giessen87dd88d2022-02-03 13:46:29 -07001606 if (surfCapabilities.currentExtent.width == static_cast<uint32_t>(-1)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001607 // If the surface size is undefined, the size is set to
1608 // the size of the images requested.
1609 swapchainExtent.width = width;
1610 swapchainExtent.height = height;
1611 } else {
1612 // If the surface size is defined, the swap chain size must match
1613 swapchainExtent = surfCapabilities.currentExtent;
1614 width = surfCapabilities.currentExtent.width;
1615 height = surfCapabilities.currentExtent.height;
1616 }
1617
1618 // The FIFO present mode is guaranteed by the spec to be supported
1619 // and to have no tearing. It's a great default present mode to use.
1620 vk::PresentModeKHR swapchainPresentMode = vk::PresentModeKHR::eFifo;
1621
1622 // There are times when you may wish to use another present mode. The
1623 // following code shows how to select them, and the comments provide some
1624 // reasons you may wish to use them.
1625 //
1626 // It should be noted that Vulkan 1.0 doesn't provide a method for
1627 // synchronizing rendering with the presentation engine's display. There
1628 // is a method provided for throttling rendering with the display, but
1629 // there are some presentation engines for which this method will not work.
1630 // If an application doesn't throttle its rendering, and if it renders much
1631 // faster than the refresh rate of the display, this can waste power on
1632 // mobile devices. That is because power is being spent rendering images
1633 // that may never be seen.
1634
1635 // VK_PRESENT_MODE_IMMEDIATE_KHR is for applications that don't care
1636 // about
1637 // tearing, or have some way of synchronizing their rendering with the
1638 // display.
1639 // VK_PRESENT_MODE_MAILBOX_KHR may be useful for applications that
1640 // generally render a new presentable image every refresh cycle, but are
1641 // occasionally early. In this case, the application wants the new
1642 // image
1643 // to be displayed instead of the previously-queued-for-presentation
1644 // image
1645 // that has not yet been displayed.
1646 // VK_PRESENT_MODE_FIFO_RELAXED_KHR is for applications that generally
1647 // render a new presentable image every refresh cycle, but are
1648 // occasionally
1649 // late. In this case (perhaps because of stuttering/latency concerns),
1650 // the application wants the late image to be immediately displayed,
1651 // even
1652 // though that may mean some tearing.
1653
1654 if (presentMode != swapchainPresentMode) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001655 for (const auto &mode : present_modes) {
1656 if (mode == presentMode) {
1657 swapchainPresentMode = mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07001658 break;
1659 }
1660 }
1661 }
1662
1663 if (swapchainPresentMode != presentMode) {
1664 ERR_EXIT("Present mode specified is not supported\n", "Present mode unsupported");
1665 }
1666
1667 // Determine the number of VkImages to use in the swap chain.
1668 // Application desires to acquire 3 images at a time for triple
1669 // buffering
1670 uint32_t desiredNumOfSwapchainImages = 3;
1671 if (desiredNumOfSwapchainImages < surfCapabilities.minImageCount) {
1672 desiredNumOfSwapchainImages = surfCapabilities.minImageCount;
1673 }
1674
1675 // If maxImageCount is 0, we can ask for as many images as we want,
1676 // otherwise
1677 // we're limited to maxImageCount
1678 if ((surfCapabilities.maxImageCount > 0) && (desiredNumOfSwapchainImages > surfCapabilities.maxImageCount)) {
1679 // Application must settle for fewer images than desired:
1680 desiredNumOfSwapchainImages = surfCapabilities.maxImageCount;
1681 }
1682
1683 vk::SurfaceTransformFlagBitsKHR preTransform;
1684 if (surfCapabilities.supportedTransforms & vk::SurfaceTransformFlagBitsKHR::eIdentity) {
1685 preTransform = vk::SurfaceTransformFlagBitsKHR::eIdentity;
1686 } else {
1687 preTransform = surfCapabilities.currentTransform;
1688 }
1689
1690 // Find a supported composite alpha mode - one of these is guaranteed to be set
1691 vk::CompositeAlphaFlagBitsKHR compositeAlpha = vk::CompositeAlphaFlagBitsKHR::eOpaque;
Charles Giessenc2f1a942022-02-06 23:38:39 -07001692 std::array<vk::CompositeAlphaFlagBitsKHR, 4> compositeAlphaFlags = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001693 vk::CompositeAlphaFlagBitsKHR::eOpaque,
1694 vk::CompositeAlphaFlagBitsKHR::ePreMultiplied,
1695 vk::CompositeAlphaFlagBitsKHR::ePostMultiplied,
1696 vk::CompositeAlphaFlagBitsKHR::eInherit,
1697 };
Charles Giessenc2f1a942022-02-06 23:38:39 -07001698 for (const auto &compositeAlphaFlag : compositeAlphaFlags) {
1699 if (surfCapabilities.supportedCompositeAlpha & compositeAlphaFlag) {
1700 compositeAlpha = compositeAlphaFlag;
Dave Houlton5fa47912018-02-16 11:02:26 -07001701 break;
1702 }
1703 }
1704
Charles Giessen87dd88d2022-02-03 13:46:29 -07001705 auto swapchain_return = device.createSwapchainKHR(vk::SwapchainCreateInfoKHR()
1706 .setSurface(surface)
1707 .setMinImageCount(desiredNumOfSwapchainImages)
1708 .setImageFormat(format)
1709 .setImageColorSpace(color_space)
1710 .setImageExtent({swapchainExtent.width, swapchainExtent.height})
1711 .setImageArrayLayers(1)
1712 .setImageUsage(vk::ImageUsageFlagBits::eColorAttachment)
1713 .setImageSharingMode(vk::SharingMode::eExclusive)
1714 .setPreTransform(preTransform)
1715 .setCompositeAlpha(compositeAlpha)
1716 .setPresentMode(swapchainPresentMode)
1717 .setClipped(true)
1718 .setOldSwapchain(oldSwapchain));
1719 VERIFY(swapchain_return.result == vk::Result::eSuccess);
1720 swapchain = swapchain_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001721
1722 // If we just re-created an existing swapchain, we should destroy the
1723 // old
1724 // swapchain at this point.
1725 // Note: destroying the swapchain also cleans up all its associated
1726 // presentable images once the platform is done with them.
1727 if (oldSwapchain) {
Charles Giessenc2f1a942022-02-06 23:38:39 -07001728 device.destroySwapchainKHR(oldSwapchain);
Dave Houlton5fa47912018-02-16 11:02:26 -07001729 }
1730
Charles Giessen87dd88d2022-02-03 13:46:29 -07001731 auto swapchain_images_return = device.getSwapchainImagesKHR(swapchain);
1732 VERIFY(swapchain_images_return.result == vk::Result::eSuccess);
1733 swapchain_image_resources.resize(swapchain_images_return.value.size());
Dave Houlton5fa47912018-02-16 11:02:26 -07001734
Charles Giessen87dd88d2022-02-03 13:46:29 -07001735 for (uint32_t i = 0; i < swapchain_image_resources.size(); ++i) {
Dave Houlton5fa47912018-02-16 11:02:26 -07001736 auto color_image_view = vk::ImageViewCreateInfo()
1737 .setViewType(vk::ImageViewType::e2D)
1738 .setFormat(format)
1739 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
1740
Charles Giessen87dd88d2022-02-03 13:46:29 -07001741 swapchain_image_resources[i].image = swapchain_images_return.value[i];
Dave Houlton5fa47912018-02-16 11:02:26 -07001742
1743 color_image_view.image = swapchain_image_resources[i].image;
1744
Charles Giessen87dd88d2022-02-03 13:46:29 -07001745 auto image_view_return = device.createImageView(color_image_view);
1746 VERIFY(image_view_return.result == vk::Result::eSuccess);
1747 swapchain_image_resources[i].view = image_view_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07001748 }
1749}
1750
1751void Demo::prepare_cube_data_buffers() {
1752 mat4x4 VP;
1753 mat4x4_mul(VP, projection_matrix, view_matrix);
1754
1755 mat4x4 MVP;
1756 mat4x4_mul(MVP, VP, model_matrix);
1757
1758 vktexcube_vs_uniform data;
1759 memcpy(data.mvp, MVP, sizeof(MVP));
1760 // dumpMatrix("MVP", MVP)
1761
1762 for (int32_t i = 0; i < 12 * 3; i++) {
1763 data.position[i][0] = g_vertex_buffer_data[i * 3];
1764 data.position[i][1] = g_vertex_buffer_data[i * 3 + 1];
1765 data.position[i][2] = g_vertex_buffer_data[i * 3 + 2];
1766 data.position[i][3] = 1.0f;
1767 data.attr[i][0] = g_uv_buffer_data[2 * i];
1768 data.attr[i][1] = g_uv_buffer_data[2 * i + 1];
1769 data.attr[i][2] = 0;
1770 data.attr[i][3] = 0;
1771 }
1772
1773 auto const buf_info = vk::BufferCreateInfo().setSize(sizeof(data)).setUsage(vk::BufferUsageFlagBits::eUniformBuffer);
1774
Charles Giessen87dd88d2022-02-03 13:46:29 -07001775 for (auto &swapchain_image_resource : swapchain_image_resources) {
1776 auto result = device.createBuffer(&buf_info, nullptr, &swapchain_image_resource.uniform_buffer);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001777 VERIFY(result == vk::Result::eSuccess);
1778
1779 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001780 device.getBufferMemoryRequirements(swapchain_image_resource.uniform_buffer, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001781
Dave Houlton5fa47912018-02-16 11:02:26 -07001782 auto mem_alloc = vk::MemoryAllocateInfo().setAllocationSize(mem_reqs.size).setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001783
Dave Houlton5fa47912018-02-16 11:02:26 -07001784 bool const pass = memory_type_from_properties(
1785 mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001786 mem_alloc.memoryTypeIndex);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001787 VERIFY(pass);
1788
Charles Giessen87dd88d2022-02-03 13:46:29 -07001789 result = device.allocateMemory(&mem_alloc, nullptr, &swapchain_image_resource.uniform_memory);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001790 VERIFY(result == vk::Result::eSuccess);
1791
Charles Giessen87dd88d2022-02-03 13:46:29 -07001792 result = device.mapMemory(swapchain_image_resource.uniform_memory, 0, VK_WHOLE_SIZE, vk::MemoryMapFlags(),
1793 &swapchain_image_resource.uniform_memory_ptr);
Tony-LunarG37af49f2019-12-19 12:04:19 -07001794 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001795
Charles Giessen87dd88d2022-02-03 13:46:29 -07001796 memcpy(swapchain_image_resource.uniform_memory_ptr, &data, sizeof data);
Dave Houlton5fa47912018-02-16 11:02:26 -07001797
Charles Giessen87dd88d2022-02-03 13:46:29 -07001798 result = device.bindBufferMemory(swapchain_image_resource.uniform_buffer, swapchain_image_resource.uniform_memory, 0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001799 VERIFY(result == vk::Result::eSuccess);
1800 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001801}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001802
Dave Houlton5fa47912018-02-16 11:02:26 -07001803void Demo::prepare_depth() {
1804 depth.format = vk::Format::eD16Unorm;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001805
Dave Houlton5fa47912018-02-16 11:02:26 -07001806 auto const image = vk::ImageCreateInfo()
1807 .setImageType(vk::ImageType::e2D)
1808 .setFormat(depth.format)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001809 .setExtent({width, height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07001810 .setMipLevels(1)
1811 .setArrayLayers(1)
1812 .setSamples(vk::SampleCountFlagBits::e1)
1813 .setTiling(vk::ImageTiling::eOptimal)
1814 .setUsage(vk::ImageUsageFlagBits::eDepthStencilAttachment)
1815 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07001816 .setInitialLayout(vk::ImageLayout::eUndefined);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001817
Dave Houlton5fa47912018-02-16 11:02:26 -07001818 auto result = device.createImage(&image, nullptr, &depth.image);
1819 VERIFY(result == vk::Result::eSuccess);
1820
1821 vk::MemoryRequirements mem_reqs;
1822 device.getImageMemoryRequirements(depth.image, &mem_reqs);
1823
1824 depth.mem_alloc.setAllocationSize(mem_reqs.size);
1825 depth.mem_alloc.setMemoryTypeIndex(0);
1826
1827 auto const pass = memory_type_from_properties(mem_reqs.memoryTypeBits, vk::MemoryPropertyFlagBits::eDeviceLocal,
Charles Giessen87dd88d2022-02-03 13:46:29 -07001828 depth.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07001829 VERIFY(pass);
1830
1831 result = device.allocateMemory(&depth.mem_alloc, nullptr, &depth.mem);
1832 VERIFY(result == vk::Result::eSuccess);
1833
1834 result = device.bindImageMemory(depth.image, depth.mem, 0);
1835 VERIFY(result == vk::Result::eSuccess);
1836
Mark Young43c08f82021-11-30 16:38:25 -07001837 auto view = vk::ImageViewCreateInfo()
Charles Giessen87dd88d2022-02-03 13:46:29 -07001838 .setImage(depth.image)
1839 .setViewType(vk::ImageViewType::e2D)
1840 .setFormat(depth.format)
1841 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eDepth, 0, 1, 0, 1));
Mark Young43c08f82021-11-30 16:38:25 -07001842 if (force_errors) {
1843 // Intentionally force a bad pNext value to generate a validation layer error
1844 view.pNext = &image;
1845 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001846 result = device.createImageView(&view, nullptr, &depth.view);
1847 VERIFY(result == vk::Result::eSuccess);
1848}
1849
1850void Demo::prepare_descriptor_layout() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001851 std::array<vk::DescriptorSetLayoutBinding, 2> const layout_bindings = {
1852 vk::DescriptorSetLayoutBinding()
1853 .setBinding(0)
1854 .setDescriptorType(vk::DescriptorType::eUniformBuffer)
1855 .setDescriptorCount(1)
1856 .setStageFlags(vk::ShaderStageFlagBits::eVertex)
1857 .setPImmutableSamplers(nullptr),
1858 vk::DescriptorSetLayoutBinding()
1859 .setBinding(1)
1860 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1861 .setDescriptorCount(texture_count)
1862 .setStageFlags(vk::ShaderStageFlagBits::eFragment)
1863 .setPImmutableSamplers(nullptr)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001864
Charles Giessen87dd88d2022-02-03 13:46:29 -07001865 auto const descriptor_layout = vk::DescriptorSetLayoutCreateInfo().setBindings(layout_bindings);
Dave Houlton5fa47912018-02-16 11:02:26 -07001866
1867 auto result = device.createDescriptorSetLayout(&descriptor_layout, nullptr, &desc_layout);
1868 VERIFY(result == vk::Result::eSuccess);
1869
Charles Giessen87dd88d2022-02-03 13:46:29 -07001870 auto const pPipelineLayoutCreateInfo = vk::PipelineLayoutCreateInfo().setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001871
1872 result = device.createPipelineLayout(&pPipelineLayoutCreateInfo, nullptr, &pipeline_layout);
1873 VERIFY(result == vk::Result::eSuccess);
1874}
1875
1876void Demo::prepare_descriptor_pool() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001877 std::array<vk::DescriptorPoolSize, 2> const poolSizes = {
1878 vk::DescriptorPoolSize()
1879 .setType(vk::DescriptorType::eUniformBuffer)
1880 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size())),
Dave Houlton5fa47912018-02-16 11:02:26 -07001881 vk::DescriptorPoolSize()
1882 .setType(vk::DescriptorType::eCombinedImageSampler)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001883 .setDescriptorCount(static_cast<uint32_t>(swapchain_image_resources.size()) * texture_count)};
Dave Houlton5fa47912018-02-16 11:02:26 -07001884
1885 auto const descriptor_pool =
Charles Giessen87dd88d2022-02-03 13:46:29 -07001886 vk::DescriptorPoolCreateInfo().setMaxSets(static_cast<uint32_t>(swapchain_image_resources.size())).setPoolSizes(poolSizes);
Dave Houlton5fa47912018-02-16 11:02:26 -07001887
1888 auto result = device.createDescriptorPool(&descriptor_pool, nullptr, &desc_pool);
1889 VERIFY(result == vk::Result::eSuccess);
1890}
1891
1892void Demo::prepare_descriptor_set() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001893 auto const alloc_info = vk::DescriptorSetAllocateInfo().setDescriptorPool(desc_pool).setSetLayouts(desc_layout);
Dave Houlton5fa47912018-02-16 11:02:26 -07001894
Charles Giessen87dd88d2022-02-03 13:46:29 -07001895 auto buffer_info = vk::DescriptorBufferInfo().setOffset(0).setRange(sizeof(vktexcube_vs_uniform));
Dave Houlton5fa47912018-02-16 11:02:26 -07001896
Charles Giessen87dd88d2022-02-03 13:46:29 -07001897 std::array<vk::DescriptorImageInfo, texture_count> tex_descs;
Dave Houlton5fa47912018-02-16 11:02:26 -07001898 for (uint32_t i = 0; i < texture_count; i++) {
1899 tex_descs[i].setSampler(textures[i].sampler);
1900 tex_descs[i].setImageView(textures[i].view);
Karl Schultze88bc842018-09-11 16:23:14 -06001901 tex_descs[i].setImageLayout(vk::ImageLayout::eShaderReadOnlyOptimal);
Dave Houlton5fa47912018-02-16 11:02:26 -07001902 }
1903
Charles Giessenc2f1a942022-02-06 23:38:39 -07001904 std::array<vk::WriteDescriptorSet, 2> writes;
Charles Giessen87dd88d2022-02-03 13:46:29 -07001905 writes[0].setDescriptorCount(1).setDescriptorType(vk::DescriptorType::eUniformBuffer).setPBufferInfo(&buffer_info);
Charles Giessen87dd88d2022-02-03 13:46:29 -07001906 writes[1]
1907 .setDstBinding(1)
1908 .setDescriptorCount(texture_count)
1909 .setDescriptorType(vk::DescriptorType::eCombinedImageSampler)
1910 .setImageInfo(tex_descs);
Dave Houlton5fa47912018-02-16 11:02:26 -07001911
Charles Giessen87dd88d2022-02-03 13:46:29 -07001912 for (auto &swapchain_image_resource : swapchain_image_resources) {
1913 auto result = device.allocateDescriptorSets(&alloc_info, &swapchain_image_resource.descriptor_set);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001914 VERIFY(result == vk::Result::eSuccess);
1915
Charles Giessen87dd88d2022-02-03 13:46:29 -07001916 buffer_info.setBuffer(swapchain_image_resource.uniform_buffer);
1917 writes[0].setDstSet(swapchain_image_resource.descriptor_set);
1918 writes[1].setDstSet(swapchain_image_resource.descriptor_set);
Charles Giessenc2f1a942022-02-06 23:38:39 -07001919 device.updateDescriptorSets(writes, {});
Dave Houlton5fa47912018-02-16 11:02:26 -07001920 }
1921}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001922
Dave Houlton5fa47912018-02-16 11:02:26 -07001923void Demo::prepare_framebuffers() {
Charles Giessen87dd88d2022-02-03 13:46:29 -07001924 std::array<vk::ImageView, 2> attachments;
Dave Houlton5fa47912018-02-16 11:02:26 -07001925 attachments[1] = depth.view;
1926
Charles Giessen87dd88d2022-02-03 13:46:29 -07001927 for (auto &swapchain_image_resource : swapchain_image_resources) {
1928 attachments[0] = swapchain_image_resource.view;
1929 auto const framebuffer_return = device.createFramebuffer(vk::FramebufferCreateInfo()
1930 .setRenderPass(render_pass)
1931 .setAttachments(attachments)
Charles Giessen3bcefe52022-02-21 11:57:16 -07001932 .setWidth(width)
1933 .setHeight(height)
Charles Giessen87dd88d2022-02-03 13:46:29 -07001934 .setLayers(1));
1935 VERIFY(framebuffer_return.result == vk::Result::eSuccess);
1936 swapchain_image_resource.framebuffer = framebuffer_return.value;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001937 }
Dave Houlton5fa47912018-02-16 11:02:26 -07001938}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001939
Dave Houlton5fa47912018-02-16 11:02:26 -07001940vk::ShaderModule Demo::prepare_fs() {
1941 const uint32_t fragShaderCode[] = {
Petr Kraus9a4eb6a2017-11-30 14:49:20 +01001942#include "cube.frag.inc"
Dave Houlton5fa47912018-02-16 11:02:26 -07001943 };
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001944
Dave Houlton5fa47912018-02-16 11:02:26 -07001945 frag_shader_module = prepare_shader_module(fragShaderCode, sizeof(fragShaderCode));
Jeremy Hayesf56427a2016-09-07 15:55:11 -06001946
Dave Houlton5fa47912018-02-16 11:02:26 -07001947 return frag_shader_module;
1948}
1949
1950void Demo::prepare_pipeline() {
1951 vk::PipelineCacheCreateInfo const pipelineCacheInfo;
1952 auto result = device.createPipelineCache(&pipelineCacheInfo, nullptr, &pipelineCache);
1953 VERIFY(result == vk::Result::eSuccess);
1954
Charles Giessen87dd88d2022-02-03 13:46:29 -07001955 std::array<vk::PipelineShaderStageCreateInfo, 2> const shaderStageInfo = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001956 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eVertex).setModule(prepare_vs()).setPName("main"),
1957 vk::PipelineShaderStageCreateInfo().setStage(vk::ShaderStageFlagBits::eFragment).setModule(prepare_fs()).setPName("main")};
1958
1959 vk::PipelineVertexInputStateCreateInfo const vertexInputInfo;
1960
1961 auto const inputAssemblyInfo = vk::PipelineInputAssemblyStateCreateInfo().setTopology(vk::PrimitiveTopology::eTriangleList);
1962
1963 // TODO: Where are pViewports and pScissors set?
1964 auto const viewportInfo = vk::PipelineViewportStateCreateInfo().setViewportCount(1).setScissorCount(1);
1965
1966 auto const rasterizationInfo = vk::PipelineRasterizationStateCreateInfo()
1967 .setDepthClampEnable(VK_FALSE)
1968 .setRasterizerDiscardEnable(VK_FALSE)
1969 .setPolygonMode(vk::PolygonMode::eFill)
1970 .setCullMode(vk::CullModeFlagBits::eBack)
1971 .setFrontFace(vk::FrontFace::eCounterClockwise)
1972 .setDepthBiasEnable(VK_FALSE)
1973 .setLineWidth(1.0f);
1974
1975 auto const multisampleInfo = vk::PipelineMultisampleStateCreateInfo();
1976
1977 auto const stencilOp =
1978 vk::StencilOpState().setFailOp(vk::StencilOp::eKeep).setPassOp(vk::StencilOp::eKeep).setCompareOp(vk::CompareOp::eAlways);
1979
1980 auto const depthStencilInfo = vk::PipelineDepthStencilStateCreateInfo()
1981 .setDepthTestEnable(VK_TRUE)
1982 .setDepthWriteEnable(VK_TRUE)
1983 .setDepthCompareOp(vk::CompareOp::eLessOrEqual)
1984 .setDepthBoundsTestEnable(VK_FALSE)
1985 .setStencilTestEnable(VK_FALSE)
1986 .setFront(stencilOp)
1987 .setBack(stencilOp);
1988
Charles Giessen87dd88d2022-02-03 13:46:29 -07001989 std::array<vk::PipelineColorBlendAttachmentState, 1> const colorBlendAttachments = {
Dave Houlton5fa47912018-02-16 11:02:26 -07001990 vk::PipelineColorBlendAttachmentState().setColorWriteMask(vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG |
1991 vk::ColorComponentFlagBits::eB | vk::ColorComponentFlagBits::eA)};
1992
Charles Giessen87dd88d2022-02-03 13:46:29 -07001993 auto const colorBlendInfo = vk::PipelineColorBlendStateCreateInfo().setAttachments(colorBlendAttachments);
Dave Houlton5fa47912018-02-16 11:02:26 -07001994
Charles Giessen87dd88d2022-02-03 13:46:29 -07001995 std::array<vk::DynamicState, 2> const dynamicStates = {vk::DynamicState::eViewport, vk::DynamicState::eScissor};
Dave Houlton5fa47912018-02-16 11:02:26 -07001996
Charles Giessen87dd88d2022-02-03 13:46:29 -07001997 auto const dynamicStateInfo = vk::PipelineDynamicStateCreateInfo().setDynamicStates(dynamicStates);
Dave Houlton5fa47912018-02-16 11:02:26 -07001998
Charles Giessenc2f1a942022-02-06 23:38:39 -07001999 auto pipline_return = device.createGraphicsPipelines(pipelineCache, vk::GraphicsPipelineCreateInfo()
2000 .setStages(shaderStageInfo)
2001 .setPVertexInputState(&vertexInputInfo)
2002 .setPInputAssemblyState(&inputAssemblyInfo)
2003 .setPViewportState(&viewportInfo)
2004 .setPRasterizationState(&rasterizationInfo)
2005 .setPMultisampleState(&multisampleInfo)
2006 .setPDepthStencilState(&depthStencilInfo)
2007 .setPColorBlendState(&colorBlendInfo)
2008 .setPDynamicState(&dynamicStateInfo)
2009 .setLayout(pipeline_layout)
2010 .setRenderPass(render_pass));
Dave Houlton5fa47912018-02-16 11:02:26 -07002011 VERIFY(result == vk::Result::eSuccess);
Charles Giessenc2f1a942022-02-06 23:38:39 -07002012 pipeline = pipline_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002013
Charles Giessenc2f1a942022-02-06 23:38:39 -07002014 device.destroyShaderModule(frag_shader_module);
2015 device.destroyShaderModule(vert_shader_module);
Dave Houlton5fa47912018-02-16 11:02:26 -07002016}
2017
2018void Demo::prepare_render_pass() {
2019 // The initial layout for the color and depth attachments will be LAYOUT_UNDEFINED
2020 // because at the start of the renderpass, we don't care about their contents.
2021 // At the start of the subpass, the color attachment's layout will be transitioned
2022 // to LAYOUT_COLOR_ATTACHMENT_OPTIMAL and the depth stencil attachment's layout
2023 // will be transitioned to LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL. At the end of
2024 // the renderpass, the color attachment's layout will be transitioned to
2025 // LAYOUT_PRESENT_SRC_KHR to be ready to present. This is all done as part of
2026 // the renderpass, no barriers are necessary.
Charles Giessen87dd88d2022-02-03 13:46:29 -07002027 std::array<vk::AttachmentDescription, 2> const attachments = {
2028 vk::AttachmentDescription()
2029 .setFormat(format)
2030 .setSamples(vk::SampleCountFlagBits::e1)
2031 .setLoadOp(vk::AttachmentLoadOp::eClear)
2032 .setStoreOp(vk::AttachmentStoreOp::eStore)
2033 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2034 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2035 .setInitialLayout(vk::ImageLayout::eUndefined)
2036 .setFinalLayout(vk::ImageLayout::ePresentSrcKHR),
2037 vk::AttachmentDescription()
2038 .setFormat(depth.format)
2039 .setSamples(vk::SampleCountFlagBits::e1)
2040 .setLoadOp(vk::AttachmentLoadOp::eClear)
2041 .setStoreOp(vk::AttachmentStoreOp::eDontCare)
2042 .setStencilLoadOp(vk::AttachmentLoadOp::eDontCare)
2043 .setStencilStoreOp(vk::AttachmentStoreOp::eDontCare)
2044 .setInitialLayout(vk::ImageLayout::eUndefined)
2045 .setFinalLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal)};
Dave Houlton5fa47912018-02-16 11:02:26 -07002046
2047 auto const color_reference = vk::AttachmentReference().setAttachment(0).setLayout(vk::ImageLayout::eColorAttachmentOptimal);
2048
2049 auto const depth_reference =
2050 vk::AttachmentReference().setAttachment(1).setLayout(vk::ImageLayout::eDepthStencilAttachmentOptimal);
2051
2052 auto const subpass = vk::SubpassDescription()
2053 .setPipelineBindPoint(vk::PipelineBindPoint::eGraphics)
Charles Giessen87dd88d2022-02-03 13:46:29 -07002054 .setColorAttachments(color_reference)
2055 .setPDepthStencilAttachment(&depth_reference);
Dave Houlton5fa47912018-02-16 11:02:26 -07002056
Tony-LunarG495604b2019-06-13 15:32:05 -06002057 vk::PipelineStageFlags stages = vk::PipelineStageFlagBits::eEarlyFragmentTests | vk::PipelineStageFlagBits::eLateFragmentTests;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002058 std::array<vk::SubpassDependency, 2> const dependencies = {
Tony-LunarG495604b2019-06-13 15:32:05 -06002059 vk::SubpassDependency() // Depth buffer is shared between swapchain images
2060 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2061 .setDstSubpass(0)
2062 .setSrcStageMask(stages)
2063 .setDstStageMask(stages)
2064 .setSrcAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2065 .setDstAccessMask(vk::AccessFlagBits::eDepthStencilAttachmentRead | vk::AccessFlagBits::eDepthStencilAttachmentWrite)
2066 .setDependencyFlags(vk::DependencyFlags()),
2067 vk::SubpassDependency() // Image layout transition
2068 .setSrcSubpass(VK_SUBPASS_EXTERNAL)
2069 .setDstSubpass(0)
2070 .setSrcStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2071 .setDstStageMask(vk::PipelineStageFlagBits::eColorAttachmentOutput)
2072 .setSrcAccessMask(vk::AccessFlagBits())
2073 .setDstAccessMask(vk::AccessFlagBits::eColorAttachmentWrite | vk::AccessFlagBits::eColorAttachmentRead)
2074 .setDependencyFlags(vk::DependencyFlags()),
2075 };
2076
Charles Giessen87dd88d2022-02-03 13:46:29 -07002077 const auto render_pass_result = device.createRenderPass(
2078 vk::RenderPassCreateInfo().setAttachments(attachments).setSubpasses(subpass).setDependencies(dependencies));
2079 VERIFY(render_pass_result.result == vk::Result::eSuccess);
2080 render_pass = render_pass_result.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002081}
2082
2083vk::ShaderModule Demo::prepare_shader_module(const uint32_t *code, size_t size) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002084 const auto shader_module_return = device.createShaderModule(vk::ShaderModuleCreateInfo().setCodeSize(size).setPCode(code));
2085 VERIFY(shader_module_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002086
Charles Giessen87dd88d2022-02-03 13:46:29 -07002087 return shader_module_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002088}
2089
Charles Giessen87dd88d2022-02-03 13:46:29 -07002090void Demo::prepare_texture_buffer(const char *filename, texture_object &tex_obj) {
2091 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002092
2093 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002094 ERR_EXIT("Failed to load textures", "Load Texture Failure");
2095 }
2096
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002097 auto const buffer_create_info = vk::BufferCreateInfo()
Charles Giessen3bcefe52022-02-21 11:57:16 -07002098 .setSize(tex_obj.tex_width * tex_obj.tex_height * 4)
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002099 .setUsage(vk::BufferUsageFlagBits::eTransferSrc)
Charles Giessen87dd88d2022-02-03 13:46:29 -07002100 .setSharingMode(vk::SharingMode::eExclusive);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002101
Charles Giessen87dd88d2022-02-03 13:46:29 -07002102 auto result = device.createBuffer(&buffer_create_info, nullptr, &tex_obj.buffer);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002103 VERIFY(result == vk::Result::eSuccess);
2104
2105 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002106 device.getBufferMemoryRequirements(tex_obj.buffer, &mem_reqs);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002107
Charles Giessen87dd88d2022-02-03 13:46:29 -07002108 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
2109 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002110
2111 vk::MemoryPropertyFlags requirements = vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002112 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, requirements, tex_obj.mem_alloc.memoryTypeIndex);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002113 VERIFY(pass == true);
2114
Charles Giessen87dd88d2022-02-03 13:46:29 -07002115 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &(tex_obj.mem));
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002116 VERIFY(result == vk::Result::eSuccess);
2117
Charles Giessen87dd88d2022-02-03 13:46:29 -07002118 result = device.bindBufferMemory(tex_obj.buffer, tex_obj.mem, 0);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002119 VERIFY(result == vk::Result::eSuccess);
2120
2121 vk::SubresourceLayout layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002122 layout.rowPitch = tex_obj.tex_width * 4;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002123 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002124 VERIFY(data.result == vk::Result::eSuccess);
2125
Charles Giessen3bcefe52022-02-21 11:57:16 -07002126 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002127 fprintf(stderr, "Error loading texture: %s\n", filename);
2128 }
2129
Charles Giessen87dd88d2022-02-03 13:46:29 -07002130 device.unmapMemory(tex_obj.mem);
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002131}
2132
Charles Giessen87dd88d2022-02-03 13:46:29 -07002133void Demo::prepare_texture_image(const char *filename, texture_object &tex_obj, vk::ImageTiling tiling, vk::ImageUsageFlags usage,
Dave Houlton5fa47912018-02-16 11:02:26 -07002134 vk::MemoryPropertyFlags required_props) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002135 vk::SubresourceLayout tex_layout;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002136 if (!loadTexture(filename, nullptr, tex_layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002137 ERR_EXIT("Failed to load textures", "Load Texture Failure");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002138 }
2139
Dave Houlton5fa47912018-02-16 11:02:26 -07002140 auto const image_create_info = vk::ImageCreateInfo()
2141 .setImageType(vk::ImageType::e2D)
2142 .setFormat(vk::Format::eR8G8B8A8Unorm)
Charles Giessen3bcefe52022-02-21 11:57:16 -07002143 .setExtent({tex_obj.tex_width, tex_obj.tex_height, 1})
Dave Houlton5fa47912018-02-16 11:02:26 -07002144 .setMipLevels(1)
2145 .setArrayLayers(1)
2146 .setSamples(vk::SampleCountFlagBits::e1)
2147 .setTiling(tiling)
2148 .setUsage(usage)
2149 .setSharingMode(vk::SharingMode::eExclusive)
Dave Houlton5fa47912018-02-16 11:02:26 -07002150 .setInitialLayout(vk::ImageLayout::ePreinitialized);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002151
Charles Giessen87dd88d2022-02-03 13:46:29 -07002152 auto result = device.createImage(&image_create_info, nullptr, &tex_obj.image);
Dave Houlton5fa47912018-02-16 11:02:26 -07002153 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002154
Dave Houlton5fa47912018-02-16 11:02:26 -07002155 vk::MemoryRequirements mem_reqs;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002156 device.getImageMemoryRequirements(tex_obj.image, &mem_reqs);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002157
Charles Giessen87dd88d2022-02-03 13:46:29 -07002158 tex_obj.mem_alloc.setAllocationSize(mem_reqs.size);
2159 tex_obj.mem_alloc.setMemoryTypeIndex(0);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002160
Charles Giessen87dd88d2022-02-03 13:46:29 -07002161 auto pass = memory_type_from_properties(mem_reqs.memoryTypeBits, required_props, tex_obj.mem_alloc.memoryTypeIndex);
Dave Houlton5fa47912018-02-16 11:02:26 -07002162 VERIFY(pass == true);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002163
Charles Giessen87dd88d2022-02-03 13:46:29 -07002164 result = device.allocateMemory(&tex_obj.mem_alloc, nullptr, &tex_obj.mem);
Dave Houlton5fa47912018-02-16 11:02:26 -07002165 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002166
Charles Giessen87dd88d2022-02-03 13:46:29 -07002167 result = device.bindImageMemory(tex_obj.image, tex_obj.mem, 0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002168 VERIFY(result == vk::Result::eSuccess);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002169
Dave Houlton5fa47912018-02-16 11:02:26 -07002170 if (required_props & vk::MemoryPropertyFlagBits::eHostVisible) {
2171 auto const subres = vk::ImageSubresource().setAspectMask(vk::ImageAspectFlagBits::eColor).setMipLevel(0).setArrayLayer(0);
2172 vk::SubresourceLayout layout;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002173 device.getImageSubresourceLayout(tex_obj.image, &subres, &layout);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002174
Charles Giessen87dd88d2022-02-03 13:46:29 -07002175 auto data = device.mapMemory(tex_obj.mem, 0, tex_obj.mem_alloc.allocationSize);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002176 VERIFY(data.result == vk::Result::eSuccess);
2177
Charles Giessen3bcefe52022-02-21 11:57:16 -07002178 if (!loadTexture(filename, (uint8_t *)data.value, layout, tex_obj.tex_width, tex_obj.tex_height)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002179 fprintf(stderr, "Error loading texture: %s\n", filename);
2180 }
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002181
Charles Giessen87dd88d2022-02-03 13:46:29 -07002182 device.unmapMemory(tex_obj.mem);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002183 }
2184
Charles Giessen87dd88d2022-02-03 13:46:29 -07002185 tex_obj.imageLayout = vk::ImageLayout::eShaderReadOnlyOptimal;
Dave Houlton5fa47912018-02-16 11:02:26 -07002186}
2187
2188void Demo::prepare_textures() {
2189 vk::Format const tex_format = vk::Format::eR8G8B8A8Unorm;
2190 vk::FormatProperties props;
2191 gpu.getFormatProperties(tex_format, &props);
2192
2193 for (uint32_t i = 0; i < texture_count; i++) {
2194 if ((props.linearTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) && !use_staging_buffer) {
2195 /* Device can texture using linear textures */
Charles Giessen87dd88d2022-02-03 13:46:29 -07002196 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eLinear, vk::ImageUsageFlagBits::eSampled,
Dave Houlton5fa47912018-02-16 11:02:26 -07002197 vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent);
2198 // Nothing in the pipeline needs to be complete to start, and don't allow fragment
2199 // shader to run until layout transition completes
2200 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2201 textures[i].imageLayout, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2202 vk::PipelineStageFlagBits::eFragmentShader);
2203 staging_texture.image = vk::Image();
2204 } else if (props.optimalTilingFeatures & vk::FormatFeatureFlagBits::eSampledImage) {
2205 /* Must use staging buffer to copy linear texture to optimized */
2206
Charles Giessen87dd88d2022-02-03 13:46:29 -07002207 prepare_texture_buffer(tex_files[i], staging_texture);
Dave Houlton5fa47912018-02-16 11:02:26 -07002208
Charles Giessen87dd88d2022-02-03 13:46:29 -07002209 prepare_texture_image(tex_files[i], textures[i], vk::ImageTiling::eOptimal,
Dave Houlton5fa47912018-02-16 11:02:26 -07002210 vk::ImageUsageFlagBits::eTransferDst | vk::ImageUsageFlagBits::eSampled,
2211 vk::MemoryPropertyFlagBits::eDeviceLocal);
2212
Dave Houlton5fa47912018-02-16 11:02:26 -07002213 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::ePreinitialized,
2214 vk::ImageLayout::eTransferDstOptimal, vk::AccessFlagBits(), vk::PipelineStageFlagBits::eTopOfPipe,
2215 vk::PipelineStageFlagBits::eTransfer);
2216
2217 auto const subresource = vk::ImageSubresourceLayers()
2218 .setAspectMask(vk::ImageAspectFlagBits::eColor)
2219 .setMipLevel(0)
2220 .setBaseArrayLayer(0)
2221 .setLayerCount(1);
2222
Charles Giessen87dd88d2022-02-03 13:46:29 -07002223 auto const copy_region = vk::BufferImageCopy()
2224 .setBufferOffset(0)
2225 .setBufferRowLength(staging_texture.tex_width)
2226 .setBufferImageHeight(staging_texture.tex_height)
2227 .setImageSubresource(subresource)
2228 .setImageOffset({0, 0, 0})
Charles Giessen3bcefe52022-02-21 11:57:16 -07002229 .setImageExtent({staging_texture.tex_width, staging_texture.tex_height, 1});
Dave Houlton5fa47912018-02-16 11:02:26 -07002230
Tony-LunarGbc9fc052018-09-21 13:47:06 -06002231 cmd.copyBufferToImage(staging_texture.buffer, textures[i].image, vk::ImageLayout::eTransferDstOptimal, 1, &copy_region);
Dave Houlton5fa47912018-02-16 11:02:26 -07002232
2233 set_image_layout(textures[i].image, vk::ImageAspectFlagBits::eColor, vk::ImageLayout::eTransferDstOptimal,
2234 textures[i].imageLayout, vk::AccessFlagBits::eTransferWrite, vk::PipelineStageFlagBits::eTransfer,
2235 vk::PipelineStageFlagBits::eFragmentShader);
2236 } else {
2237 assert(!"No support for R8G8B8A8_UNORM as texture image format");
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002238 }
2239
Dave Houlton5fa47912018-02-16 11:02:26 -07002240 auto const samplerInfo = vk::SamplerCreateInfo()
2241 .setMagFilter(vk::Filter::eNearest)
2242 .setMinFilter(vk::Filter::eNearest)
2243 .setMipmapMode(vk::SamplerMipmapMode::eNearest)
2244 .setAddressModeU(vk::SamplerAddressMode::eClampToEdge)
2245 .setAddressModeV(vk::SamplerAddressMode::eClampToEdge)
2246 .setAddressModeW(vk::SamplerAddressMode::eClampToEdge)
2247 .setMipLodBias(0.0f)
2248 .setAnisotropyEnable(VK_FALSE)
2249 .setMaxAnisotropy(1)
2250 .setCompareEnable(VK_FALSE)
2251 .setCompareOp(vk::CompareOp::eNever)
2252 .setMinLod(0.0f)
2253 .setMaxLod(0.0f)
2254 .setBorderColor(vk::BorderColor::eFloatOpaqueWhite)
2255 .setUnnormalizedCoordinates(VK_FALSE);
2256
2257 auto result = device.createSampler(&samplerInfo, nullptr, &textures[i].sampler);
2258 VERIFY(result == vk::Result::eSuccess);
2259
2260 auto const viewInfo = vk::ImageViewCreateInfo()
2261 .setImage(textures[i].image)
2262 .setViewType(vk::ImageViewType::e2D)
2263 .setFormat(tex_format)
2264 .setSubresourceRange(vk::ImageSubresourceRange(vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1));
2265
2266 result = device.createImageView(&viewInfo, nullptr, &textures[i].view);
2267 VERIFY(result == vk::Result::eSuccess);
2268 }
2269}
2270
2271vk::ShaderModule Demo::prepare_vs() {
2272 const uint32_t vertShaderCode[] = {
2273#include "cube.vert.inc"
2274 };
2275
2276 vert_shader_module = prepare_shader_module(vertShaderCode, sizeof(vertShaderCode));
2277
2278 return vert_shader_module;
2279}
2280
Charles Giessen87dd88d2022-02-03 13:46:29 -07002281void Demo::destroy_swapchain_related_resources() {
2282 device.destroyDescriptorPool(desc_pool);
Dave Houlton5fa47912018-02-16 11:02:26 -07002283
Charles Giessen87dd88d2022-02-03 13:46:29 -07002284 device.destroyPipeline(pipeline);
2285 device.destroyPipelineCache(pipelineCache);
2286 device.destroyRenderPass(render_pass);
2287 device.destroyPipelineLayout(pipeline_layout);
2288 device.destroyDescriptorSetLayout(desc_layout);
2289
2290 for (const auto &tex : textures) {
2291 device.destroyImageView(tex.view);
2292 device.destroyImage(tex.image);
2293 device.freeMemory(tex.mem);
2294 device.destroySampler(tex.sampler);
2295 }
2296
2297 device.destroyImageView(depth.view);
2298 device.destroyImage(depth.image);
2299 device.freeMemory(depth.mem);
2300
2301 for (const auto &resource : swapchain_image_resources) {
2302 device.destroyFramebuffer(resource.framebuffer);
2303 device.destroyImageView(resource.view);
2304 device.freeCommandBuffers(cmd_pool, {resource.cmd});
2305 device.destroyBuffer(resource.uniform_buffer);
2306 device.unmapMemory(resource.uniform_memory);
2307 device.freeMemory(resource.uniform_memory);
2308 }
2309
2310 device.destroyCommandPool(cmd_pool);
2311 if (separate_present_queue) {
2312 device.destroyCommandPool(present_cmd_pool);
2313 }
2314}
2315
2316void Demo::resize() {
Dave Houlton5fa47912018-02-16 11:02:26 -07002317 // Don't react to resize until after first initialization.
2318 if (!prepared) {
2319 return;
2320 }
2321
2322 // In order to properly resize the window, we must re-create the
2323 // swapchain
2324 // AND redo the command buffers, etc.
2325 //
2326 // First, perform part of the cleanup() function:
2327 prepared = false;
2328 auto result = device.waitIdle();
2329 VERIFY(result == vk::Result::eSuccess);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002330 destroy_swapchain_related_resources();
Dave Houlton5fa47912018-02-16 11:02:26 -07002331
2332 // Second, re-perform the prepare() function, which will re-create the
2333 // swapchain.
2334 prepare();
2335}
2336
2337void Demo::set_image_layout(vk::Image image, vk::ImageAspectFlags aspectMask, vk::ImageLayout oldLayout, vk::ImageLayout newLayout,
2338 vk::AccessFlags srcAccessMask, vk::PipelineStageFlags src_stages, vk::PipelineStageFlags dest_stages) {
2339 assert(cmd);
2340
2341 auto DstAccessMask = [](vk::ImageLayout const &layout) {
2342 vk::AccessFlags flags;
2343
2344 switch (layout) {
2345 case vk::ImageLayout::eTransferDstOptimal:
2346 // Make sure anything that was copying from this image has
2347 // completed
2348 flags = vk::AccessFlagBits::eTransferWrite;
2349 break;
2350 case vk::ImageLayout::eColorAttachmentOptimal:
2351 flags = vk::AccessFlagBits::eColorAttachmentWrite;
2352 break;
2353 case vk::ImageLayout::eDepthStencilAttachmentOptimal:
2354 flags = vk::AccessFlagBits::eDepthStencilAttachmentWrite;
2355 break;
2356 case vk::ImageLayout::eShaderReadOnlyOptimal:
2357 // Make sure any Copy or CPU writes to image are flushed
2358 flags = vk::AccessFlagBits::eShaderRead | vk::AccessFlagBits::eInputAttachmentRead;
2359 break;
2360 case vk::ImageLayout::eTransferSrcOptimal:
2361 flags = vk::AccessFlagBits::eTransferRead;
2362 break;
2363 case vk::ImageLayout::ePresentSrcKHR:
2364 flags = vk::AccessFlagBits::eMemoryRead;
2365 break;
2366 default:
2367 break;
2368 }
2369
2370 return flags;
2371 };
2372
Charles Giessen87dd88d2022-02-03 13:46:29 -07002373 cmd.pipelineBarrier(src_stages, dest_stages, vk::DependencyFlagBits(), {}, {},
2374 vk::ImageMemoryBarrier()
2375 .setSrcAccessMask(srcAccessMask)
2376 .setDstAccessMask(DstAccessMask(newLayout))
2377 .setOldLayout(oldLayout)
2378 .setNewLayout(newLayout)
2379 .setSrcQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2380 .setDstQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
2381 .setImage(image)
2382 .setSubresourceRange(vk::ImageSubresourceRange(aspectMask, 0, 1, 0, 1)));
Dave Houlton5fa47912018-02-16 11:02:26 -07002383}
2384
2385void Demo::update_data_buffer() {
2386 mat4x4 VP;
2387 mat4x4_mul(VP, projection_matrix, view_matrix);
2388
2389 // Rotate around the Y axis
2390 mat4x4 Model;
2391 mat4x4_dup(Model, model_matrix);
Charles Giessen87dd88d2022-02-03 13:46:29 -07002392 mat4x4_rotate_Y(model_matrix, Model, static_cast<float>(degreesToRadians(spin_angle)));
Arman Uguray3ae08892021-05-25 00:07:24 -07002393 mat4x4_orthonormalize(model_matrix, model_matrix);
Dave Houlton5fa47912018-02-16 11:02:26 -07002394
2395 mat4x4 MVP;
2396 mat4x4_mul(MVP, VP, model_matrix);
2397
Tony-LunarG37af49f2019-12-19 12:04:19 -07002398 memcpy(swapchain_image_resources[current_buffer].uniform_memory_ptr, (const void *)&MVP[0][0], sizeof(MVP));
Dave Houlton5fa47912018-02-16 11:02:26 -07002399}
2400
Karl Schultzb7940402018-05-29 13:09:22 -06002401/* Convert ppm image data from header file into RGBA texture image */
2402#include "lunarg.ppm.h"
Charles Giessen3bcefe52022-02-21 11:57:16 -07002403bool 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 -06002404 (void)filename;
2405 char *cPtr;
2406 cPtr = (char *)lunarg_ppm;
2407 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "P6\n", 3)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002408 return false;
2409 }
Karl Schultzb7940402018-05-29 13:09:22 -06002410 while (strncmp(cPtr++, "\n", 1))
2411 ;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002412 sscanf(cPtr, "%u %u", &width, &height);
Charles Giessenc2f1a942022-02-06 23:38:39 -07002413 if (rgba_data == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002414 return true;
2415 }
Karl Schultzb7940402018-05-29 13:09:22 -06002416 while (strncmp(cPtr++, "\n", 1))
2417 ;
2418 if ((unsigned char *)cPtr >= (lunarg_ppm + lunarg_ppm_len) || strncmp(cPtr, "255\n", 4)) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002419 return false;
2420 }
Karl Schultzb7940402018-05-29 13:09:22 -06002421 while (strncmp(cPtr++, "\n", 1))
2422 ;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002423 for (uint32_t y = 0; y < height; y++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002424 uint8_t *rowPtr = rgba_data;
Charles Giessen3bcefe52022-02-21 11:57:16 -07002425 for (uint32_t x = 0; x < width; x++) {
Karl Schultzb7940402018-05-29 13:09:22 -06002426 memcpy(rowPtr, cPtr, 3);
Dave Houlton5fa47912018-02-16 11:02:26 -07002427 rowPtr[3] = 255; /* Alpha of 1 */
2428 rowPtr += 4;
Karl Schultzb7940402018-05-29 13:09:22 -06002429 cPtr += 3;
Dave Houlton5fa47912018-02-16 11:02:26 -07002430 }
Charles Giessen87dd88d2022-02-03 13:46:29 -07002431 rgba_data += layout.rowPitch;
Dave Houlton5fa47912018-02-16 11:02:26 -07002432 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002433 return true;
2434}
2435
Charles Giessen87dd88d2022-02-03 13:46:29 -07002436bool Demo::memory_type_from_properties(uint32_t typeBits, vk::MemoryPropertyFlags requirements_mask, uint32_t &typeIndex) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002437 // Search memtypes to find first index with those properties
2438 for (uint32_t i = 0; i < VK_MAX_MEMORY_TYPES; i++) {
2439 if ((typeBits & 1) == 1) {
2440 // Type is available, does it match user properties?
2441 if ((memory_properties.memoryTypes[i].propertyFlags & requirements_mask) == requirements_mask) {
Charles Giessen87dd88d2022-02-03 13:46:29 -07002442 typeIndex = i;
Dave Houlton5fa47912018-02-16 11:02:26 -07002443 return true;
2444 }
2445 }
2446 typeBits >>= 1;
2447 }
2448
2449 // No memory types matched, return failure
2450 return false;
2451}
2452
Charles Giessen7dc2dd52022-02-03 13:55:48 -07002453vk::SurfaceFormatKHR Demo::pick_surface_format(const std::vector<vk::SurfaceFormatKHR> &surface_formats) {
2454 // Prefer non-SRGB formats...
2455 for (const auto &surface_format : surface_formats) {
2456 const vk::Format format = surface_format.format;
2457
2458 if (format == vk::Format::eR8G8B8A8Unorm || format == vk::Format::eB8G8R8A8Unorm ||
2459 format == vk::Format::eA2B10G10R10UnormPack32 || format == vk::Format::eA2R10G10B10UnormPack32 ||
2460 format == vk::Format::eR16G16B16A16Sfloat) {
2461 return surface_format;
2462 }
2463 }
2464
2465 printf("Can't find our preferred formats... Falling back to first exposed format. Rendering may be incorrect.\n");
2466
2467 assert(surface_formats.size() >= 1);
2468 return surface_formats[0];
2469}
2470
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002471#if defined(VK_USE_PLATFORM_WIN32_KHR)
Dave Houlton5fa47912018-02-16 11:02:26 -07002472void Demo::run() {
2473 if (!prepared) {
2474 return;
2475 }
2476
2477 draw();
2478 curFrame++;
2479
Petr Krausd88e4e52019-01-23 18:45:04 +01002480 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002481 PostQuitMessage(validation_error);
2482 }
2483}
2484
2485void Demo::create_window() {
2486 WNDCLASSEX win_class;
2487
2488 // Initialize the window class structure:
2489 win_class.cbSize = sizeof(WNDCLASSEX);
2490 win_class.style = CS_HREDRAW | CS_VREDRAW;
2491 win_class.lpfnWndProc = WndProc;
2492 win_class.cbClsExtra = 0;
2493 win_class.cbWndExtra = 0;
2494 win_class.hInstance = connection; // hInstance
2495 win_class.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
2496 win_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
2497 win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
2498 win_class.lpszMenuName = nullptr;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002499 win_class.lpszClassName = name.c_str();
Dave Houlton5fa47912018-02-16 11:02:26 -07002500 win_class.hIconSm = LoadIcon(nullptr, IDI_WINLOGO);
2501
2502 // Register window class:
2503 if (!RegisterClassEx(&win_class)) {
2504 // It didn't work, so try to give a useful error:
2505 printf("Unexpected error trying to start the application!\n");
2506 fflush(stdout);
2507 exit(1);
2508 }
2509
2510 // Create window with the registered class:
2511 RECT wr = {0, 0, static_cast<LONG>(width), static_cast<LONG>(height)};
2512 AdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
2513 window = CreateWindowEx(0,
Charles Giessen87dd88d2022-02-03 13:46:29 -07002514 name.c_str(), // class name
2515 name.c_str(), // app name
Dave Houlton5fa47912018-02-16 11:02:26 -07002516 WS_OVERLAPPEDWINDOW | // window style
2517 WS_VISIBLE | WS_SYSMENU,
2518 100, 100, // x/y coords
2519 wr.right - wr.left, // width
2520 wr.bottom - wr.top, // height
2521 nullptr, // handle to parent
2522 nullptr, // handle to menu
2523 connection, // hInstance
2524 nullptr); // no extra parameters
2525
2526 if (!window) {
2527 // It didn't work, so try to give a useful error:
2528 printf("Cannot create a window in which to draw!\n");
2529 fflush(stdout);
2530 exit(1);
2531 }
2532
2533 // Window client area size must be at least 1 pixel high, to prevent
2534 // crash.
2535 minsize.x = GetSystemMetrics(SM_CXMINTRACK);
2536 minsize.y = GetSystemMetrics(SM_CYMINTRACK) + 1;
2537}
2538#elif defined(VK_USE_PLATFORM_XLIB_KHR)
2539
2540void Demo::create_xlib_window() {
2541 const char *display_envar = getenv("DISPLAY");
2542 if (display_envar == nullptr || display_envar[0] == '\0') {
2543 printf("Environment variable DISPLAY requires a valid value.\nExiting ...\n");
2544 fflush(stdout);
2545 exit(1);
2546 }
2547
2548 XInitThreads();
2549 display = XOpenDisplay(nullptr);
2550 long visualMask = VisualScreenMask;
2551 int numberOfVisuals;
2552 XVisualInfo vInfoTemplate = {};
2553 vInfoTemplate.screen = DefaultScreen(display);
2554 XVisualInfo *visualInfo = XGetVisualInfo(display, visualMask, &vInfoTemplate, &numberOfVisuals);
2555
2556 Colormap colormap = XCreateColormap(display, RootWindow(display, vInfoTemplate.screen), visualInfo->visual, AllocNone);
2557
2558 XSetWindowAttributes windowAttributes = {};
2559 windowAttributes.colormap = colormap;
2560 windowAttributes.background_pixel = 0xFFFFFFFF;
2561 windowAttributes.border_pixel = 0;
2562 windowAttributes.event_mask = KeyPressMask | KeyReleaseMask | StructureNotifyMask | ExposureMask;
2563
2564 xlib_window =
2565 XCreateWindow(display, RootWindow(display, vInfoTemplate.screen), 0, 0, width, height, 0, visualInfo->depth, InputOutput,
2566 visualInfo->visual, CWBackPixel | CWBorderPixel | CWEventMask | CWColormap, &windowAttributes);
2567
2568 XSelectInput(display, xlib_window, ExposureMask | KeyPressMask);
2569 XMapWindow(display, xlib_window);
2570 XFlush(display);
2571 xlib_wm_delete_window = XInternAtom(display, "WM_DELETE_WINDOW", False);
2572}
2573
2574void Demo::handle_xlib_event(const XEvent *event) {
2575 switch (event->type) {
2576 case ClientMessage:
2577 if ((Atom)event->xclient.data.l[0] == xlib_wm_delete_window) {
2578 quit = true;
2579 }
2580 break;
2581 case KeyPress:
2582 switch (event->xkey.keycode) {
2583 case 0x9: // Escape
2584 quit = true;
2585 break;
2586 case 0x71: // left arrow key
2587 spin_angle -= spin_increment;
2588 break;
2589 case 0x72: // right arrow key
2590 spin_angle += spin_increment;
2591 break;
2592 case 0x41: // space bar
2593 pause = !pause;
2594 break;
2595 }
2596 break;
2597 case ConfigureNotify:
2598 if (((int32_t)width != event->xconfigure.width) || ((int32_t)height != event->xconfigure.height)) {
2599 width = event->xconfigure.width;
2600 height = event->xconfigure.height;
2601 resize();
2602 }
2603 break;
2604 default:
2605 break;
2606 }
2607}
2608
2609void Demo::run_xlib() {
2610 while (!quit) {
2611 XEvent event;
2612
2613 if (pause) {
2614 XNextEvent(display, &event);
2615 handle_xlib_event(&event);
2616 }
2617 while (XPending(display) > 0) {
2618 XNextEvent(display, &event);
2619 handle_xlib_event(&event);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002620 }
2621
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002622 draw();
2623 curFrame++;
2624
Dave Houlton5fa47912018-02-16 11:02:26 -07002625 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2626 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002627 }
2628 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002629}
Tony Barbour153cb062016-12-07 13:43:36 -07002630#elif defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002631
Dave Houlton5fa47912018-02-16 11:02:26 -07002632void Demo::handle_xcb_event(const xcb_generic_event_t *event) {
2633 uint8_t event_code = event->response_type & 0x7f;
2634 switch (event_code) {
2635 case XCB_EXPOSE:
2636 // TODO: Resize window
2637 break;
2638 case XCB_CLIENT_MESSAGE:
2639 if ((*(xcb_client_message_event_t *)event).data.data32[0] == (*atom_wm_delete_window).atom) {
2640 quit = true;
2641 }
2642 break;
2643 case XCB_KEY_RELEASE: {
2644 const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002645
Dave Houlton5fa47912018-02-16 11:02:26 -07002646 switch (key->detail) {
2647 case 0x9: // Escape
2648 quit = true;
2649 break;
2650 case 0x71: // left arrow key
2651 spin_angle -= spin_increment;
2652 break;
2653 case 0x72: // right arrow key
2654 spin_angle += spin_increment;
2655 break;
2656 case 0x41: // space bar
2657 pause = !pause;
2658 break;
2659 }
2660 } break;
2661 case XCB_CONFIGURE_NOTIFY: {
2662 const xcb_configure_notify_event_t *cfg = (const xcb_configure_notify_event_t *)event;
2663 if ((width != cfg->width) || (height != cfg->height)) {
2664 width = cfg->width;
2665 height = cfg->height;
2666 resize();
2667 }
2668 } break;
2669 default:
2670 break;
2671 }
2672}
2673
2674void Demo::run_xcb() {
2675 xcb_flush(connection);
2676
2677 while (!quit) {
2678 xcb_generic_event_t *event;
2679
2680 if (pause) {
2681 event = xcb_wait_for_event(connection);
2682 } else {
2683 event = xcb_poll_for_event(connection);
2684 }
2685 while (event) {
2686 handle_xcb_event(event);
2687 free(event);
2688 event = xcb_poll_for_event(connection);
2689 }
2690
2691 draw();
2692 curFrame++;
2693 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2694 quit = true;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002695 }
2696 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002697}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002698
Dave Houlton5fa47912018-02-16 11:02:26 -07002699void Demo::create_xcb_window() {
2700 uint32_t value_mask, value_list[32];
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002701
Dave Houlton5fa47912018-02-16 11:02:26 -07002702 xcb_window = xcb_generate_id(connection);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002703
Dave Houlton5fa47912018-02-16 11:02:26 -07002704 value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
2705 value_list[0] = screen->black_pixel;
2706 value_list[1] = XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002707
Dave Houlton5fa47912018-02-16 11:02:26 -07002708 xcb_create_window(connection, XCB_COPY_FROM_PARENT, xcb_window, screen->root, 0, 0, width, height, 0,
2709 XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
2710
2711 /* Magic code that will send notification when window is destroyed */
2712 xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
2713 xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
2714
2715 xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
2716 atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
2717
2718 xcb_change_property(connection, XCB_PROP_MODE_REPLACE, xcb_window, (*reply).atom, 4, 32, 1, &(*atom_wm_delete_window).atom);
2719
2720 free(reply);
2721
2722 xcb_map_window(connection, xcb_window);
2723
2724 // Force the x/y coordinates to 100,100 results are identical in
2725 // consecutive
2726 // runs
Charles Giessen87dd88d2022-02-03 13:46:29 -07002727 std::array<uint32_t, 2> const coords = {100, 100};
2728 xcb_configure_window(connection, xcb_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, coords.data());
Dave Houlton5fa47912018-02-16 11:02:26 -07002729}
2730#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
2731
2732void Demo::run() {
2733 while (!quit) {
2734 if (pause) {
2735 wl_display_dispatch(display);
2736 } else {
2737 wl_display_dispatch_pending(display);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002738 draw();
2739 curFrame++;
Jeremy Hayes9d304782016-10-09 11:48:12 -06002740 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002741 quit = true;
2742 }
2743 }
2744 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002745}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002746
Manuel Stoecklac939332019-06-26 20:55:53 -04002747static void handle_surface_configure(void *data, xdg_surface *xdg_surface, uint32_t serial) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002748 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002749 xdg_surface_ack_configure(xdg_surface, serial);
Charles Giessen3bcefe52022-02-21 11:57:16 -07002750 if (demo.xdg_surface_has_been_configured) {
2751 demo.resize();
Manuel Stoecklac939332019-06-26 20:55:53 -04002752 }
Charles Giessen3bcefe52022-02-21 11:57:16 -07002753 demo.xdg_surface_has_been_configured = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002754}
2755
2756static const xdg_surface_listener surface_listener = {handle_surface_configure};
2757
2758static void handle_toplevel_configure(void *data, xdg_toplevel *xdg_toplevel, int32_t width, int32_t height,
2759 struct wl_array *states) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002760 Demo &demo = *static_cast<Demo *>(data);
Manuel Stoecklac939332019-06-26 20:55:53 -04002761 /* zero values imply the program may choose its own size, so in that case
2762 * stay with the existing value (which on startup is the default) */
2763 if (width > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002764 demo.width = static_cast<uint32_t>(width);
Manuel Stoecklac939332019-06-26 20:55:53 -04002765 }
2766 if (height > 0) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002767 demo.height = static_cast<uint32_t>(height);
Manuel Stoecklac939332019-06-26 20:55:53 -04002768 }
2769 // This will be followed by a surface configure
2770}
2771
2772static void handle_toplevel_close(void *data, xdg_toplevel *xdg_toplevel) {
Charles Giessen3bcefe52022-02-21 11:57:16 -07002773 Demo &demo = *static_cast<Demo *>(data);
2774 demo.quit = true;
Manuel Stoecklac939332019-06-26 20:55:53 -04002775}
2776
2777static const xdg_toplevel_listener toplevel_listener = {handle_toplevel_configure, handle_toplevel_close};
2778
Dave Houlton5fa47912018-02-16 11:02:26 -07002779void Demo::create_window() {
Manuel Stoecklac939332019-06-26 20:55:53 -04002780 if (!wm_base) {
2781 printf("Compositor did not provide the standard protocol xdg-wm-base\n");
2782 fflush(stdout);
2783 exit(1);
2784 }
2785
Dave Houlton5fa47912018-02-16 11:02:26 -07002786 window = wl_compositor_create_surface(compositor);
2787 if (!window) {
2788 printf("Can not create wayland_surface from compositor!\n");
2789 fflush(stdout);
2790 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002791 }
2792
Manuel Stoecklac939332019-06-26 20:55:53 -04002793 window_surface = xdg_wm_base_get_xdg_surface(wm_base, window);
2794 if (!window_surface) {
2795 printf("Can not get xdg_surface from wayland_surface!\n");
Dave Houlton5fa47912018-02-16 11:02:26 -07002796 fflush(stdout);
2797 exit(1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06002798 }
Manuel Stoecklac939332019-06-26 20:55:53 -04002799 window_toplevel = xdg_surface_get_toplevel(window_surface);
2800 if (!window_toplevel) {
2801 printf("Can not allocate xdg_toplevel for xdg_surface!\n");
2802 fflush(stdout);
2803 exit(1);
2804 }
2805 xdg_surface_add_listener(window_surface, &surface_listener, this);
2806 xdg_toplevel_add_listener(window_toplevel, &toplevel_listener, this);
2807 xdg_toplevel_set_title(window_toplevel, APP_SHORT_NAME);
2808 if (xdg_decoration_mgr) {
2809 // if supported, let the compositor render titlebars for us
2810 toplevel_decoration = zxdg_decoration_manager_v1_get_toplevel_decoration(xdg_decoration_mgr, window_toplevel);
2811 zxdg_toplevel_decoration_v1_set_mode(toplevel_decoration, ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE);
2812 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002813
Manuel Stoecklac939332019-06-26 20:55:53 -04002814 wl_surface_commit(window);
Dave Houlton5fa47912018-02-16 11:02:26 -07002815}
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002816#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
2817
2818void Demo::handle_directfb_event(const DFBInputEvent *event) {
2819 if (event->type != DIET_KEYPRESS) return;
2820 switch (event->key_symbol) {
2821 case DIKS_ESCAPE: // Escape
2822 quit = true;
2823 break;
2824 case DIKS_CURSOR_LEFT: // left arrow key
2825 spin_angle -= spin_increment;
2826 break;
2827 case DIKS_CURSOR_RIGHT: // right arrow key
2828 spin_angle += spin_increment;
2829 break;
2830 case DIKS_SPACE: // space bar
2831 pause = !pause;
2832 break;
2833 default:
2834 break;
2835 }
2836}
2837
2838void Demo::run_directfb() {
2839 while (!quit) {
2840 DFBInputEvent event;
2841
2842 if (pause) {
2843 event_buffer->WaitForEvent(event_buffer);
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002844 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002845 } else {
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002846 if (!event_buffer->GetEvent(event_buffer, DFB_EVENT(&event))) handle_directfb_event(&event);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002847
2848 draw();
2849 curFrame++;
2850 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2851 quit = true;
2852 }
2853 }
2854 }
2855}
2856
2857void Demo::create_directfb_window() {
2858 DFBResult ret;
2859
Charles Giessenc2f1a942022-02-06 23:38:39 -07002860 ret = DirectFBInit(nullptr, nullptr);
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002861 if (ret) {
2862 printf("DirectFBInit failed to initialize DirectFB!\n");
2863 fflush(stdout);
2864 exit(1);
2865 }
2866
2867 ret = DirectFBCreate(&dfb);
2868 if (ret) {
2869 printf("DirectFBCreate failed to create main interface of DirectFB!\n");
2870 fflush(stdout);
2871 exit(1);
2872 }
2873
2874 DFBSurfaceDescription desc;
2875 desc.flags = (DFBSurfaceDescriptionFlags)(DSDESC_CAPS | DSDESC_WIDTH | DSDESC_HEIGHT);
2876 desc.caps = DSCAPS_PRIMARY;
Nicolas Caramelli6d4f1c62020-07-13 18:10:07 +02002877 desc.width = width;
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02002878 desc.height = height;
2879 ret = dfb->CreateSurface(dfb, &desc, &window);
2880 if (ret) {
2881 printf("CreateSurface failed to create DirectFB surface interface!\n");
2882 fflush(stdout);
2883 exit(1);
2884 }
2885
2886 ret = dfb->CreateInputEventBuffer(dfb, DICAPS_KEYS, DFB_FALSE, &event_buffer);
2887 if (ret) {
2888 printf("CreateInputEventBuffer failed to create DirectFB event buffer interface!\n");
2889 fflush(stdout);
2890 exit(1);
2891 }
2892}
Bill Hollings0a0625a2019-07-15 17:39:18 -04002893#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz206b1c52018-04-13 18:02:07 -06002894void Demo::run() {
2895 draw();
2896 curFrame++;
2897 if (frameCount != UINT32_MAX && curFrame == frameCount) {
2898 quit = true;
2899 }
2900}
Damien Leone600c3052017-01-31 10:26:07 -07002901#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
2902
Dave Houlton5fa47912018-02-16 11:02:26 -07002903vk::Result Demo::create_display_surface() {
Charles Giessenc2f1a942022-02-06 23:38:39 -07002904 auto display_properties_return = gpu.getDisplayPropertiesKHR();
2905 VERIFY((display_properties_return.result == vk::Result::eSuccess) ||
2906 (display_properties_return.result == vk::Result::eIncomplete));
Damien Leone600c3052017-01-31 10:26:07 -07002907
Charles Giessenc2f1a942022-02-06 23:38:39 -07002908 auto display = display_properties_return.value.at(0).display;
Dave Houlton5fa47912018-02-16 11:02:26 -07002909
Charles Giessenc2f1a942022-02-06 23:38:39 -07002910 auto display_mode_props_return = gpu.getDisplayModePropertiesKHR(display);
2911 VERIFY(display_mode_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002912
Charles Giessenc2f1a942022-02-06 23:38:39 -07002913 if (display_mode_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002914 printf("Cannot find any mode for the display!\n");
2915 fflush(stdout);
2916 exit(1);
2917 }
Charles Giessenc2f1a942022-02-06 23:38:39 -07002918 auto display_mode_prop = display_mode_props_return.value.at(0);
Dave Houlton5fa47912018-02-16 11:02:26 -07002919
2920 // Get the list of planes
Charles Giessenc2f1a942022-02-06 23:38:39 -07002921 auto display_plane_props_return = gpu.getDisplayPlanePropertiesKHR();
2922 VERIFY(display_plane_props_return.result == vk::Result::eSuccess);
Dave Houlton5fa47912018-02-16 11:02:26 -07002923
Charles Giessenc2f1a942022-02-06 23:38:39 -07002924 if (display_plane_props_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002925 printf("Cannot find any plane!\n");
2926 fflush(stdout);
2927 exit(1);
2928 }
Charles Giessen431f3b52022-03-30 16:17:29 -06002929 auto display_plane_props = display_plane_props_return.value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002930
Charles Giessenc2f1a942022-02-06 23:38:39 -07002931 vk::Bool32 found_plane = VK_FALSE;
Charles Giessen431f3b52022-03-30 16:17:29 -06002932 uint32_t plane_found = 0;
Dave Houlton5fa47912018-02-16 11:02:26 -07002933 // Find a plane compatible with the display
Charles Giessen431f3b52022-03-30 16:17:29 -06002934 for (uint32_t plane_index = 0; plane_index < display_plane_props.size(); plane_index++) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002935 // Disqualify planes that are bound to a different display
Charles Giessen431f3b52022-03-30 16:17:29 -06002936 if (display_plane_props[plane_index].currentDisplay && (display_plane_props[plane_index].currentDisplay != display)) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002937 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002938 }
2939
Charles Giessenc2f1a942022-02-06 23:38:39 -07002940 auto display_plane_supported_displays_return = gpu.getDisplayPlaneSupportedDisplaysKHR(plane_index);
2941 VERIFY(display_plane_supported_displays_return.result == vk::Result::eSuccess);
Damien Leone600c3052017-01-31 10:26:07 -07002942
Charles Giessenc2f1a942022-02-06 23:38:39 -07002943 if (display_plane_supported_displays_return.value.size() == 0) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002944 continue;
Damien Leone600c3052017-01-31 10:26:07 -07002945 }
2946
Charles Giessenc2f1a942022-02-06 23:38:39 -07002947 for (const auto &supported_display : display_plane_supported_displays_return.value) {
2948 if (supported_display == display) {
Dave Houlton5fa47912018-02-16 11:02:26 -07002949 found_plane = VK_TRUE;
Charles Giessen431f3b52022-03-30 16:17:29 -06002950 plane_found = plane_index;
Damien Leone600c3052017-01-31 10:26:07 -07002951 break;
2952 }
2953 }
2954
Dave Houlton5fa47912018-02-16 11:02:26 -07002955 if (found_plane) {
2956 break;
Damien Leone600c3052017-01-31 10:26:07 -07002957 }
2958 }
Dave Houlton5fa47912018-02-16 11:02:26 -07002959
2960 if (!found_plane) {
2961 printf("Cannot find a plane compatible with the display!\n");
2962 fflush(stdout);
2963 exit(1);
2964 }
2965
Charles Giessendd7e8d22022-05-26 15:26:32 -06002966 vk::DisplayPlaneCapabilitiesKHR planeCaps =
2967 gpu.getDisplayPlaneCapabilitiesKHR(display_mode_prop.displayMode, plane_found).value;
Dave Houlton5fa47912018-02-16 11:02:26 -07002968 // Find a supported alpha mode
2969 vk::DisplayPlaneAlphaFlagBitsKHR alphaMode = vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque;
Charles Giessen87dd88d2022-02-03 13:46:29 -07002970 std::array<vk::DisplayPlaneAlphaFlagBitsKHR, 4> alphaModes = {
Dave Houlton5fa47912018-02-16 11:02:26 -07002971 vk::DisplayPlaneAlphaFlagBitsKHR::eOpaque,
2972 vk::DisplayPlaneAlphaFlagBitsKHR::eGlobal,
2973 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixel,
2974 vk::DisplayPlaneAlphaFlagBitsKHR::ePerPixelPremultiplied,
2975 };
Charles Giessen87dd88d2022-02-03 13:46:29 -07002976 for (const auto &alpha_mode : alphaModes) {
2977 if (planeCaps.supportedAlpha & alpha_mode) {
2978 alphaMode = alpha_mode;
Dave Houlton5fa47912018-02-16 11:02:26 -07002979 break;
2980 }
2981 }
2982
Charles Giessenc2f1a942022-02-06 23:38:39 -07002983 vk::Extent2D image_extent{};
Charles Giessen431f3b52022-03-30 16:17:29 -06002984 image_extent.setWidth(display_mode_prop.parameters.visibleRegion.width)
2985 .setHeight(display_mode_prop.parameters.visibleRegion.height);
Dave Houlton5fa47912018-02-16 11:02:26 -07002986
2987 auto const createInfo = vk::DisplaySurfaceCreateInfoKHR()
Charles Giessen431f3b52022-03-30 16:17:29 -06002988 .setDisplayMode(display_mode_prop.displayMode)
2989 .setPlaneIndex(plane_found)
2990 .setPlaneStackIndex(display_plane_props[plane_found].currentStackIndex)
Dave Houlton5fa47912018-02-16 11:02:26 -07002991 .setGlobalAlpha(1.0f)
2992 .setAlphaMode(alphaMode)
2993 .setImageExtent(image_extent);
2994
2995 return inst.createDisplayPlaneSurfaceKHR(&createInfo, nullptr, &surface);
2996}
2997
2998void Demo::run_display() {
2999 while (!quit) {
3000 draw();
3001 curFrame++;
3002
Petr Krausd88e4e52019-01-23 18:45:04 +01003003 if (frameCount != UINT32_MAX && curFrame == frameCount) {
Dave Houlton5fa47912018-02-16 11:02:26 -07003004 quit = true;
3005 }
3006 }
3007}
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003008#endif
3009
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003010#if _WIN32
3011// Include header required for parsing the command line options.
3012#include <shellapi.h>
3013
3014Demo demo;
3015
3016// MS-Windows event handling function:
Jeremy Hayes9d304782016-10-09 11:48:12 -06003017LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
3018 switch (uMsg) {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003019 case WM_CLOSE:
3020 PostQuitMessage(validation_error);
3021 break;
3022 case WM_PAINT:
Charles Giessen74f007d2022-02-08 14:04:45 -07003023 if (!demo.in_callback) {
3024 demo.run();
3025 }
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003026 break;
3027 case WM_GETMINMAXINFO: // set window's minimum size
3028 ((MINMAXINFO *)lParam)->ptMinTrackSize = demo.minsize;
3029 return 0;
Aaron Hagan500b9c32018-10-03 21:56:29 -04003030 case WM_ERASEBKGND:
3031 return 1;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003032 case WM_SIZE:
3033 // Resize the application to the new window size, except when
3034 // it was minimized. Vulkan doesn't support images or swapchains
3035 // with width=0 and height=0.
3036 if (wParam != SIZE_MINIMIZED) {
3037 demo.width = lParam & 0xffff;
3038 demo.height = (lParam & 0xffff0000) >> 16;
3039 demo.resize();
3040 }
3041 break;
Petr Krausd88e4e52019-01-23 18:45:04 +01003042 case WM_KEYDOWN:
3043 switch (wParam) {
3044 case VK_ESCAPE:
3045 PostQuitMessage(validation_error);
3046 break;
3047 case VK_LEFT:
3048 demo.spin_angle -= demo.spin_increment;
3049 break;
3050 case VK_RIGHT:
3051 demo.spin_angle += demo.spin_increment;
3052 break;
3053 case VK_SPACE:
3054 demo.pause = !demo.pause;
3055 break;
3056 }
3057 return 0;
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003058 default:
3059 break;
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003060 }
3061
3062 return (DefWindowProc(hWnd, uMsg, wParam, lParam));
3063}
3064
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003065int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR pCmdLine, int nCmdShow) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003066 // TODO: Gah.. refactor. This isn't 1989.
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003067 MSG msg; // message
3068 bool done; // flag saying when app is complete
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003069 int argc;
3070 char **argv;
3071
Jamie Madillb2ff6502017-03-15 16:17:46 -04003072 // Ensure wParam is initialized.
3073 msg.wParam = 0;
3074
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003075 // Use the CommandLine functions to get the command line arguments.
3076 // Unfortunately, Microsoft outputs
3077 // this information as wide characters for Unicode, and we simply want the
3078 // Ascii version to be compatible
3079 // with the non-Windows side. So, we have to convert the information to
3080 // Ascii character strings.
3081 LPWSTR *commandLineArgs = CommandLineToArgvW(GetCommandLineW(), &argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003082 if (nullptr == commandLineArgs) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003083 argc = 0;
3084 }
3085
Jeremy Hayes9d304782016-10-09 11:48:12 -06003086 if (argc > 0) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003087 argv = (char **)malloc(sizeof(char *) * argc);
Jeremy Hayes9d304782016-10-09 11:48:12 -06003088 if (argv == nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003089 argc = 0;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003090 } else {
3091 for (int iii = 0; iii < argc; iii++) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003092 size_t wideCharLen = wcslen(commandLineArgs[iii]);
3093 size_t numConverted = 0;
3094
3095 argv[iii] = (char *)malloc(sizeof(char) * (wideCharLen + 1));
Jeremy Hayes9d304782016-10-09 11:48:12 -06003096 if (argv[iii] != nullptr) {
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003097 wcstombs_s(&numConverted, argv[iii], wideCharLen + 1, commandLineArgs[iii], wideCharLen + 1);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003098 }
3099 }
3100 }
Jeremy Hayes9d304782016-10-09 11:48:12 -06003101 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003102 argv = nullptr;
3103 }
3104
3105 demo.init(argc, argv);
3106
3107 // Free up the items we had to allocate for the command line arguments.
Jeremy Hayes9d304782016-10-09 11:48:12 -06003108 if (argc > 0 && argv != nullptr) {
3109 for (int iii = 0; iii < argc; iii++) {
3110 if (argv[iii] != nullptr) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003111 free(argv[iii]);
3112 }
3113 }
3114 free(argv);
3115 }
3116
3117 demo.connection = hInstance;
Charles Giessen87dd88d2022-02-03 13:46:29 -07003118 demo.name = "Vulkan Cube";
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003119 demo.create_window();
3120 demo.init_vk_swapchain();
3121
3122 demo.prepare();
3123
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003124 done = false; // initialize loop condition variable
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003125
3126 // main message loop
Jeremy Hayes9d304782016-10-09 11:48:12 -06003127 while (!done) {
Petr Krausd88e4e52019-01-23 18:45:04 +01003128 if (demo.pause) {
3129 const BOOL succ = WaitMessage();
3130
3131 if (!succ) {
3132 const auto &suppress_popups = demo.suppress_popups;
3133 ERR_EXIT("WaitMessage() failed on paused demo", "event loop error");
3134 }
3135 }
3136
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003137 PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE);
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003138 if (msg.message == WM_QUIT) // check for a quit message
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003139 {
Mark Lobodzinski85dbd822017-01-26 13:34:13 -07003140 done = true; // if found, quit app
Jeremy Hayes9d304782016-10-09 11:48:12 -06003141 } else {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003142 /* Translate and dispatch to event queue*/
3143 TranslateMessage(&msg);
3144 DispatchMessage(&msg);
3145 }
3146 RedrawWindow(demo.window, nullptr, nullptr, RDW_INTERNALPAINT);
3147 }
3148
3149 demo.cleanup();
3150
Charles Giessen87dd88d2022-02-03 13:46:29 -07003151 return static_cast<int>(msg.wParam);
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003152}
3153
Brad Smith77cf67d2022-08-30 19:13:27 -04003154#elif defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__)
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003155
Jeremy Hayes9d304782016-10-09 11:48:12 -06003156int main(int argc, char **argv) {
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003157 Demo demo;
3158
3159 demo.init(argc, argv);
3160
Tony Barbour153cb062016-12-07 13:43:36 -07003161#if defined(VK_USE_PLATFORM_XCB_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003162 demo.create_xcb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003163#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Tony Barbour78d6b572016-11-14 14:46:33 -07003164 demo.use_xlib = true;
Jeremy Hayes9d304782016-10-09 11:48:12 -06003165 demo.create_xlib_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003166#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Jeremy Hayes9d304782016-10-09 11:48:12 -06003167 demo.create_window();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003168#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3169 demo.create_directfb_window();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003170#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003171
3172 demo.init_vk_swapchain();
3173
3174 demo.prepare();
3175
Tony Barbour153cb062016-12-07 13:43:36 -07003176#if defined(VK_USE_PLATFORM_XCB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003177 demo.run_xcb();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003178#elif defined(VK_USE_PLATFORM_XLIB_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003179 demo.run_xlib();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003180#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
Mark Lobodzinski2dbc2662017-01-26 12:16:30 -07003181 demo.run();
Nicolas Caramellic8be8c82020-07-13 17:22:09 +02003182#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
3183 demo.run_directfb();
Damien Leone600c3052017-01-31 10:26:07 -07003184#elif defined(VK_USE_PLATFORM_DISPLAY_KHR)
3185 demo.run_display();
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003186#endif
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003187
3188 demo.cleanup();
3189
3190 return validation_error;
3191}
3192
Bill Hollings0a0625a2019-07-15 17:39:18 -04003193#elif defined(VK_USE_PLATFORM_METAL_EXT)
Karl Schultz9ceac062017-12-12 10:33:01 -05003194
3195// Global function invoked from NS or UI views and controllers to create demo
Charles Giessen87dd88d2022-02-03 13:46:29 -07003196static void demo_main(Demo &demo, void *caMetalLayer, int argc, const char *argv[]) {
Karl Schultz9ceac062017-12-12 10:33:01 -05003197 demo.init(argc, (char **)argv);
Bill Hollings0a0625a2019-07-15 17:39:18 -04003198 demo.caMetalLayer = caMetalLayer;
Karl Schultz9ceac062017-12-12 10:33:01 -05003199 demo.init_vk_swapchain();
3200 demo.prepare();
3201 demo.spin_angle = 0.4f;
3202}
3203
Jeremy Hayesf56427a2016-09-07 15:55:11 -06003204#else
3205#error "Platform not supported"
3206#endif