#include <vulkan_context.hpp>

Collaboration diagram for vulkan_display_detail::VulkanContext:

Public Member Functions
	VulkanContext ()=default

uint32_t	acquire_next_swapchain_image (vk::Semaphore acquire_semaphore) const

void	create_framebuffers (vk::RenderPass render_pass)

void	destroy ()

vk::Device	get_device ()

vk::Framebuffer	get_framebuffer (uint32_t framebuffer_id)

vk::PhysicalDevice	get_gpu ()

vk::Queue	get_queue ()

uint32_t	get_queue_family_index ()

vk::Extent2D	get_render_area_size ()

vk::SwapchainKHR	get_swapchain ()

size_t	get_swapchain_image_count ()

vk::Format	get_swapchain_image_format ()

uint32_t	get_vulkan_version () const

vulkan_display::WindowParameters	get_window_parameters () const

void	init (vulkan_display::VulkanInstance &&instance, vk::SurfaceKHR surface, vulkan_display::WindowParameters window_parameters, uint32_t gpu_index, vk::PresentModeKHR preferred_mode)

bool	is_yCbCr_supported () const

void	recreate_swapchain (vulkan_display::WindowParameters parameters, vk::RenderPass render_pass)

Private Member Functions
void	create_logical_device ()

void	create_swap_chain (vk::SwapchainKHR &&old_swap_chain=vk::SwapchainKHR{})

void	destroy_framebuffers ()

void	destroy_swapchain_views ()

Private Attributes
vk::Device	device

std::unique_ptr< vk::DispatchLoaderDynamic >	dynamic_dispatcher {}

vk::PhysicalDevice	gpu

vk::Instance	instance

vk::DebugUtilsMessengerEXT	messenger

vk::PresentModeKHR	preferred_present_mode {}

vk::Queue	queue

uint32_t	queue_family_index = no_queue_index_found

vk::SurfaceKHR	surface

vk::SwapchainKHR	swapchain

struct {

vk::SurfaceCapabilitiesKHR capabilities

vk::SurfaceFormatKHR format

vk::Extent2D image_size

vk::PresentModeKHR mode = vk::PresentModeKHR::eFifo

}	swapchain_atributes

std::vector< SwapchainImage >	swapchain_images {}

uint32_t	vulkan_version {}

vulkan_display::WindowParameters	window_parameters

bool	yCbCr_supported = false

Detailed Description

Definition at line 131 of file vulkan_context.hpp.

Constructor & Destructor Documentation

◆ VulkanContext()

vulkan_display_detail::VulkanContext::VulkanContext ( )

default

Member Function Documentation

◆ acquire_next_swapchain_image()

uint32_t vulkan_display_detail::VulkanContext::acquire_next_swapchain_image ( vk::Semaphore acquire_semaphore ) const

Definition at line 545 of file vulkan_context.cpp.

                                                                                        {
        constexpr uint64_t timeout = 1'000'000'000; // 1s = 1 000 000 000 nanoseconds
        uint32_t image_index;
        auto acquired = device.acquireNextImageKHR(swapchain, timeout, acquire_semaphore, nullptr, &image_index);
        switch (acquired) {
                case vk::Result::eSuccess:
                        break;
                case vk::Result::eSuboptimalKHR: [[fallthrough]];
                case vk::Result::eErrorOutOfDateKHR:
                        image_index = swapchain_image_out_of_date;
                        break;
                case vk::Result::eTimeout:
                        image_index = swapchain_image_timeout;
                        break;
                default:
                        throw VulkanError{"Next swapchain image cannot be acquired."s + vk::to_string(acquired)};
        }
        return image_index;
}

References device, swapchain, vulkan_display_detail::swapchain_image_out_of_date, and vulkan_display_detail::swapchain_image_timeout.

Referenced by vulkan_display::VulkanDisplay::display_queued_image().

◆ create_framebuffers()

void vulkan_display_detail::VulkanContext::create_framebuffers ( vk::RenderPass render_pass )

