KDGpu::InstanceOptions

Module: Public API

Configuration options for creating a KDGpuInstance. More...

#include <KDGpu/instance.h>

Public Attributes

	Name
std::string	applicationName Application name (used for Vulkan debugging)
uint32_t	applicationVersion Application version.
uint32_t	apiVersion Highest Vulkan API version the app expects to use.
std::vector< std::string >	layers Vulkan validation/debug layers to enable (e.g., "VK_LAYER_KHRONOS_validation")
std::vector< std::string >	extensions Instance extensions to enable (e.g., "VK_KHR_surface")

Detailed Description

struct KDGpu::InstanceOptions;

Configuration options for creating a KDGpuInstance.

See: Instance, Instance::createInstance()

Specifies the application name, version, and required Vulkan layers/extensions. Maps to VkInstanceCreateInfo.

Usage example:

    // Note: Instance creation requires a GraphicsApi (VulkanGraphicsApi)
    std::unique_ptr<KDGpu::GraphicsApi> api = std::make_unique<KDGpu::VulkanGraphicsApi>();

    KDGpu::Instance instance = api->createInstance(KDGpu::InstanceOptions{
            .applicationName = "MyApplication",
            .applicationVersion = KDGPU_MAKE_API_VERSION(0, 1, 0, 0),
    });

Filename: kdgpu_doc_snippets.cpp

Public Attributes Documentation

variable applicationName

std::string applicationName { "KDGpu Application" };

Application name (used for Vulkan debugging)

variable applicationVersion

uint32_t applicationVersion { KDGPU_MAKE_API_VERSION(0, 1, 0, 0) };

Application version.

variable apiVersion

uint32_t apiVersion { KDGPU_MAKE_API_VERSION(0, 1, 2, 0) };

Highest Vulkan API version the app expects to use.

variable layers

std::vector< std::string > layers;

Vulkan validation/debug layers to enable (e.g., "VK_LAYER_KHRONOS_validation")

variable extensions

std::vector< std::string > extensions;

Instance extensions to enable (e.g., "VK_KHR_surface")

---

Updated on 2026-03-31 at 00:02:07 +0000