erupted_v2 ~master

ErupteD-V2

Automatically-generated D bindings for the Vulkan API based on D-Vulkan. A Vulkan lib loader is included. Acquiring Vulkan functions is based on Intel API without Secrets. ErupteD-V2 will eventually replace, and later on be renamed to, ErupteD. Reasoning why ErupteD-V2 is required in the first place can be found in the deprecation and upgrade process paragraph.

Usage

The easiest way to start is calling loadGlobalLevelFunctions() from module erupted.vulkan_lib_loader. This function automatically loads the Vulkan dynamic link library Vulkan-1.dll (Windows) or libvulkan.so.1 (Posix), retrieves vkGetInstanceProcAddr from the lib and loads global functions from Vulkan implementation. The vulkan_lib_loader is NOT imported with the erupted package. If loadGlobalLevelFunctions() fails either lib or vkGetInstanceProcAddr loading failed. In that case you need to load vkGetInstanceProcAddr with other (not implemented in vulkanlibloader module) platform specific means or through some mechanism like glfw3 as shown ErupteD-GLFW project. Platform specific Vulkan functionality, like platform surface extensions (see Platform extensions), requires special treatment.

Steps to follow:

1. import vulkan lib loader via import erupted.vulkan_lib_loader;
2. call loadGlobalLevelFunctions() (and check the result!) to load the following functions:
   • vkGetInstanceProcAddr
   • vkCreateInstance
   • vkEnumerateInstanceExtensionProperties
   • vkEnumerateInstanceLayerProperties

   if the call was successful (returns true), skip to 5.

3. on failure, get a pointer to the vkGetInstanceProcAddr through platform-specific means (e.g. loading the Vulkan shared library manually, or glfwGetInstanceProcAddress if using GLFW3 >= v3.2 with DerelictGLFW3 >= v3.1.0)
4. call loadGlobalLevelFunctions(getInstanceProcAddr), where getInstanceProcAddr is the address of the loaded vkGetInstanceProcAddr function. This loads the same functions as described in step 2.
5. create a VkInstance using the above functions
6. call loadInstanceLevelFunctions(VkInstance) to load additional VkInstance related functions. Get information about available physical devices (e.g. GPU(s), APU(s), etc.) and physical device related resources (e.g. Queue Families, Queues per Family, etc.)
7. three options are available to acquire a logical device and device resource related functions:
   • call loadDeviceLevelFunctions(VkInstance), the acquired functions call indirectly through the VkInstance and will be internally dispatched to various devices by the implementation
   • call loadDeviceLevelFunctions(VkDevice), the acquired functions call directly the VkDevice and related resources. This path is faster, skips one indirection, but is useful only in a single physical device environment. Calling the same function with another VkDevice will overwrite all the previously fetched function
   • create a DispatchDevice with Vulkan functions as members kind of namespaced, see DispatchDevice

Examples for checking instnace and device layers as well as device creation can be found in the examples directory, and run with dub run erupted:examplename. Examples found in 'examples/platform' directory are just explenatory and cannot be build or run (see Platform Extensions)

C vs D API

• VK_NULL_HANDLE is defined as 0 and can be used as uint64_t type and pointer type argument in C world. D's null can be used only as a pointer argument. This is an issue when compiling for 32 bit, as dispatchable handles (VkInstance, VkPhysicalDevice, VkDevice, VkQueue) are pointer types while non dispatchable handles (e.g. VkSemaphore) are uint64_t types. Hence ErupteD VK_NULL_HANDLE can only be used as dispatchable null handle (on 32 Bit!). For non dispatchable handles another ErupteD symbol exist VK_NULL_ND_HANDLE. On 64 bit all handles are pointer types and VK_NULL_HANDLE can be used at any place. However VK_NULL_ND_HANDLE is still defined for sake of completeness and ease of use. The issue might be solved when multiple alias this is released, hence I recommend building 64 Bit apps and ignore VK_NULL_ND_HANDLE. Best practice summary:
  • if exclusively building a 32 Bit app or switching forth and back between 32 and 64 Bit use VK_NULL_ND_HANDLE for non dispatchable handles
  • if exclusively building a 64 Bit app VK_NULL_HANDLE can be used as any of the two vk handle types
• named enums in D are not global but they are forwarded into global scope. Hence e.g. VkResult.VK_SUCCESS and VK_SUCCESS can both be used
• all structures have their sType field set to the appropriate value upon initialization; explicit initialization is not needed
• VkPipelineShaderStageCreateInfo.module has been renamed to VkPipelineShaderStageCreateInfo._module, since module is a D keyword

DispatchDevice

The DispatchDevice holds a VkDevice, a pointer to const VkAllocationCallbacks and the Vulkan functions loaded from that device, collision protected. The allocator is optional for Vulkan as well as for the DispatchDevice. If it not specified the default allocator will be used. An allocator is locked to the device throughout its lifetime. Before usage the DispatchDevice must be initialize, either immediately:

    auto dd = DispatchDevice( device, allocator );

or delayed:

    DispatchDevice dd;
    dd.loadDeviceLevelFunctions( device, allocator );