Definition at line 516 of file vulkan_context.cpp.

                                                                {
        vk::FramebufferCreateInfo framebuffer_info;
        framebuffer_info
                .setRenderPass(render_pass)
                .setWidth(swapchain_atributes.image_size.width)
                .setHeight(swapchain_atributes.image_size.height)
                .setLayers(1);
 
        for(auto& swapchain_image : swapchain_images){
                framebuffer_info
                        .setAttachmentCount(1)
                        .setPAttachments(&swapchain_image.view);
                swapchain_image.framebuffer = device.createFramebuffer(framebuffer_info);
        }
}

References device, swapchain_atributes, and swapchain_images.

Referenced by vulkan_display::VulkanDisplay::init(), and recreate_swapchain().

◆ create_logical_device()

void vulkan_display_detail::VulkanContext::create_logical_device ( )

private

Definition at line 378 of file vulkan_context.cpp.

                                          {
        assert(gpu);
        assert(queue_family_index != no_queue_index_found);
 
        constexpr std::array priorities = { 1.0f };
        vk::DeviceQueueCreateInfo queue_info{};
        queue_info
                .setQueueFamilyIndex(queue_family_index)
                .setPQueuePriorities(priorities.data())
                .setQueueCount(1);
 
        vk::DeviceCreateInfo device_info{};
        device_info
                .setPNext(nullptr)
                .setQueueCreateInfoCount(1)
                .setPQueueCreateInfos(&queue_info)
                .setEnabledExtensionCount(static_cast<uint32_t>(required_gpu_extensions.size()))
                .setPpEnabledExtensionNames(required_gpu_extensions.data());
 
        vk::PhysicalDeviceFeatures2 features2{};
        vk::PhysicalDeviceSamplerYcbcrConversionFeatures yCbCr_feature{};
        if (vulkan_version == VK_API_VERSION_1_1) {
                features2.setPNext(&yCbCr_feature);
                gpu.getFeatures2(&features2);
                if (yCbCr_feature.samplerYcbcrConversion) {
                        yCbCr_supported = true;
                        device_info.setPNext(&features2);
                        vulkan_log_msg(LogLevel::info, "yCbCr feature supported.");
                }
        }
 
        //reset features
        features2 = vk::PhysicalDeviceFeatures2{};
        features2.setPNext(&yCbCr_feature);
 
        device = gpu.createDevice(device_info);
}

References device, gpu, vulkan_display_detail::no_queue_index_found, queue_family_index, vulkan_display_detail::vulkan_log_msg, vulkan_version, and yCbCr_supported.

Referenced by init().

◆ create_swap_chain()

void vulkan_display_detail::VulkanContext::create_swap_chain ( vk::SwapchainKHR && old_swap_chain = vk::SwapchainKHR{} )

private

