voodoo 0.3.1

An intuitive, idiomatic, unopinionated, zero-overhead Vulkan API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

use std::ptr;
use std::fmt;
use std::ffi::CStr;
use libc::{c_char};
use lib;
use smallvec::SmallVec;
use vks::{self};
use ::{error, VdResult, Handle, InstanceHandle, CallResult, InstanceCreateInfo};
use util::CharStrs;

const PRINT: bool = false;


/// A loaded library and `InstanceProcAddrLoader`.
pub struct Loader {
    _vk_lib: lib::Library,
    vk_get_instance_proc_addr: vks::PFN_vkGetInstanceProcAddr,
    instance_proc_addr_loader: vks::InstanceProcAddrLoader,
}

impl Loader {
    /// Loads the vulkan library (`libvulkan.so`, etc), and the
    /// `InstanceProcAddrLoader` with all core function pointers.
    pub fn new() -> VdResult<Loader> {
        let lib_filename = if cfg!(not(any(target_os = "macos", target_os = "ios"))) {
            if cfg!(all(unix, not(target_os = "android"), not(target_os = "macos"))) { "libvulkan.so.1" }
            else if cfg!(target_os = "android") { "libvulkan.so" }
            else if cfg!(windows) { "vulkan-1.dll" }
            else { unimplemented!("unknown operating system") }
        } else {
            unimplemented!("macos not implemented");
        };
        let vk_lib = lib::Library::new(lib_filename).unwrap();

        let vk_get_instance_proc_addr = unsafe {
            let fn_name = "vkGetInstanceProcAddr";

            let get_proc_addr: lib::Symbol<vks::PFN_vkGetInstanceProcAddr> = vk_lib.get(fn_name.as_bytes()).unwrap();
            *get_proc_addr
        };

        let mut instance_proc_addr_loader = vks::InstanceProcAddrLoader::from_get_instance_proc_addr(vk_get_instance_proc_addr);
        unsafe {
            instance_proc_addr_loader.load_vk_global();
        }

        Ok(Loader { _vk_lib: vk_lib, vk_get_instance_proc_addr, instance_proc_addr_loader })
    }

    /// Returns the `vkGetInstanceProcAddr` function pointer.
    #[inline]
    pub fn get_instance_proc_addr(&self)
            -> Option<unsafe extern "system" fn(*mut vks::VkInstance_T, *const i8)
                -> Option<unsafe extern "system" fn()>> {
        self.vk_get_instance_proc_addr
    }

    /// Returns the core global function pointer struct.
    #[inline]
    pub fn core_global(&self) -> &vks::instance_proc_addr_loader::VkGlobal {
        &self.instance_proc_addr_loader.vk_global
    }

    /// Returns a reference to the `InstanceProcAddrLoader`.
    #[inline]
    pub fn instance_proc_addr_loader(&self) -> &vks::InstanceProcAddrLoader {
        &self.instance_proc_addr_loader
    }

    /// Returns a mutable reference to the `InstanceProcAddrLoader`.
    #[inline]
    pub fn instance_proc_addr_loader_mut(&mut self) -> &mut vks::InstanceProcAddrLoader {
        &mut self.instance_proc_addr_loader
    }

    /// Returns all available instance layers.
    pub fn enumerate_instance_layer_properties(&self) -> VdResult<SmallVec<[vks::VkLayerProperties; 64]>> {
        let mut property_count = 0u32;
        let mut properties = SmallVec::new();
        unsafe {
            let result = self.core_global().vkEnumerateInstanceLayerProperties(&mut property_count,
                ptr::null_mut());
            error::check(result, "vkEnumerateInstanceLayerProperties", ())?;
            properties.reserve_exact(property_count as usize);
            properties.set_len(property_count as usize);
            loop {
                let result = self.core_global().vkEnumerateInstanceLayerProperties(&mut property_count,
                    properties.as_mut_ptr());
                if result != CallResult::Incomplete as i32 {
                    error::check(result, "vkEnumerateInstanceLayerProperties", ())?;
                    break;
                }
            }
        }
        Ok(properties)
    }

