mirror of
https://gitlab.freedesktop.org/mesa/vulkan-wsi-layer.git
synced 2025-12-20 06:50:08 +01:00
2d4cbd5afa
Decouples the swapchain images and their memory binder/allocator logic into separate classes. This allows us to reduce code duplication across different backends that use the same type of allocation logic and also allows us to make use of RAII to release the resources for swapchain images. The swapchain_base and other swapchain classes have been refactored to handle the new swapchain images. The patch makes the following adjustments: * Introduces a new swapchain_image class that holds all swapchain image resources * Introduces a swapchain image factory class that constructs swapchain images * Introduces a Vulkan image handle class that is responsible for constructing VkImage handles * Introduces a new interface that describes how swapchain backing memory is being allocated * As part of this backing memory interface, introduces device and external (wsialloc) backing memory classes * Introduces a new interface that holds swapchain image data like wl_buffers * Refactors lots of swapchain image parts out of the base swapchain class and moves it into the respective backends to simplify the swapchain classes.
119 lines
3.5 KiB
C++
119 lines
3.5 KiB
C++
/*
|
|
* Copyright (c) 2024-2025 Arm Limited.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* @file present_id.hpp
|
|
*
|
|
* @brief Contains the base class declaration for the VK_KHR_present_id extension.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <atomic>
|
|
#include <condition_variable>
|
|
|
|
#include <util/custom_allocator.hpp>
|
|
#include <util/custom_mutex.hpp>
|
|
#include <util/macros.hpp>
|
|
#include <util/log.hpp>
|
|
#include <util/wsi_extension.hpp>
|
|
|
|
namespace wsi
|
|
{
|
|
|
|
/**
|
|
* @brief Present ID extension class
|
|
*
|
|
* This class defines the present ID extension
|
|
* features.
|
|
*/
|
|
class wsi_ext_present_id : public util::wsi_ext
|
|
{
|
|
public:
|
|
/**
|
|
* @brief The name of the extension.
|
|
*/
|
|
WSI_DEFINE_EXTENSION(VK_KHR_PRESENT_ID_EXTENSION_NAME);
|
|
|
|
/**
|
|
* @brief Marks the given present ID delivered (i.e. its image has been displayed).
|
|
*/
|
|
virtual void mark_delivered(uint64_t present_id);
|
|
|
|
/**
|
|
* @brief Sets the error state for all pending and future image requests.
|
|
* Any error state other than VK_SUCCESS will cause all current and
|
|
* future calls to vkWaitForPresentKHR to fail with @p error_code.
|
|
*
|
|
* @param error_code Vulkan error code
|
|
*/
|
|
void set_error_state(VkResult error_code);
|
|
|
|
/**
|
|
* @brief Get the current error state
|
|
*
|
|
* @return VkResult error state
|
|
*/
|
|
VkResult get_error_state();
|
|
|
|
/**
|
|
* @brief Waits for present ID to be above or equal to the @p value.
|
|
*
|
|
* @param present_id The value to wait for.
|
|
* @param timeout_in_ns Timeout in nanoseconds.
|
|
* @return VK_SUCCESS The present ID value is equal or higher than @p present_id
|
|
* and there were no errors during present.
|
|
* Any other error code to indicate a timeout or error state for the present.
|
|
*/
|
|
VkResult wait_for_present_id(uint64_t present_id, uint64_t timeout_in_ns);
|
|
|
|
/**
|
|
* @brief Get the last delivered present ID value.
|
|
* @return Present ID
|
|
*/
|
|
uint64_t get_last_delivered_present_id() const;
|
|
|
|
private:
|
|
/**
|
|
* @brief Most recently delivered present ID for this swapchain.
|
|
*/
|
|
std::atomic<uint64_t> m_last_delivered_id{ 0 };
|
|
|
|
/**
|
|
* @brief Current error state of the swapchain
|
|
*/
|
|
std::atomic<VkResult> m_error_state{ VK_SUCCESS };
|
|
|
|
/**
|
|
* @brief Conditional variable that notifies whenever present state has changed.
|
|
*/
|
|
std::condition_variable m_present_state_changed;
|
|
|
|
/**
|
|
* @brief Mutex for m_present_state_changed conditional variable.
|
|
*/
|
|
util::mutex m_mutex;
|
|
};
|
|
|
|
} /* namespace wsi */
|