Definition at line 416 of file vulkan_context.cpp.

                                                                    {
        constexpr int initialization_attempts = 3;
        for (int attempt = 0; attempt < initialization_attempts; attempt++) {
                auto& capabilities = swapchain_atributes.capabilities;
                capabilities = gpu.getSurfaceCapabilitiesKHR(surface);
 
                swapchain_atributes.format = get_surface_format(gpu, surface);
                swapchain_atributes.mode = get_present_mode(gpu, surface, preferred_present_mode);
 
                vk::Extent2D swapchain_image_size;
                swapchain_image_size.width = std::clamp(window_parameters.width,
                        capabilities.minImageExtent.width,
                        capabilities.maxImageExtent.width);
                swapchain_image_size.height = std::clamp(window_parameters.height,
                        capabilities.minImageExtent.height,
                        capabilities.maxImageExtent.height);
                swapchain_atributes.image_size = swapchain_image_size;
 
                uint32_t image_count = std::max(uint32_t{2}, capabilities.minImageCount);
                if (capabilities.maxImageCount != 0) {
                        image_count = std::min(image_count, capabilities.maxImageCount);
                }
 
                auto msg = concat(64, std::array{
                        "Recreating swapchain, size: "s,
                        std::to_string(swapchain_image_size.width),
                        "x"s,
                        std::to_string(swapchain_image_size.height),
                        ", format: "s,
                        vk::to_string(swapchain_atributes.format.format)
                });
                vulkan_log_msg(LogLevel::info, msg);
 
                //assert(capabilities.supportedUsageFlags & vk::ImageUsageFlagBits::eTransferDst);
                vk::SwapchainCreateInfoKHR swapchain_info{};
                swapchain_info
                        .setSurface(surface)
                        .setImageFormat(swapchain_atributes.format.format)
                        .setImageColorSpace(swapchain_atributes.format.colorSpace)
                        .setPresentMode(swapchain_atributes.mode)
                        .setMinImageCount(image_count)
                        .setImageExtent(swapchain_image_size)
                        .setImageArrayLayers(1)
                        .setImageUsage(vk::ImageUsageFlagBits::eColorAttachment)
                        .setImageSharingMode(vk::SharingMode::eExclusive)
                        .setPreTransform(swapchain_atributes.capabilities.currentTransform)
                        .setCompositeAlpha(get_composite_alpha(swapchain_atributes.capabilities.supportedCompositeAlpha))
                        .setClipped(true)
                        .setOldSwapchain(old_swapchain);
                try{
                        swapchain = device.createSwapchainKHR(swapchain_info);
                        device.destroy(old_swapchain);
                        old_swapchain = nullptr;
                        return;
                }
                catch(std::exception& err){
                        vulkan_log_msg(LogLevel::info, "Recreation unsuccesful: "s + err.what());
                        device.destroy(old_swapchain);
                        old_swapchain = nullptr;
                        if(attempt + 1 == initialization_attempts){
                            throw err;
                        }
                }
        }
        assert(false);
}

References capabilities, vulkan_display_detail::concat(), device, gpu, vulkan_display::WindowParameters::height, preferred_present_mode, surface, swapchain, swapchain_atributes, vulkan_display_detail::vulkan_log_msg, vulkan_display::WindowParameters::width, and window_parameters.

Referenced by init(), and recreate_swapchain().

Here is the call graph for this function:

◆ destroy()

void vulkan_display_detail::VulkanContext::destroy ( )

Definition at line 565 of file vulkan_context.cpp.

                            {
        if (device) {
                // static_cast to silence nodiscard warning
                device.waitIdle();
                destroy_framebuffers();
                destroy_swapchain_views();
                device.destroy(swapchain);
                device.destroy();
        }
        if (instance) {
                instance.destroy(surface);
                if (messenger) {
                        instance.destroy(messenger, nullptr, *dynamic_dispatcher);
                }
                instance.destroy();
        }
        dynamic_dispatcher = nullptr;
}

References destroy_framebuffers(), destroy_swapchain_views(), device, dynamic_dispatcher, instance, messenger, surface, and swapchain.

Referenced by vulkan_display::VulkanDisplay::destroy().

Here is the call graph for this function:

◆ destroy_framebuffers()

void vulkan_display_detail::VulkanContext::destroy_framebuffers ( )

inlineprivate

Definition at line 181 of file vulkan_context.hpp.

                                    {
                for (auto& image : swapchain_images) {
                        device.destroy(image.framebuffer);
                        image.framebuffer = nullptr;
                }
        }

References device, and swapchain_images.

Referenced by destroy(), and recreate_swapchain().

◆ destroy_swapchain_views()

void vulkan_display_detail::VulkanContext::destroy_swapchain_views ( )

inlineprivate

Definition at line 174 of file vulkan_context.hpp.

                                       {
                for (auto& image : swapchain_images) {
                        device.destroy(image.view);
                        image.view = nullptr;
                }
        }

References device, and swapchain_images.

Referenced by destroy(), and recreate_swapchain().

◆ get_device()

vk::Device vulkan_display_detail::VulkanContext::get_device ( )

inline

Definition at line 161 of file vulkan_context.hpp.

161{ return device; }

References device.

Referenced by vulkan_display_detail::RenderPipeline::create(), vulkan_display::VulkanDisplay::init(), vulkan_display_detail::Image2D::init(), and vulkan_display_detail::TransferImageImpl::recreate().

◆ get_framebuffer()

vk::Framebuffer vulkan_display_detail::VulkanContext::get_framebuffer ( uint32_t framebuffer_id )

