/* Copyright (c) 2017-2020 Hans-Kristian Arntzen * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "wsi.hpp" #include "quirks.hpp" #include using namespace std; namespace Vulkan { WSI::WSI() { } void WSIPlatform::set_window_title(const string &) { } uintptr_t WSIPlatform::get_fullscreen_monitor() { return 0; } void WSI::set_window_title(const string &title) { if (platform) platform->set_window_title(title); } double WSI::get_smooth_elapsed_time() const { return smooth_elapsed_time; } double WSI::get_smooth_frame_time() const { return smooth_frame_time; } float WSIPlatform::get_estimated_frame_presentation_duration() { // Just assume 60 FPS for now. // TODO: Be more intelligent. return 1.0f / 60.0f; } float WSI::get_estimated_video_latency() { if (using_display_timing) { // Very accurate estimate. double latency = timing.get_current_latency(); return float(latency); } else { // Very rough estimate. unsigned latency_frames = device->get_num_swapchain_images(); if (latency_frames > 0) latency_frames--; if (platform) { float frame_duration = platform->get_estimated_frame_presentation_duration(); return frame_duration * float(latency_frames); } else return -1.0f; } } bool WSI::init_external_context(unique_ptr fresh_context) { context = move(fresh_context); // Need to have a dummy swapchain in place before we issue create device events. device.reset(new Device); device->set_context(*context); device->init_external_swapchain({ ImageHandle(nullptr) }); platform->event_device_created(device.get()); table = &context->get_device_table(); return true; } bool WSI::init_external_swapchain(vector swapchain_images_) { swapchain_width = platform->get_surface_width(); swapchain_height = platform->get_surface_height(); swapchain_aspect_ratio = platform->get_aspect_ratio(); external_swapchain_images = move(swapchain_images_); swapchain_width = external_swapchain_images.front()->get_width(); swapchain_height = external_swapchain_images.front()->get_height(); swapchain_format = external_swapchain_images.front()->get_format(); LOGI("Created swapchain %u x %u (fmt: %u).\n", swapchain_width, swapchain_height, static_cast(swapchain_format)); platform->event_swapchain_destroyed(); platform->event_swapchain_created(device.get(), swapchain_width, swapchain_height, swapchain_aspect_ratio, external_swapchain_images.size(), swapchain_format, swapchain_current_prerotate); device->init_external_swapchain(this->external_swapchain_images); platform->get_frame_timer().reset(); external_acquire.reset(); external_release.reset(); return true; } void WSI::set_platform(WSIPlatform *platform_) { platform = platform_; } bool WSI::init(unsigned num_thread_indices, const Context::SystemHandles &system_handles) { auto instance_ext = platform->get_instance_extensions(); auto device_ext = platform->get_device_extensions(); context.reset(new Context); context->set_num_thread_indices(num_thread_indices); context->set_system_handles(system_handles); if (!context->init_instance_and_device(instance_ext.data(), instance_ext.size(), device_ext.data(), device_ext.size())) return false; device.reset(new Device); device->set_context(*context); table = &context->get_device_table(); platform->event_device_created(device.get()); surface = platform->create_surface(context->get_instance(), context->get_gpu()); if (surface == VK_NULL_HANDLE) return false; unsigned width = platform->get_surface_width(); unsigned height = platform->get_surface_height(); swapchain_aspect_ratio = platform->get_aspect_ratio(); VkBool32 supported = VK_FALSE; vkGetPhysicalDeviceSurfaceSupportKHR(context->get_gpu(), context->get_graphics_queue_family(), surface, &supported); if (!supported) return false; if (!blocking_init_swapchain(width, height)) return false; device->init_swapchain(swapchain_images, swapchain_width, swapchain_height, swapchain_format, swapchain_current_prerotate); platform->get_frame_timer().reset(); return true; } void WSI::init_surface_and_swapchain(VkSurfaceKHR new_surface) { LOGI("init_surface_and_swapchain()\n"); if (new_surface != VK_NULL_HANDLE) { VK_ASSERT(surface == VK_NULL_HANDLE); surface = new_surface; } swapchain_width = platform->get_surface_width(); swapchain_height = platform->get_surface_height(); update_framebuffer(swapchain_width, swapchain_height); } void WSI::drain_swapchain() { release_semaphores.clear(); device->set_acquire_semaphore(0, Semaphore{}); device->consume_release_semaphore(); device->wait_idle(); } void WSI::tear_down_swapchain() { drain_swapchain(); if (swapchain != VK_NULL_HANDLE) table->vkDestroySwapchainKHR(context->get_device(), swapchain, nullptr); swapchain = VK_NULL_HANDLE; has_acquired_swapchain_index = false; } void WSI::deinit_surface_and_swapchain() { LOGI("deinit_surface_and_swapchain()\n"); tear_down_swapchain(); if (surface != VK_NULL_HANDLE) vkDestroySurfaceKHR(context->get_instance(), surface, nullptr); surface = VK_NULL_HANDLE; platform->event_swapchain_destroyed(); } void WSI::set_external_frame(unsigned index, Semaphore acquire_semaphore, double frame_time) { external_frame_index = index; external_acquire = move(acquire_semaphore); frame_is_external = true; external_frame_time = frame_time; } bool WSI::begin_frame_external() { device->next_frame_context(); // Need to handle this stuff from outside. if (has_acquired_swapchain_index) return false; auto frame_time = platform->get_frame_timer().frame(external_frame_time); auto elapsed_time = platform->get_frame_timer().get_elapsed(); // Assume we have been given a smooth frame pacing. smooth_frame_time = frame_time; smooth_elapsed_time = elapsed_time; // Poll after acquire as well for optimal latency. platform->poll_input(); swapchain_index = external_frame_index; platform->event_frame_tick(frame_time, elapsed_time); platform->event_swapchain_index(device.get(), swapchain_index); device->set_acquire_semaphore(swapchain_index, external_acquire); external_acquire.reset(); return true; } Semaphore WSI::consume_external_release_semaphore() { Semaphore sem; swap(external_release, sem); return sem; } //#define VULKAN_WSI_TIMING_DEBUG bool WSI::begin_frame() { if (frame_is_external) return begin_frame_external(); #ifdef VULKAN_WSI_TIMING_DEBUG auto next_frame_start = Util::get_current_time_nsecs(); #endif device->next_frame_context(); #ifdef VULKAN_WSI_TIMING_DEBUG auto next_frame_end = Util::get_current_time_nsecs(); LOGI("Waited for vacant frame context for %.3f ms.\n", (next_frame_end - next_frame_start) * 1e-6); #endif if (swapchain == VK_NULL_HANDLE || platform->should_resize()) { update_framebuffer(platform->get_surface_width(), platform->get_surface_height()); platform->acknowledge_resize(); } if (swapchain == VK_NULL_HANDLE) { LOGE("Completely lost swapchain. Cannot continue.\n"); return false; } if (has_acquired_swapchain_index) return true; external_release.reset(); VkResult result; do { auto acquire = device->request_legacy_semaphore(); // For adaptive low latency we don't want to observe the time it takes to wait for // WSI semaphore as part of our latency, // which means we will never get sub-frame latency on some implementations, // so block on that first. Fence fence; if (timing.get_options().latency_limiter == LatencyLimiter::AdaptiveLowLatency) fence = device->request_legacy_fence(); #ifdef VULKAN_WSI_TIMING_DEBUG auto acquire_start = Util::get_current_time_nsecs(); #endif auto acquire_ts = device->write_calibrated_timestamp(); result = table->vkAcquireNextImageKHR(context->get_device(), swapchain, UINT64_MAX, acquire->get_semaphore(), fence ? fence->get_fence() : VK_NULL_HANDLE, &swapchain_index); device->register_time_interval("WSI", std::move(acquire_ts), device->write_calibrated_timestamp(), "acquire"); #if defined(ANDROID) && 0 // Android 10 can return suboptimal here, only because of pre-transform. // We don't care about that, and treat this as success. if (result == VK_SUBOPTIMAL_KHR) result = VK_SUCCESS; #endif if (result == VK_SUCCESS && fence) fence->wait(); if (result == VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT) { LOGE("Lost exclusive full-screen ...\n"); } #ifdef VULKAN_WSI_TIMING_DEBUG auto acquire_end = Util::get_current_time_nsecs(); LOGI("vkAcquireNextImageKHR took %.3f ms.\n", (acquire_end - acquire_start) * 1e-6); #endif if (result == VK_SUCCESS) { has_acquired_swapchain_index = true; acquire->signal_external(); auto frame_time = platform->get_frame_timer().frame(); auto elapsed_time = platform->get_frame_timer().get_elapsed(); if (using_display_timing) timing.begin_frame(frame_time, elapsed_time); smooth_frame_time = frame_time; smooth_elapsed_time = elapsed_time; // Poll after acquire as well for optimal latency. platform->poll_input(); platform->event_frame_tick(frame_time, elapsed_time); platform->event_swapchain_index(device.get(), swapchain_index); if (device->get_workarounds().wsi_acquire_barrier_is_expensive) { // Acquire async. Use the async graphics queue, as it's most likely not being used right away. device->add_wait_semaphore(CommandBuffer::Type::AsyncGraphics, acquire, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, true); auto cmd = device->request_command_buffer(CommandBuffer::Type::AsyncGraphics); cmd->image_barrier(device->get_swapchain_view(swapchain_index).get_image(), VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, 0, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, 0); // Get a new acquire semaphore. acquire.reset(); device->submit(cmd, nullptr, 1, &acquire); } device->set_acquire_semaphore(swapchain_index, acquire); } else if (result == VK_SUBOPTIMAL_KHR || result == VK_ERROR_OUT_OF_DATE_KHR || result == VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT) { VK_ASSERT(swapchain_width != 0); VK_ASSERT(swapchain_height != 0); tear_down_swapchain(); if (!blocking_init_swapchain(swapchain_width, swapchain_height)) return false; device->init_swapchain(swapchain_images, swapchain_width, swapchain_height, swapchain_format, swapchain_current_prerotate); } else { return false; } } while (result != VK_SUCCESS); return true; } bool WSI::end_frame() { device->end_frame_context(); // Take ownership of the release semaphore so that the external user can use it. if (frame_is_external) { // If we didn't render into the swapchain this frame, we will return a blank semaphore. external_release = device->consume_release_semaphore(); if (external_release && !external_release->is_signalled()) abort(); frame_is_external = false; } else { if (!device->swapchain_touched()) return true; has_acquired_swapchain_index = false; auto release = device->consume_release_semaphore(); VK_ASSERT(release); VK_ASSERT(release->is_signalled()); auto release_semaphore = release->get_semaphore(); VK_ASSERT(release_semaphore != VK_NULL_HANDLE); VkResult result = VK_SUCCESS; VkPresentInfoKHR info = { VK_STRUCTURE_TYPE_PRESENT_INFO_KHR }; info.waitSemaphoreCount = 1; info.pWaitSemaphores = &release_semaphore; info.swapchainCount = 1; info.pSwapchains = &swapchain; info.pImageIndices = &swapchain_index; info.pResults = &result; VkPresentTimeGOOGLE present_time; VkPresentTimesInfoGOOGLE present_timing = { VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE }; present_timing.swapchainCount = 1; present_timing.pTimes = &present_time; if (using_display_timing && timing.fill_present_info_timing(present_time)) { info.pNext = &present_timing; } #ifdef VULKAN_WSI_TIMING_DEBUG auto present_start = Util::get_current_time_nsecs(); #endif auto present_ts = device->write_calibrated_timestamp(); VkResult overall = table->vkQueuePresentKHR(context->get_graphics_queue(), &info); device->register_time_interval("WSI", std::move(present_ts), device->write_calibrated_timestamp(), "present"); #if defined(ANDROID) && 0 // Android 10 can return suboptimal here, only because of pre-transform. // We don't care about that, and treat this as success. if (overall == VK_SUBOPTIMAL_KHR) overall = VK_SUCCESS; if (result == VK_SUBOPTIMAL_KHR) result = VK_SUCCESS; #endif if (overall == VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT || result == VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT) { LOGE("Lost exclusive full-screen ...\n"); } #ifdef VULKAN_WSI_TIMING_DEBUG auto present_end = Util::get_current_time_nsecs(); LOGI("vkQueuePresentKHR took %.3f ms.\n", (present_end - present_start) * 1e-6); #endif if (overall != VK_SUCCESS || result != VK_SUCCESS) { LOGE("vkQueuePresentKHR failed.\n"); tear_down_swapchain(); return false; } else { release->wait_external(); // Cannot release the WSI wait semaphore until we observe that the image has been // waited on again. release_semaphores[swapchain_index] = release; } // Re-init swapchain. if (present_mode != current_present_mode || srgb_backbuffer_enable != current_srgb_backbuffer_enable) { current_present_mode = present_mode; current_srgb_backbuffer_enable = srgb_backbuffer_enable; update_framebuffer(swapchain_width, swapchain_height); } } return true; } void WSI::update_framebuffer(unsigned width, unsigned height) { if (context && device) { drain_swapchain(); if (blocking_init_swapchain(width, height)) device->init_swapchain(swapchain_images, swapchain_width, swapchain_height, swapchain_format, swapchain_current_prerotate); } } void WSI::set_present_mode(PresentMode mode) { present_mode = mode; if (!has_acquired_swapchain_index && present_mode != current_present_mode) { current_present_mode = present_mode; update_framebuffer(swapchain_width, swapchain_height); } } void WSI::set_backbuffer_srgb(bool enable) { srgb_backbuffer_enable = enable; if (!has_acquired_swapchain_index && srgb_backbuffer_enable != current_srgb_backbuffer_enable) { current_srgb_backbuffer_enable = srgb_backbuffer_enable; update_framebuffer(swapchain_width, swapchain_height); } } void WSI::deinit_external() { if (platform) platform->release_resources(); if (context) { tear_down_swapchain(); platform->event_swapchain_destroyed(); } if (surface != VK_NULL_HANDLE) vkDestroySurfaceKHR(context->get_instance(), surface, nullptr); if (platform) platform->event_device_destroyed(); external_release.reset(); external_acquire.reset(); external_swapchain_images.clear(); device.reset(); context.reset(); using_display_timing = false; } bool WSI::blocking_init_swapchain(unsigned width, unsigned height) { SwapchainError err; unsigned retry_counter = 0; do { swapchain_aspect_ratio = platform->get_aspect_ratio(); err = init_swapchain(width, height); if (err == SwapchainError::Error) { if (++retry_counter > 3) return false; // Try to not reuse the swapchain. tear_down_swapchain(); } else if (err == SwapchainError::NoSurface && platform->alive(*this)) { platform->poll_input(); this_thread::sleep_for(chrono::milliseconds(10)); } } while (err != SwapchainError::None); return swapchain != VK_NULL_HANDLE; } WSI::SwapchainError WSI::init_swapchain(unsigned width, unsigned height) { if (surface == VK_NULL_HANDLE) { LOGE("Cannot create swapchain with surface == VK_NULL_HANDLE.\n"); return SwapchainError::Error; } VkSurfaceCapabilitiesKHR surface_properties; VkPhysicalDeviceSurfaceInfo2KHR surface_info = { VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR }; surface_info.surface = surface; bool use_surface_info = device->get_device_features().supports_surface_capabilities2; bool use_application_controlled_exclusive_fullscreen = false; #ifdef _WIN32 VkSurfaceFullScreenExclusiveInfoEXT exclusive_info = { VK_STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_INFO_EXT }; VkSurfaceFullScreenExclusiveWin32InfoEXT exclusive_info_win32 = { VK_STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_WIN32_INFO_EXT }; HMONITOR monitor = reinterpret_cast(platform->get_fullscreen_monitor()); if (!device->get_device_features().supports_full_screen_exclusive) monitor = nullptr; surface_info.pNext = &exclusive_info; if (monitor != nullptr) { exclusive_info.pNext = &exclusive_info_win32; exclusive_info_win32.hmonitor = monitor; LOGI("Win32: Got a full-screen monitor.\n"); } else LOGI("Win32: Not running full-screen.\n"); const char *exclusive = getenv("GRANITE_EXCLUSIVE_FULL_SCREEN"); bool prefer_exclusive = exclusive && strtoul(exclusive, nullptr, 0) != 0; if (prefer_exclusive) { LOGI("Win32: Opting in to exclusive full-screen!\n"); exclusive_info.fullScreenExclusive = VK_FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT; } else { LOGI("Win32: Opting out of exclusive full-screen!\n"); exclusive_info.fullScreenExclusive = VK_FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT; } #endif auto gpu = context->get_gpu(); if (use_surface_info) { VkSurfaceCapabilities2KHR surface_capabilities2 = { VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR }; #ifdef _WIN32 VkSurfaceCapabilitiesFullScreenExclusiveEXT capability_full_screen_exclusive = { VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_FULL_SCREEN_EXCLUSIVE_EXT }; if (device->get_device_features().supports_full_screen_exclusive && exclusive_info_win32.hmonitor) { surface_capabilities2.pNext = &capability_full_screen_exclusive; capability_full_screen_exclusive.pNext = &exclusive_info_win32; } #endif if (vkGetPhysicalDeviceSurfaceCapabilities2KHR(gpu, &surface_info, &surface_capabilities2) != VK_SUCCESS) return SwapchainError::Error; surface_properties = surface_capabilities2.surfaceCapabilities; #ifdef _WIN32 if (capability_full_screen_exclusive.fullScreenExclusiveSupported) LOGI("Surface could support app-controlled exclusive fullscreen.\n"); use_application_controlled_exclusive_fullscreen = exclusive_info.fullScreenExclusive == VK_FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT && capability_full_screen_exclusive.fullScreenExclusiveSupported == VK_TRUE; if (monitor == nullptr) use_application_controlled_exclusive_fullscreen = false; #endif if (use_application_controlled_exclusive_fullscreen) { LOGI("Using app-controlled exclusive fullscreen.\n"); #ifdef _WIN32 exclusive_info.fullScreenExclusive = VK_FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT; exclusive_info.pNext = &exclusive_info_win32; #endif } else { LOGI("Not using app-controlled exclusive fullscreen.\n"); } } else { if (vkGetPhysicalDeviceSurfaceCapabilitiesKHR(gpu, surface, &surface_properties) != VK_SUCCESS) return SwapchainError::Error; } // Happens on Windows when you minimize a window. if (surface_properties.maxImageExtent.width == 0 && surface_properties.maxImageExtent.height == 0) return SwapchainError::NoSurface; uint32_t format_count; vector formats; if (use_surface_info) { if (vkGetPhysicalDeviceSurfaceFormats2KHR(gpu, &surface_info, &format_count, nullptr) != VK_SUCCESS) return SwapchainError::Error; vector formats2(format_count); for (auto &f : formats2) { f = {}; f.sType = VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR; } if (vkGetPhysicalDeviceSurfaceFormats2KHR(gpu, &surface_info, &format_count, formats2.data()) != VK_SUCCESS) return SwapchainError::Error; formats.reserve(format_count); for (auto &f : formats2) formats.push_back(f.surfaceFormat); } else { if (vkGetPhysicalDeviceSurfaceFormatsKHR(gpu, surface, &format_count, nullptr) != VK_SUCCESS) return SwapchainError::Error; formats.resize(format_count); if (vkGetPhysicalDeviceSurfaceFormatsKHR(gpu, surface, &format_count, formats.data()) != VK_SUCCESS) return SwapchainError::Error; } VkSurfaceFormatKHR format; if (format_count == 1 && formats[0].format == VK_FORMAT_UNDEFINED) { format = formats[0]; format.format = VK_FORMAT_B8G8R8A8_UNORM; } else { if (format_count == 0) { LOGE("Surface has no formats.\n"); return SwapchainError::Error; } bool found = false; for (unsigned i = 0; i < format_count; i++) { if (current_srgb_backbuffer_enable) { if (formats[i].format == VK_FORMAT_R8G8B8A8_SRGB || formats[i].format == VK_FORMAT_B8G8R8A8_SRGB || formats[i].format == VK_FORMAT_A8B8G8R8_SRGB_PACK32) { format = formats[i]; found = true; } } else { if (formats[i].format == VK_FORMAT_R8G8B8A8_UNORM || formats[i].format == VK_FORMAT_B8G8R8A8_UNORM || formats[i].format == VK_FORMAT_A8B8G8R8_UNORM_PACK32) { format = formats[i]; found = true; } } } if (!found) format = formats[0]; } static const char *transform_names[] = { "IDENTITY_BIT_KHR", "ROTATE_90_BIT_KHR", "ROTATE_180_BIT_KHR", "ROTATE_270_BIT_KHR", "HORIZONTAL_MIRROR_BIT_KHR", "HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR", "HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR", "HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR", "INHERIT_BIT_KHR", }; LOGI("Current transform is enum 0x%x.\n", unsigned(surface_properties.currentTransform)); for (unsigned i = 0; i <= 8; i++) { if (surface_properties.supportedTransforms & (1u << i)) LOGI("Supported transform 0x%x: %s.\n", 1u << i, transform_names[i]); } VkSurfaceTransformFlagBitsKHR pre_transform; if (!support_prerotate && (surface_properties.supportedTransforms & VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR) != 0) pre_transform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR; else { // Only attempt to use prerotate if we can deal with it purely using a XY clip fixup. // For horizontal flip we need to start flipping front-face as well ... if ((surface_properties.currentTransform & ( VK_SURFACE_TRANSFORM_ROTATE_90_BIT_KHR | VK_SURFACE_TRANSFORM_ROTATE_180_BIT_KHR | VK_SURFACE_TRANSFORM_ROTATE_270_BIT_KHR)) != 0) pre_transform = surface_properties.currentTransform; else pre_transform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR; } if (pre_transform != surface_properties.currentTransform) { LOGW("surfaceTransform (0x%x) != currentTransform (0x%u). Might get performance penalty.\n", unsigned(pre_transform), unsigned(surface_properties.currentTransform)); } swapchain_current_prerotate = pre_transform; VkExtent2D swapchain_size; LOGI("Swapchain current extent: %d x %d\n", int(surface_properties.currentExtent.width), int(surface_properties.currentExtent.height)); if (width == 0) { if (surface_properties.currentExtent.width != ~0u) width = surface_properties.currentExtent.width; else width = 1280; LOGI("Auto selected width = %u.\n", width); } if (height == 0) { if (surface_properties.currentExtent.height != ~0u) height = surface_properties.currentExtent.height; else height = 720; LOGI("Auto selected height = %u.\n", height); } // Try to match the swapchain size up with what we expect w.r.t. aspect ratio. float target_aspect_ratio = float(width) / float(height); if ((swapchain_aspect_ratio > 1.0f && target_aspect_ratio < 1.0f) || (swapchain_aspect_ratio < 1.0f && target_aspect_ratio > 1.0f)) { swap(width, height); } // If we are using pre-rotate of 90 or 270 degrees, we need to flip width and height again. if (swapchain_current_prerotate & (VK_SURFACE_TRANSFORM_ROTATE_90_BIT_KHR | VK_SURFACE_TRANSFORM_ROTATE_270_BIT_KHR | VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR | VK_SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR)) { swap(width, height); } // Clamp the target width, height to boundaries. swapchain_size.width = max(min(width, surface_properties.maxImageExtent.width), surface_properties.minImageExtent.width); swapchain_size.height = max(min(height, surface_properties.maxImageExtent.height), surface_properties.minImageExtent.height); uint32_t num_present_modes; vector present_modes; #ifdef _WIN32 if (use_surface_info && device->get_device_features().supports_full_screen_exclusive) { if (vkGetPhysicalDeviceSurfacePresentModes2EXT(gpu, &surface_info, &num_present_modes, nullptr) != VK_SUCCESS) return SwapchainError::Error; present_modes.resize(num_present_modes); if (vkGetPhysicalDeviceSurfacePresentModes2EXT(gpu, &surface_info, &num_present_modes, present_modes.data()) != VK_SUCCESS) return SwapchainError::Error; } else #endif { if (vkGetPhysicalDeviceSurfacePresentModesKHR(gpu, surface, &num_present_modes, nullptr) != VK_SUCCESS) return SwapchainError::Error; present_modes.resize(num_present_modes); if (vkGetPhysicalDeviceSurfacePresentModesKHR(gpu, surface, &num_present_modes, present_modes.data()) != VK_SUCCESS) return SwapchainError::Error; } VkPresentModeKHR swapchain_present_mode = VK_PRESENT_MODE_FIFO_KHR; bool use_vsync = current_present_mode == PresentMode::SyncToVBlank; if (!use_vsync) { bool allow_mailbox = current_present_mode != PresentMode::UnlockedForceTearing; bool allow_immediate = current_present_mode != PresentMode::UnlockedNoTearing; #ifdef _WIN32 if (device->get_gpu_properties().vendorID == VENDOR_ID_NVIDIA) { // If we're trying to go exclusive full-screen, // we need to ban certain types of present modes which apparently do not work as we expect. if (use_application_controlled_exclusive_fullscreen) allow_mailbox = false; else allow_immediate = false; } #endif for (uint32_t i = 0; i < num_present_modes; i++) { if ((allow_immediate && present_modes[i] == VK_PRESENT_MODE_IMMEDIATE_KHR) || (allow_mailbox && present_modes[i] == VK_PRESENT_MODE_MAILBOX_KHR)) { swapchain_present_mode = present_modes[i]; break; } } } uint32_t desired_swapchain_images = 3; { const char *num_images = getenv("GRANITE_VULKAN_SWAPCHAIN_IMAGES"); if (num_images) desired_swapchain_images = uint32_t(strtoul(num_images, nullptr, 0)); } LOGI("Targeting %u swapchain images.\n", desired_swapchain_images); if (desired_swapchain_images < surface_properties.minImageCount) desired_swapchain_images = surface_properties.minImageCount; if ((surface_properties.maxImageCount > 0) && (desired_swapchain_images > surface_properties.maxImageCount)) desired_swapchain_images = surface_properties.maxImageCount; VkCompositeAlphaFlagBitsKHR composite_mode = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR; if (surface_properties.supportedCompositeAlpha & VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR) composite_mode = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR; if (surface_properties.supportedCompositeAlpha & VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR) composite_mode = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR; if (surface_properties.supportedCompositeAlpha & VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR) composite_mode = VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR; if (surface_properties.supportedCompositeAlpha & VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR) composite_mode = VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR; VkSwapchainKHR old_swapchain = swapchain; VkSwapchainCreateInfoKHR info = { VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR }; info.surface = surface; info.minImageCount = desired_swapchain_images; info.imageFormat = format.format; info.imageColorSpace = format.colorSpace; info.imageExtent.width = swapchain_size.width; info.imageExtent.height = swapchain_size.height; info.imageArrayLayers = 1; info.imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT; info.imageSharingMode = VK_SHARING_MODE_EXCLUSIVE; info.preTransform = pre_transform; info.compositeAlpha = composite_mode; info.presentMode = swapchain_present_mode; info.clipped = VK_TRUE; info.oldSwapchain = old_swapchain; #ifdef _WIN32 if (device->get_device_features().supports_full_screen_exclusive) info.pNext = &exclusive_info; #endif auto res = table->vkCreateSwapchainKHR(context->get_device(), &info, nullptr, &swapchain); if (old_swapchain != VK_NULL_HANDLE) table->vkDestroySwapchainKHR(context->get_device(), old_swapchain, nullptr); has_acquired_swapchain_index = false; #ifdef _WIN32 if (use_application_controlled_exclusive_fullscreen) { bool success = vkAcquireFullScreenExclusiveModeEXT(context->get_device(), swapchain) == VK_SUCCESS; if (success) LOGI("Successfully acquired exclusive full-screen.\n"); else LOGI("Failed to acquire exclusive full-screen. Using borderless windowed.\n"); } #endif #if 0 if (use_vsync && context->get_enabled_device_features().supports_google_display_timing) { WSITimingOptions timing_options; timing_options.swap_interval = 1; //timing_options.adaptive_swap_interval = true; //timing_options.latency_limiter = LatencyLimiter::IdealPipeline; timing.init(platform, device.get(), swapchain, timing_options); using_display_timing = true; } else #endif using_display_timing = false; if (res != VK_SUCCESS) { LOGE("Failed to create swapchain (code: %d)\n", int(res)); swapchain = VK_NULL_HANDLE; return SwapchainError::Error; } swapchain_width = swapchain_size.width; swapchain_height = swapchain_size.height; swapchain_format = format.format; LOGI("Created swapchain %u x %u (fmt: %u, transform: %u).\n", swapchain_width, swapchain_height, unsigned(swapchain_format), unsigned(swapchain_current_prerotate)); uint32_t image_count; if (table->vkGetSwapchainImagesKHR(context->get_device(), swapchain, &image_count, nullptr) != VK_SUCCESS) return SwapchainError::Error; swapchain_images.resize(image_count); release_semaphores.resize(image_count); if (table->vkGetSwapchainImagesKHR(context->get_device(), swapchain, &image_count, swapchain_images.data()) != VK_SUCCESS) return SwapchainError::Error; LOGI("Got %u swapchain images.\n", image_count); platform->event_swapchain_destroyed(); platform->event_swapchain_created(device.get(), swapchain_width, swapchain_height, swapchain_aspect_ratio, image_count, info.imageFormat, swapchain_current_prerotate); return SwapchainError::None; } double WSI::get_estimated_refresh_interval() const { uint64_t interval = timing.get_refresh_interval(); if (interval) return interval * 1e-9; else if (platform) return platform->get_estimated_frame_presentation_duration(); else return 0.0; } void WSI::set_support_prerotate(bool enable) { support_prerotate = enable; } VkSurfaceTransformFlagBitsKHR WSI::get_current_prerotate() const { return swapchain_current_prerotate; } WSI::~WSI() { deinit_external(); } void WSIPlatform::event_device_created(Device *) {} void WSIPlatform::event_device_destroyed() {} void WSIPlatform::event_swapchain_created(Device *, unsigned, unsigned, float, size_t, VkFormat, VkSurfaceTransformFlagBitsKHR) {} void WSIPlatform::event_swapchain_destroyed() {} void WSIPlatform::event_frame_tick(double, double) {} void WSIPlatform::event_swapchain_index(Device *, unsigned) {} void WSIPlatform::event_display_timing_stutter(uint32_t, uint32_t, uint32_t) {} }