Kanzi  3.9.4
Kanzi Engine API
kanzi::VulkanGraphicsOutput Class Referenceabstract

VulkanGraphicsOutput class. More...

#include <kanzi/core.ui/platform/graphics_backend/vulkan/vulkan_graphics_output.hpp>

Public Types

using VulkanProcPointer = void(*)()
 Pointer to Vulkan function. More...
 

Public Member Functions

virtual KZ_NO_DISCARD optional< VkInstance > getNativeInstanceHandle () const noexcept=0
 Gets associated Vulkan instance handle. More...
 
virtual KZ_NO_DISCARD optional< VkSurfaceKHR > getNativeSurfaceHandle () const noexcept=0
 Gets associated native Vulkan surface handle. More...
 
virtual KZ_NO_DISCARD VulkanProcPointer getProcAddress (string_view functionName) noexcept=0
 Retrieves pointer to Vulkan function. More...
 
virtual ~VulkanGraphicsOutput ()=default
 Destructor. More...
 

Detailed Description

VulkanGraphicsOutput class.

Mixin interface for graphics outputs that implement Vulkan instance and surface.

Member Typedef Documentation

◆ VulkanProcPointer

Pointer to Vulkan function.

Constructor & Destructor Documentation

◆ ~VulkanGraphicsOutput()

virtual kanzi::VulkanGraphicsOutput::~VulkanGraphicsOutput ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getProcAddress()

virtual KZ_NO_DISCARD VulkanProcPointer kanzi::VulkanGraphicsOutput::getProcAddress ( string_view  functionName)
pure virtualnoexcept

Retrieves pointer to Vulkan function.

Parameters
functionNameName of the function.
Returns
Pointer to the function, or null if not found.

◆ getNativeInstanceHandle()

virtual KZ_NO_DISCARD optional<VkInstance> kanzi::VulkanGraphicsOutput::getNativeInstanceHandle ( ) const
pure virtualnoexcept

Gets associated Vulkan instance handle.

Returns
The handle of associated Vulkan instance, or nullopt on error.

◆ getNativeSurfaceHandle()

virtual KZ_NO_DISCARD optional<VkSurfaceKHR> kanzi::VulkanGraphicsOutput::getNativeSurfaceHandle ( ) const
pure virtualnoexcept

Gets associated native Vulkan surface handle.

Returns
The handle of associated surface object, or nullopt on error.

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