inline

Definition at line 200 of file vulkan_context.hpp.

                                                               {
                return swapchain_images[framebuffer_id].framebuffer;
        }

References swapchain_images.

Referenced by vulkan_display::VulkanDisplay::record_graphics_commands().

◆ get_gpu()

vk::PhysicalDevice vulkan_display_detail::VulkanContext::get_gpu ( )

inline

Definition at line 160 of file vulkan_context.hpp.

160{ return gpu; }

References gpu.

Referenced by vulkan_display_detail::Image2D::init(), and vulkan_display::VulkanDisplay::is_image_description_supported().

◆ get_queue()

vk::Queue vulkan_display_detail::VulkanContext::get_queue ( )

inline

Definition at line 164 of file vulkan_context.hpp.

164{ return queue; }

vulkan_display_detail::VulkanContext::queue

vk::Queue queue

Definition vulkan_context.hpp:142

References queue.

Referenced by vulkan_display::VulkanDisplay::display_queued_image(), and vulkan_display::VulkanDisplay::reconfigure().

◆ get_queue_family_index()

uint32_t vulkan_display_detail::VulkanContext::get_queue_family_index ( )

inline

Definition at line 163 of file vulkan_context.hpp.

163{ return queue_family_index; }

References queue_family_index.

Referenced by vulkan_display::VulkanDisplay::init().

◆ get_render_area_size()

vk::Extent2D vulkan_display_detail::VulkanContext::get_render_area_size ( )

inline

Definition at line 168 of file vulkan_context.hpp.

168{ return swapchain_atributes.image_size; }

References swapchain_atributes.

Referenced by vulkan_display::VulkanDisplay::display_queued_image(), vulkan_display::VulkanDisplay::reconfigure(), and vulkan_display::VulkanDisplay::window_parameters_changed().

◆ get_swapchain()

vk::SwapchainKHR vulkan_display_detail::VulkanContext::get_swapchain ( )

inline

Definition at line 165 of file vulkan_context.hpp.

165{ return swapchain; }

References swapchain.

Referenced by vulkan_display::VulkanDisplay::display_queued_image().

◆ get_swapchain_image_count()

size_t vulkan_display_detail::VulkanContext::get_swapchain_image_count ( )

inline

Definition at line 167 of file vulkan_context.hpp.

167{ return swapchain_images.size(); }

References swapchain_images.

◆ get_swapchain_image_format()

vk::Format vulkan_display_detail::VulkanContext::get_swapchain_image_format ( )

inline

Definition at line 166 of file vulkan_context.hpp.

166{ return swapchain_atributes.format.format; };

References swapchain_atributes.

Referenced by vulkan_display_detail::RenderPipeline::create().

◆ get_vulkan_version()

uint32_t vulkan_display_detail::VulkanContext::get_vulkan_version ( ) const

inline

Definition at line 159 of file vulkan_context.hpp.

159{ return vulkan_version; }

References vulkan_version.

Referenced by vulkan_display::VulkanDisplay::get_vulkan_version().

◆ get_window_parameters()

vulkan_display::WindowParameters vulkan_display_detail::VulkanContext::get_window_parameters ( ) const

inline

Definition at line 204 of file vulkan_context.hpp.

                                                                     {
                return window_parameters;
        }

References window_parameters.

Referenced by vulkan_display::VulkanDisplay::window_parameters_changed().

◆ init()

void vulkan_display_detail::VulkanContext::init	(	vulkan_display::VulkanInstance &&	instance,
		vk::SurfaceKHR	surface,
		vulkan_display::WindowParameters	window_parameters,
		uint32_t	gpu_index,
		vk::PresentModeKHR	preferred_mode )

Definition at line 483 of file vulkan_context.cpp.

