HoviTron Video Pipeline: VulkanContext Class Reference

class that manages tasks related to Vulkan context (Vulkan Instance, Vulkan Physical device, Vulkan Logical device) More...

#include <VulkanContext.h>

Public Member Functions
	VulkanContext (WindowAbstract *window)

void	initVulkan ()

void	cleanUp ()

bool	isInitialized ()

QueueFamilyIndices	findQueueFamilies (vk::PhysicalDevice device)

vk::Format	findSupportedFormat (const std::vector< vk::Format > &candidates, vk::ImageTiling tiling, vk::FormatFeatureFlags features)

vk::Format	findDepthFormat ()

bool	hasStencilComponent (vk::Format format)

bool	isIndepFromWindowDimension ()

WindowAbstract *	get_window ()

Data Fields
vk::Instance	instance

vk::PhysicalDevice	physicalDevice

vk::Device	device

vk::Queue	graphicsQueue

vk::Queue	presentQueue

vk::Queue	transferQueue

uint32_t	queueFamilyIndex =0

uint32_t	transferQueueFamilyIndex = 0

Detailed Description

class that manages tasks related to Vulkan context (Vulkan Instance, Vulkan Physical device, Vulkan Logical device)

Manage Vulkan Instance, Vulkan Physical device, Vulkan Logical device, queues families This class also has the task to pick the correct gpu exept if openxr already chose it.

Definition at line 59 of file VulkanContext.h.

Constructor & Destructor Documentation

◆ VulkanContext()

VulkanContext::VulkanContext ( WindowAbstract * window )

Constructor

Definition at line 615 of file VulkanContext.cpp.

{
    this->window = window;
}

Member Function Documentation

◆ cleanUp()

void VulkanContext::cleanUp ( )

Clean up Vulkan objects

Definition at line 622 of file VulkanContext.cpp.

{
    // destroy
 
    window->cleanUpSurface();
    device.destroy();
#ifdef __ANDROID__
    if (window->isValidationLayersEnabled()) {
        VkInstance vkInstance = static_cast<VkInstance>(instance);
        auto messenger = static_cast<VkDebugUtilsMessengerEXT>(debugMessenger);
        pfnDestroyDebugUtilsMessengerEXT(vkInstance,messenger,nullptr);
    }
#else
    if (window->isValidationLayersEnabled()) {
        instance.destroyDebugUtilsMessengerEXT(debugMessenger);
    }
#endif
    instance.destroy();
}

◆ findDepthFormat()

vk::Format VulkanContext::findDepthFormat ( )

find the depth format

Definition at line 541 of file VulkanContext.cpp.

{
    return findSupportedFormat(
        { vk::Format::eD32Sfloat, vk::Format::eD32SfloatS8Uint, vk::Format::eD24UnormS8Uint },
        vk::ImageTiling::eOptimal,
        vk::FormatFeatureFlagBits::eDepthStencilAttachment
    );
}

◆ findQueueFamilies()

QueueFamilyIndices VulkanContext::findQueueFamilies ( vk::PhysicalDevice device )

return the queue family for presentation and graphics

Definition at line 493 of file VulkanContext.cpp.

{
    QueueFamilyIndices indices;
    auto queueFamilies = device.getQueueFamilyProperties();
 
    int i = 0;
    for (const auto& queueFamily : queueFamilies) {
        if (queueFamily.queueFlags & vk::QueueFlagBits::eGraphics) {
            indices.graphicsFamily = i;
        } else if(queueFamily.queueFlags & vk::QueueFlagBits::eCompute) {
          //Compute only
        } else if(queueFamily.queueFlags & vk::QueueFlagBits::eTransfer) {
          // Transfer only queue
          indices.transferFamily = i;
        }
        if (window->isDeviceSupportingSufaceKHR(static_cast<VkPhysicalDevice>(device),i)) {
            indices.presentFamily = i;
        }
        if (indices.isComplete()) {
            break;
        }
 
        i++;
    }
 
    if (!indices.presentFamily.has_value() && window->useOpenXR() ) {
        //In some case there is no surface to test for present support for the queue
        //In this corner case --> default to graphism queue for present queue
        indices.presentFamily = indices.graphicsFamily.value();
    }
 
    return indices;
}

◆ findSupportedFormat()

