Skip to content

KDGpu::VulkanGraphicsApi

Module: Public API

VulkanGraphicsApi.

#include <vulkan_graphics_api.h>

Public Functions

Name
VulkanGraphicsApi()
~VulkanGraphicsApi()
ApiType api()
std::string apiName()
Instance createInstance(const InstanceOptions & options =InstanceOptions())
Create an Instance object given the InstanceOptionsoptions.
VulkanResourceManager * resourceManager()
Returns the ResourceManager instance for the GraphicsApi.
const VulkanResourceManager * resourceManager() const
Instance createInstanceFromExistingVkInstance(VkInstance vkInstance)
Surface createSurfaceFromExistingVkSurface(const Handle< Instance_t > & instanceH, VkSurfaceKHR vkSurface)
Adapter createAdapterFromExistingVkPhysicalDevice(const Handle< Instance_t > & instanceH, VkPhysicalDevice vkPhysicalDevice)
Queue createQueueFromExistingVkQueue(VkQueue vkQueue, const QueueFlags queueFlags)
Device createDeviceFromExistingVkDevice(Adapter * adapter, VkDevice vkDevice, std::vector< Queue > && queues)
VkImage vkImageFromTexture(const Handle< Texture_t > textureH) const
Texture createTextureFromExistingVkImage(const Handle< Device_t > & deviceHandle, const TextureOptions & options, VkImage vkImage)
std::string getMemoryStats(const Handle< Device_t > & device) const
void addValidationMessageToIgnore(const std::string & messageToIgnore)
const std::vector< std::string > & validationMessagesToIgnore()

Public Functions Documentation

function VulkanGraphicsApi

1
VulkanGraphicsApi()

function ~VulkanGraphicsApi

1
~VulkanGraphicsApi()

function api

1
inline ApiType api()

function apiName

1
inline std::string apiName()

function createInstance

1
2
3
Instance createInstance(
    const InstanceOptions & options =InstanceOptions()
)

Create an Instance object given the InstanceOptionsoptions.

function resourceManager

1
inline VulkanResourceManager * resourceManager()

Returns the ResourceManager instance for the GraphicsApi.

function resourceManager

1
inline const VulkanResourceManager * resourceManager() const

function createInstanceFromExistingVkInstance

1
2
3
Instance createInstanceFromExistingVkInstance(
    VkInstance vkInstance
)

function createSurfaceFromExistingVkSurface

1
2
3
4
Surface createSurfaceFromExistingVkSurface(
    const Handle< Instance_t > & instanceH,
    VkSurfaceKHR vkSurface
)

function createAdapterFromExistingVkPhysicalDevice

1
2
3
4
Adapter createAdapterFromExistingVkPhysicalDevice(
    const Handle< Instance_t > & instanceH,
    VkPhysicalDevice vkPhysicalDevice
)

function createQueueFromExistingVkQueue

1
2
3
4
Queue createQueueFromExistingVkQueue(
    VkQueue vkQueue,
    const QueueFlags queueFlags
)

function createDeviceFromExistingVkDevice

1
2
3
4
5
Device createDeviceFromExistingVkDevice(
    Adapter * adapter,
    VkDevice vkDevice,
    std::vector< Queue > && queues
)

function vkImageFromTexture

1
2
3
VkImage vkImageFromTexture(
    const Handle< Texture_t > textureH
) const

function createTextureFromExistingVkImage

1
2
3
4
5
Texture createTextureFromExistingVkImage(
    const Handle< Device_t > & deviceHandle,
    const TextureOptions & options,
    VkImage vkImage
)

function getMemoryStats

1
2
3
std::string getMemoryStats(
    const Handle< Device_t > & device
) const

function addValidationMessageToIgnore

1
2
3
static void addValidationMessageToIgnore(
    const std::string & messageToIgnore
)

function validationMessagesToIgnore

1
static const std::vector< std::string > & validationMessagesToIgnore()

Updated on 2025-11-02 at 00:01:42 +0000