{
        assert(!this->instance);
        this->instance = instance.instance;
        this->dynamic_dispatcher = std::move(instance.dynamic_dispatcher);
        this->messenger = instance.messenger;
        this->vulkan_version = instance.vulkan_version;
        instance.instance = nullptr;
        instance.messenger = nullptr;
 
        this->surface = surface;
        this->preferred_present_mode = preferredMode;
        window_parameters = parameters;
 
        gpu = create_physical_device(this->instance, surface, gpu_index);
 
        queue_family_index = choose_queue_family_index(gpu, surface);
        assert(queue_family_index != no_queue_index_found);
 
        create_logical_device();
        auto properties = gpu.getProperties();
        if (properties.apiVersion < VK_API_VERSION_1_1) {
                vulkan_version = VK_API_VERSION_1_0;
        }
 
        log_gpu_info(properties, vulkan_version);
        
        queue = device.getQueue(queue_family_index, 0);
        create_swap_chain();
        create_swapchain_views(device, swapchain, swapchain_atributes.format.format, swapchain_images);
}

References create_logical_device(), create_swap_chain(), device, dynamic_dispatcher, gpu, instance, messenger, vulkan_display_detail::no_queue_index_found, queue_family_index, surface, swapchain, swapchain_atributes, swapchain_images, vulkan_version, and window_parameters.

Referenced by vulkan_display::VulkanDisplay::init().

Here is the call graph for this function:

◆ is_yCbCr_supported()

bool vulkan_display_detail::VulkanContext::is_yCbCr_supported ( ) const

inline

Definition at line 162 of file vulkan_context.hpp.

162{ return yCbCr_supported; }

References yCbCr_supported.

Referenced by vulkan_display::VulkanDisplay::is_image_description_supported(), and vulkan_display::VulkanDisplay::is_yCbCr_supported().

◆ recreate_swapchain()

void vulkan_display_detail::VulkanContext::recreate_swapchain	(	vulkan_display::WindowParameters	parameters,
		vk::RenderPass	render_pass )

Definition at line 532 of file vulkan_context.cpp.

                                                                                            {
        window_parameters = parameters;
 
        device.waitIdle();
 
        destroy_framebuffers();
        destroy_swapchain_views();
        vk::SwapchainKHR old_swap_chain = swapchain;
        create_swap_chain(std::move(old_swap_chain));
        create_swapchain_views(device, swapchain, swapchain_atributes.format.format, swapchain_images);
        create_framebuffers(render_pass);
}

References create_framebuffers(), create_swap_chain(), destroy_framebuffers(), destroy_swapchain_views(), device, swapchain, swapchain_atributes, swapchain_images, and window_parameters.

Referenced by vulkan_display::VulkanDisplay::display_queued_image(), and vulkan_display::VulkanDisplay::window_parameters_changed().

Here is the call graph for this function:

Member Data Documentation

◆ capabilities

vk::SurfaceCapabilitiesKHR vulkan_display_detail::VulkanContext::capabilities

Definition at line 147 of file vulkan_context.hpp.

Referenced by create_swap_chain().

◆ device

vk::Device vulkan_display_detail::VulkanContext::device

private

Definition at line 138 of file vulkan_context.hpp.

Referenced by acquire_next_swapchain_image(), create_framebuffers(), create_logical_device(), create_swap_chain(), destroy(), destroy_framebuffers(), destroy_swapchain_views(), get_device(), init(), and recreate_swapchain().

◆ dynamic_dispatcher

std::unique_ptr<vk::DispatchLoaderDynamic> vulkan_display_detail::VulkanContext::dynamic_dispatcher {}

private

Definition at line 133 of file vulkan_context.hpp.

133{};

Referenced by destroy(), and init().

◆ format

vk::SurfaceFormatKHR vulkan_display_detail::VulkanContext::format

Definition at line 148 of file vulkan_context.hpp.

◆ gpu

vk::PhysicalDevice vulkan_display_detail::VulkanContext::gpu

private

Definition at line 137 of file vulkan_context.hpp.

Referenced by create_logical_device(), create_swap_chain(), get_gpu(), and init().

◆ image_size

vk::Extent2D vulkan_display_detail::VulkanContext::image_size

Definition at line 150 of file vulkan_context.hpp.

◆ instance

vk::Instance vulkan_display_detail::VulkanContext::instance

private

Definition at line 132 of file vulkan_context.hpp.

Referenced by destroy(), and init().

◆ messenger