vk::Format VulkanContext::findSupportedFormat	(	const std::vector< vk::Format > &	candidates,
		vk::ImageTiling	tiling,
		vk::FormatFeatureFlags	features
	)

find the supported depth format

Definition at line 527 of file VulkanContext.cpp.

{
    for (vk::Format format : candidates) {
        vk::FormatProperties props = physicalDevice.getFormatProperties(format);
        if (tiling == vk::ImageTiling::eLinear && (props.linearTilingFeatures & features) == features) {
            return format;
        }
        else if (tiling == vk::ImageTiling::eOptimal && (props.optimalTilingFeatures & features) == features) {
            return format;
        }
    }
    throw std::runtime_error("failed to find supported format!");
}

◆ get_window()

WindowAbstract * VulkanContext::get_window ( )

inline

Return a pointer to WindowAbstract class

Definition at line 108 of file VulkanContext.h.

108{return window;};

◆ hasStencilComponent()

bool VulkanContext::hasStencilComponent ( vk::Format format )

return true if the format have a stencil component

Definition at line 284 of file VulkanContext.cpp.

{
    return format == vk::Format::eD32SfloatS8Uint || format == vk::Format::eD24UnormS8Uint;
}

◆ initVulkan()

void VulkanContext::initVulkan ( )

Initialize the Vulkan instance, pick the physical device, logical device

Definition at line 152 of file VulkanContext.cpp.

{
    try
    {
 
PRINT("Before instance creation;");
 
        createInstance();
 
        PRINT("setupDebug");
 
 
        //LOGI("I'm a test c");
        setupDebugMessenger();
 
 
        window->createSurface();
 
        PRINT("Physical device");
 
#ifdef USE_OPENXR
        if (window->useOpenXR()) {
            static_cast<WindowOpenXR*>(window)->getVulkanPhysicalDevice(reinterpret_cast<VkInstance&>(instance),
                reinterpret_cast<VkPhysicalDevice*>(&physicalDevice));
        }
        else 
#endif
        {
            pickPhysicalDevice();
        }
 
        createLogicalDevice();
        initialized = true;
    }
    catch (vk::SystemError& err)
    {
        std::cout << "vk::SystemError: " << err.what() << std::endl;
        exit(-1);
    }
    catch (std::exception& err)
    {
        std::cout << "std::exception: " << err.what() << std::endl;
        exit(-1);
    }
    catch (std::runtime_error& err)
    {
        std::cout << "std::runtime error: " << err.what() << std::endl;
        exit(-1);
    }
    catch (...)
    {
        std::cout << "unknown error\n";
        exit(-1);
    }
}

◆ isIndepFromWindowDimension()

bool VulkanContext::isIndepFromWindowDimension ( )

return true if rendering must be independent of screen dimension

Definition at line 289 of file VulkanContext.cpp.

{
    return window->isIndepFromWindowDimension();
}

◆ isInitialized()

bool VulkanContext::isInitialized ( )

return true if initialized

Definition at line 642 of file VulkanContext.cpp.

                                  {
    return initialized;
}

Field Documentation

◆ device

vk::Device VulkanContext::device

Vulkan device

Definition at line 87 of file VulkanContext.h.

◆ graphicsQueue

vk::Queue VulkanContext::graphicsQueue

Queue selected for graphics operation

Definition at line 89 of file VulkanContext.h.

◆ instance

vk::Instance VulkanContext::instance

Vulkan Instance

Definition at line 83 of file VulkanContext.h.

◆ physicalDevice

vk::PhysicalDevice VulkanContext::physicalDevice

Vulkan PhysicalDevice (aka the GPU selected)

Definition at line 85 of file VulkanContext.h.

◆ presentQueue

vk::Queue VulkanContext::presentQueue

Queue select�ed for presentation operation, can be the same as graphicsQueue

Definition at line 91 of file VulkanContext.h.

◆ queueFamilyIndex

uint32_t VulkanContext::queueFamilyIndex =0

Queue Family Index

Definition at line 95 of file VulkanContext.h.

◆ transferQueue

vk::Queue VulkanContext::transferQueue

Queue select�ed for transfer operation

Definition at line 93 of file VulkanContext.h.

◆ transferQueueFamilyIndex

uint32_t VulkanContext::transferQueueFamilyIndex = 0

Transfer family index

Definition at line 98 of file VulkanContext.h.

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

Public Member Functions

Data Fields