Kazan

Vulkan bindings for Rust, generated from the official Vulkan-Headers vk.xml registry.

Why Kazan?

• Supports all Vulkan versions and extensions
• Fully generated wrappers
• Per-extension dispatch tables

Modules

• kazan::* -- helper types and traits (ArrayCStr, InstanceExtensionSet, DeviceExtensionSet, EnumerateInto, RawPtr, SliceOrLen, etc.)
• vk -- all Vulkan types, constants, function pointer types, and Vulkan-specific traits (Handle, ApiVersion, TaggedStructure, Extends, etc.), re-exported flat
  • vk::vk1_0, vk::vk1_1, ... - items grouped by API version
  • vk::khr, vk::ext, vk::nv, ... - items grouped by vendor
  • vk::khr::swapchain, vk::ext::debug_utils, ... - individual extensions
  • vk::video::* - video extensions
• window -- platform surface creation via raw-window-handle (requires window feature)
• ffi -- raw C FFI function types (requires ffi feature)

Function tables

Each API version and extension defines its own EntryFn, InstanceFn, and/or DeviceFn struct containing the commands it introduces.

• EntryFn -- global commands, no instance required
  • vk::vk1_0::EntryFn -- create_instance, enumerate_instance_extension_properties, ...
  • vk::vk1_1::EntryFn -- enumerate_instance_version
• InstanceFn -- loaded via vk::vk1_0::EntryFn
  • vk::vk1_0::InstanceFn -- enumerate_physical_devices, create_device, get_device_proc_addr, ...
  • vk::khr::surface::InstanceFn -- get_physical_device_surface_support, destroy_surface, ...
  • vk::ext::debug_utils::InstanceFn -- create_debug_utils_messenger, ...
• DeviceFn -- loaded via vk::vk1_0::InstanceFn
  • vk::vk1_0::DeviceFn -- create_image, cmd_draw, queue_submit, ...
  • vk::khr::swapchain::DeviceFn -- create_swapchain, acquire_next_image, ...

Entry bootstraps the loading chain: it holds StaticFn (vkGetInstanceProcAddr), vk1_0::EntryFn, and optionally vk1_1::EntryFn.

Example

use kazan::{Entry, LoadDeviceFn as _, LoadInstanceFn as _, vk::{self, khr::swapchain, vk1_0}};

// Load the Vulkan library and entry points.
let entry = unsafe { Entry::load()? };

// Create an instance with surface extensions for the current platform.
let display_handle = window.display_handle()?.as_raw();
let required = kazan::window::required_extensions(display_handle)?;
let extension_names: Vec<*const c_char> = required.names().map(|n| n.as_ptr()).collect();
let app_info = vk::ApplicationInfo::default()
    .application_name(c"MyApp")
    .api_version(vk1_0::API_VERSION);
let create_info = vk::InstanceCreateInfo::default()
    .application_info(&app_info)
    .enabled_extension_names(&extension_names);
let instance = entry.vk1_0.create_instance(&create_info, None)?;

// Load instance function tables.
let instance_fn = unsafe { vk1_0::InstanceFn::load(&entry, instance)? };

// Create a surface via the platform-agnostic window module.
let window_fn = kazan::window::InstanceFn::load(&entry, instance);
let window_handle = window.window_handle()?.as_raw();
let surface = unsafe { window_fn.create_surface(instance, display_handle, window_handle, None)? };

// Create a device and load device function tables.
let device = unsafe {
    instance_fn.create_device(physical_device, &device_create_info, None)?
};
let device_fn = unsafe { vk1_0::DeviceFn::load(&instance_fn, device)? };
let swapchain_fn = unsafe { swapchain::DeviceFn::load(&instance_fn, device)? };

Features

Running the generator

Parses vk.xml and video.xml from the vendored Vulkan-Headers submodule and writes generated source to crates/kazan/src/generated/.

cargo run -p generator

Acknowledgements

Kazan is heavily based on ash.

License

Licensed under either of

• Apache License, Version 2.0
• MIT License

at your option.