    /// Returns all available instance extensions.
    pub fn enumerate_instance_extension_properties(&self) -> VdResult<SmallVec<[vks::VkExtensionProperties; 64]>> {
        let mut property_count = 0u32;
        let mut properties = SmallVec::new();
        unsafe {
            let result = self.core_global().vkEnumerateInstanceExtensionProperties(ptr::null(),
                &mut property_count, ptr::null_mut());
            error::check(result, "vkEnumerateInstanceExtensionProperties", ())?;
            properties.reserve_exact(property_count as usize);
            properties.set_len(property_count as usize);
            loop {
                let result = self.core_global().vkEnumerateInstanceExtensionProperties(ptr::null(),
                    &mut property_count, properties.as_mut_ptr());
                if result != CallResult::Incomplete as i32 {
                    error::check(result, "vkEnumerateInstanceExtensionProperties", ())?;
                    break;
                }
            }
            // Print available:
            for ext in properties.iter() {
                let name = (&ext.extensionName) as *const c_char;
                if PRINT { println!("Available instance extension: '{}' (version: {})",
                    CStr::from_ptr(name).to_str().unwrap(), ext.specVersion); }
            }
        }
        Ok(properties)
    }

    /// Verifies that each layer name listed is available.
    pub fn verify_layer_support<'a, 'cs, Cs>(&'a self, layer_names: Cs) -> VdResult<bool>
            where 'cs: 'a, Cs: 'cs + Into<CharStrs<'cs>> {
        let available_layers = self.enumerate_instance_layer_properties()?;
        // Print available layers:
        for layer_props in &available_layers {
            unsafe {
                if PRINT { println!("Available layer: '{}'",
                    CStr::from_ptr(layer_props.layerName.as_ptr()).to_str().unwrap()); }
            }
        }

        // Verify that validation layer is available:
        for &layer_name in layer_names.into().as_ptr_slice() {
            let mut layer_found = false;
            for layer_props in &available_layers {
                unsafe {
                    if CStr::from_ptr(layer_name) == CStr::from_ptr(layer_props.layerName.as_ptr()) {
                        if PRINT { println!("Layer validated: '{}'",
                            CStr::from_ptr(layer_name).to_str().unwrap()); }
                        layer_found = true;
                        break;
                    }
                }
            }
            if !layer_found { return Ok(false); }
        }
        Ok(true)
    }

    /// Enumerates the physical devices accessible to a Vulkan instance.
    ///
    /// https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkEnumeratePhysicalDevices.html
    //
    // *PFN_vkEnumeratePhysicalDevices)(VkInstance instance, uint32_t*
    // pPhysicalDeviceCount, VkPhysicalDevice* pPhysicalDevices);
    pub fn enumerate_physical_devices<I>(&self, instance: I)
            -> VdResult<SmallVec<[vks::VkPhysicalDevice; 16]>>
            where I: Handle<Target=InstanceHandle> {
        let mut device_count = 0;
        let mut devices_raw = SmallVec::new();
        unsafe {
            error::check(self.instance_proc_addr_loader.vk.vkEnumeratePhysicalDevices(instance.handle().0,
                &mut device_count, ptr::null_mut()), "vkEnumeratePhysicalDevices", ())?;
            if device_count == 0 { panic!("No physical devices found."); }
            assert!(device_count as usize <= devices_raw.inline_size());
            devices_raw.set_len(device_count as usize);
            loop {
                let result = self.instance_proc_addr_loader.vk.vkEnumeratePhysicalDevices(instance.handle().0,
                    &mut device_count, devices_raw.as_mut_ptr());
                if result != CallResult::Incomplete as i32 {
                        error::check(result, "vkEnumeratePhysicalDevices", ())?;
                        break;
                    }
                }
            }
        if PRINT { println!("Available devices: {:?}", devices_raw); }
        Ok(devices_raw)
    }

    /// Creates and returns a new Vulkan instance.
    ///
    /// https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkCreateInstance.html
    //
    // *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, const
    // VkAllocationCallbacks* pAllocator, VkInstance* pInstance);
    pub unsafe fn create_instance(&self, create_info: &InstanceCreateInfo,
            allocator: Option<*const vks::VkAllocationCallbacks>) -> VdResult<InstanceHandle> {
        let allocator = allocator.unwrap_or(ptr::null());
        let mut handle = ptr::null_mut();
        let result = self.core_global().vkCreateInstance(create_info.as_raw(), allocator, &mut handle);
        error::check(result, "vkCreateInstance", InstanceHandle(handle))
    }


    /// Destroys a Vulkan instance.
    ///
    /// https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkDestroyInstance.html
    //
    // *PFN_vkDestroyInstance)(VkInstance instance, const
    // VkAllocationCallbacks* pAllocator);
    pub fn destroy_instance(&self, instance: InstanceHandle,
            allocator: Option<*const vks::VkAllocationCallbacks>) {
        let allocator = allocator.unwrap_or(ptr::null());
        unsafe { self.instance_proc_addr_loader().vk
            .vkDestroyInstance(instance.to_raw(), allocator); }
    }
}

impl fmt::Debug for Loader {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Loader")
    }
}