VkDevice and VkAllocationCallbacks are private and must not change as the member vkFunctions can only be used with this device and, when required, this allocator. It can be accessed with the properties vkDevice and pAllocator:

    auto dd = DispatchDevice( device );
    dd.vkDestroyDevice( dd.vkDevice, dd.pAllocator );

The DispatchDevice has also convenience functions. With these the device and allocator arguments can be omitted. They forward to the corresponding Vulkan function, the device and allocator argument are supplied by the private VkDevice and VkAllocationCallbacks members. The crux is that function pointers can't be overloaded with regular functions hence the vk prefix is ditched for the convenience variants:

    auto dd = DispatchDevice( device );
    dd.DestroyDevice:       // instead of: dd.vkDestroyDevice( dd.vkDevice, dd.pAllocator );

Same mechanism works with functions which require a VkCommandBuffer as first arg, but before using them the public member 'commandBuffer' must be set with the target VkCommandBuffer:

    dd.commandBuffer = some_command_buffer;
    dd.BeginCommandBuffer( &beginInfo );
    dd.CmdBindPipeline( VK_PIPELINE_BIND_POINT_GRAPHICS, some_pipeline );

Needless to say that some_command_buffer must have been acquired from the private device member, or some other handle to that device. The Mechanism does NOT work with queues, there are about four queue related functions which most probably won't be used in bulk.

Platform Extensions

Platform extensions, found in module erupted.platform.mixin_extensions, exist in form of the configurable mixin template Platform_Extensions( extensions... ). With this template you can mixin extension related code into your project, but you need to take care of the dependencies yourself:

// platform extension example with xlib-d
// xlib-d must be speciefied as dependency in your projects dub file
module spocks_logic;
public import X11.Xlib;                                 // publicly import required API
import erupted.platform.mixin_extensions;               // import the template mixin
mixin Platform_Extensions!VK_USE_PLATFORM_XLIB_KHR;     // mixin all xlib related extensions

The template publicly imports erupted.types and erupted.functions. This is necessary as some functions from the latter module are overwritten/extended to also load related Vulkan extension functions. DispatchDevice from module erupted.dispatch_device is also extended/overwritten with the corresponding extension functions. If you would include both, your module and erupted.functions in another module, loadInstanceLevelFunctions, loadDeviceLevelFunctions and DispatchDevice would collide.

Module erupted.platform_extensions defines enums corresponding to extension names, and alias sequences corresponding to C Vulkan platform protection #define definitions. Platform_Extensions template accepts each and in combinations in any order.

You'll find example modules in examples/platform for wayland, xcb and xlib. Copy the whole module or its content into your project and possibly edit its name and imported platform module. On windows core.sys.windows.windows from druntime is publicly imported, no need for any other dependency. As of writing windows is also the only platform with multiple extensions in place of VK_USE_PLATFORM_WIN32_KHR alias sequence/macro, which are all instantiated. If you figure out which dependencies are available for other platform extensions, please notify me through an issue or send me a PR.

Reasoning for the redesign: Platform extensions work with types, and possibly functions, defined in platform specific C headers like windows.h or X11/Xlib.h. Most important use case of these extensions is arguably platform surface mechanics. The third party library glfw3 is a solid way to deal with Vulkan platform surfaces in a platform agnostic way. However, by design, glfw3 does not support surface unrelated platform extensions (e.g. VK_KHR_external_memory_win32). The only official platform API (as in being part of the dlang standard lib/runtime) is the windows API, but luckily ports of other platform APIs do exist in the dub registry. ErupteD should not rely on unofficial dependencies, as they may brake or become deprecated. Moreover, specifying several different platform dependencies in dub.sdl/.json does pollute the local dub cache with foreign platform projects, even if they are usable on the current platform (e.g. xlib-d on windows platform).

Generating Bindings

The generator for Erupted-V2 was split off into its own github project V-Erupt. With this approach Erupte-V2 releases can correspond to Vulkan docs version releases. V-Erupt is a submodule of Erupted-V2. Either invoke git submodule update --init --recursive or pull it to some other location (it is not a dub project!). You'll also need the Vulkan-Docs repo (Requires Python 3 and lxml.etree). Finally, to erupt the dlang bindings, call erupt_dlang.py passing path/to/Vulkan-docs as first argument and an output folder for the D files as second argument.

ErupteD Deprecation and Upgrade Process

ErupteD-V2 is supposed to replace ErupteD, preferably keeping the original project name. The challenge in this endeavor lies in the significant breaking changes and the desired reset of semantic versions. The replaced ErupteD is supposed to match the Vulkan-Docs versioning, but the current ErupteD versioning is far beyond those.

The following release and deprecation process shall ease the transition from old to new clean slate ErupteD:

• [ x ] release ErupteD-V2
• [ x ] release ErupteD-V1, forked from current state ErupteD
• [ x ] deprecate ErupteD module erupted.types in place of the whole ErupteD project
• [ _ ] May 1st 2018, destroy ErupteD
• [ _ ] recreate and release ErupteD with all published releases from Erupted-V2 (should be few)
• [ _ ] deprecate ErupteD-V2 module erupted.types in place of the whole ErupteD-V2 project
• [ _ ] June 1st 2018 destroy ErupteD-V2
• [ _ ] destroy or archive ErupteD-V1