9 releases
0.1.9 | Mar 27, 2022 |
---|---|
0.1.8 | Jun 26, 2020 |
0.1.7 | May 4, 2020 |
0.1.6 | Mar 14, 2020 |
0.1.4 | Feb 25, 2020 |
#456 in Graphics APIs
2.5MB
24K
SLoC
Contains (DOS exe, 395KB) VmaSample_Release_vs2019.exe
vulkan_raw
Usage
-
Almost names are the same as the Vulkan C API. But for some simplification reasons, a little change must be taken. The
enum
variant name is changed to withoutVK_
prefix and enum name. For example theVkFormat.VK_FORMAT_UNDEFINED
is changed toVkFormat::UNDEFINED
. Because of language limitations, some exceptions exist. They are the following:C version Corresponding vulkan_raw version VkImageCreateFlagBits.VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
VkImageCreateFlagBits::IC_2D_ARRAY_COMPATIBLE_BIT
VkQueryResultFlagBits.VK_QUERY_RESULT_64_BIT
VkQueryResultFlagBits::U64_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_1_BIT
VkSampleCountFlagBits::SC_1_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_2_BIT
VkSampleCountFlagBits::SC_2_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_4_BIT
VkSampleCountFlagBits::SC_4_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_8_BIT
VkSampleCountFlagBits::SC_8_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_16_BIT
VkSampleCountFlagBits::SC_16_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_32_BIT
VkSampleCountFlagBits::SC_32_BIT
VkSampleCountFlagBits.VK_SAMPLE_COUNT_64_BIT
VkSampleCountFlagBits::SC_64_BIT
VkImageType.VK_IMAGE_TYPE_1D
VkImageType::IT_1D
VkImageType.VK_IMAGE_TYPE_2D
VkImageType::IT_2D
VkImageType.VK_IMAGE_TYPE_3D
VkImageType::IT_3D
VkImageViewType.VK_IMAGE_VIEW_TYPE_1D
VkImageViewType::IVT_1D
VkImageViewType.VK_IMAGE_VIEW_TYPE_2D
VkImageViewType::IVT_2D
VkImageViewType.VK_IMAGE_VIEW_TYPE_3D
VkImageViewType::IVT_3D
VkImageViewType.VK_IMAGE_VIEW_TYPE_1D_ARRAY
VkImageViewType::IVT_1D_ARRAY
VkImageViewType.VK_IMAGE_VIEW_TYPE_2D_ARRAY
VkImageViewType::IVT_2D_ARRAY
VkShaderFloatControlsIndependence.VK_SHADER_FLOAT_CONTROLS_INDEPENDENCE_32_BIT_ONLY
VkShaderFloatControlsIndependence::F32_BIT_ONLY
-
Most functions must need to obtain a corresponding function pointer before use. We provide
InstanceLevelFunctions
object and/orDeviceLevelFunctions
object to do this on every module, each one corresponding to the module's functions set. TheInstanceLevelFunctions
only can be loaded fromVkInstance
, but theDeviceLevelFunctions
also can be loaded fromVkDevice
. -
All structures have
Debug
trait andDefault
trait. You don't need to set thesType
field manually if it contains.
Example
use std::ffi::CStr;
use std::ptr;
use vulkan_raw::*;
fn main() {
let mut instance_version: u32 = 0;
unsafe { vkEnumerateInstanceVersion(&mut instance_version) };
println!("Instance version: {}", ApiVersion::from(instance_version));
// Create Vulkan instance
let app_info = VkApplicationInfo {
apiVersion: ApiVersion::new(1, 2, 0).into(),
..Default::default()
};
let create_info = VkInstanceCreateInfo {
pApplicationInfo: &app_info,
..Default::default()
};
let mut instance: VkInstance = VkInstance::none();
let result = unsafe { vkCreateInstance(&create_info, ptr::null(), &mut instance) };
assert_eq!(result, VkResult::SUCCESS);
let functions = InstanceLevelFunctions::load_from_instance(instance);
// Enumerate all devices
let mut count: u32 = 0;
let result =
unsafe { functions.vkEnumeratePhysicalDevices(instance, &mut count, ptr::null_mut()) };
assert_eq!(result, VkResult::SUCCESS);
let mut physical_devices: Vec<VkPhysicalDevice> = Vec::with_capacity(count as usize);
let result = unsafe {
functions.vkEnumeratePhysicalDevices(instance, &mut count, physical_devices.as_mut_ptr())
};
assert_eq!(result, VkResult::SUCCESS);
unsafe {
physical_devices.set_len(count as usize);
}
let mut physical_device_properties = Default::default();
for physical_device in physical_devices {
unsafe {
functions
.vkGetPhysicalDeviceProperties2(physical_device, &mut physical_device_properties);
}
println!(
"Physical Device: {}; \
Supported vulkan version: {}",
unsafe { CStr::from_ptr(physical_device_properties.properties.deviceName.as_ptr()) }
.to_str()
.unwrap(),
ApiVersion::from(physical_device_properties.properties.apiVersion)
);
}
unsafe { functions.vkDestroyInstance(instance, ptr::null()) };
}
Supported API
- Vulkan 1.2 core API
- VK_KHR_external_fence_fd(Revision: 1)
- VK_KHR_external_fence_win32(Revision: 1)
- VK_KHR_surface(Revision: 25)
- VK_KHR_swapchain(Revision: 70)
- VK_KHR_win32_surface(Revision: 6)
- VK_KHR_pipeline_library(Revision: 1)
- VK_KHR_deferred_host_operations(Revision: 4)
- VK_KHR_acceleration_structure(Revision: 13)
- VK_KHR_ray_tracing_pipeline(Revision: 1)
- VK_KHR_ray_query(Revision: 1)
- VK_EXT_debug_utils(Revision: 2)
- VK_EXT_index_type_uint8(Revision: 1)
- VK_EXT_memory_budget(Revision: 1)