vk::DebugUtilsMessengerEXT vulkan_display_detail::VulkanContext::messenger

private

Definition at line 134 of file vulkan_context.hpp.

Referenced by destroy(), and init().

◆ mode

vk::PresentModeKHR vulkan_display_detail::VulkanContext::mode = vk::PresentModeKHR::eFifo

Definition at line 149 of file vulkan_context.hpp.

◆ preferred_present_mode

vk::PresentModeKHR vulkan_display_detail::VulkanContext::preferred_present_mode {}

private

Definition at line 154 of file vulkan_context.hpp.

154{};

Referenced by create_swap_chain().

◆ queue

vk::Queue vulkan_display_detail::VulkanContext::queue

private

Definition at line 142 of file vulkan_context.hpp.

Referenced by get_queue().

◆ queue_family_index

uint32_t vulkan_display_detail::VulkanContext::queue_family_index = no_queue_index_found

private

Definition at line 141 of file vulkan_context.hpp.

Referenced by create_logical_device(), get_queue_family_index(), and init().

◆ surface

vk::SurfaceKHR vulkan_display_detail::VulkanContext::surface

private

Definition at line 144 of file vulkan_context.hpp.

Referenced by create_swap_chain(), destroy(), and init().

◆ swapchain

vk::SwapchainKHR vulkan_display_detail::VulkanContext::swapchain

private

Definition at line 145 of file vulkan_context.hpp.

Referenced by acquire_next_swapchain_image(), create_swap_chain(), destroy(), get_swapchain(), init(), and recreate_swapchain().

◆ [struct]

struct { ... } vulkan_display_detail::VulkanContext::swapchain_atributes

Referenced by create_framebuffers(), create_swap_chain(), get_render_area_size(), get_swapchain_image_format(), init(), and recreate_swapchain().

◆ swapchain_images

std::vector<SwapchainImage> vulkan_display_detail::VulkanContext::swapchain_images {}

private

Definition at line 153 of file vulkan_context.hpp.

153{};

Referenced by create_framebuffers(), destroy_framebuffers(), destroy_swapchain_views(), get_framebuffer(), get_swapchain_image_count(), init(), and recreate_swapchain().

◆ vulkan_version

uint32_t vulkan_display_detail::VulkanContext::vulkan_version {}

private

Definition at line 135 of file vulkan_context.hpp.

135{};

Referenced by create_logical_device(), get_vulkan_version(), and init().

◆ window_parameters

vulkan_display::WindowParameters vulkan_display_detail::VulkanContext::window_parameters

private

Definition at line 156 of file vulkan_context.hpp.

Referenced by create_swap_chain(), get_window_parameters(), init(), and recreate_swapchain().

◆ yCbCr_supported

bool vulkan_display_detail::VulkanContext::yCbCr_supported = false

private

Definition at line 139 of file vulkan_context.hpp.

Referenced by create_logical_device(), and is_yCbCr_supported().

The documentation for this class was generated from the following files:

src/video_display/vulkan/vulkan_context.hpp
src/video_display/vulkan/vulkan_context.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VulkanContext()

Member Function Documentation

◆ acquire_next_swapchain_image()

◆ create_framebuffers()

◆ create_logical_device()

◆ create_swap_chain()

◆ destroy()

◆ destroy_framebuffers()

◆ destroy_swapchain_views()

◆ get_device()

◆ get_framebuffer()

◆ get_gpu()

◆ get_queue()

◆ get_queue_family_index()

◆ get_render_area_size()

◆ get_swapchain()

◆ get_swapchain_image_count()

◆ get_swapchain_image_format()

◆ get_vulkan_version()

◆ get_window_parameters()

◆ init()

◆ is_yCbCr_supported()

◆ recreate_swapchain()

Member Data Documentation

◆ capabilities

◆ device

◆ dynamic_dispatcher

◆ format

◆ gpu

◆ image_size

◆ instance

◆ messenger

◆ mode

◆ preferred_present_mode

◆ queue

◆ queue_family_index

◆ surface

◆ swapchain

◆ [struct]

◆ swapchain_images

◆ vulkan_version

◆ window_parameters

◆ yCbCr_supported