alex/beta-minecraft-rust

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

use std::ffi::{CStr, c_char};
use std::ptr::{self, null, null_mut};
use std::sync::Arc;

use raw_window_handle::{RawDisplayHandle, RawWindowHandle};
use volcanic::loader::{InstanceCommands, Loader};
use volcanic::*;

use super::validation::{LAYER, VAR, Validation};
use super::{Error, Result, check, create, zeroed};

pub struct Instance {
    pub(crate) handle: VkInstance,
    pub(crate) commands: InstanceCommands,
    /// Whether `VK_KHR_get_surface_capabilities2` is enabled, which present timing needs.
    pub(crate) surface_capabilities2: bool,
    messenger: VkDebugUtilsMessengerEXT,
    _loader: Loader,
}

// SAFETY: Vulkan instance handles and their loaded commands may be used from any thread.
unsafe impl Send for Instance {}
unsafe impl Sync for Instance {}

impl Instance {
    pub fn new(display: RawDisplayHandle, validation: Option<Validation>) -> Result<Arc<Self>> {
        let loader = unsafe { Loader::new()? };
        let platform_extension = match display {
            RawDisplayHandle::Wayland(_) => VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME,
            RawDisplayHandle::Xlib(_) => VK_KHR_XLIB_SURFACE_EXTENSION_NAME,
            RawDisplayHandle::Xcb(_) => VK_KHR_XCB_SURFACE_EXTENSION_NAME,
            _ => return Err(Error::UnsupportedWindowSystem),
        };

        let validation = match validation {
            Some(_) if !layer_available(&loader)? => {
                tracing::warn!("{VAR} is set but {LAYER:?} is not installed");
                None
            }
            validation => validation,
        };
        if let Some(validation) = validation {
            tracing::info!("Vulkan validation enabled: {VAR}={validation}");
        }

        let mut extensions: Vec<*const c_char> = vec![
            VK_KHR_SURFACE_EXTENSION_NAME.as_ptr(),
            platform_extension.as_ptr(),
        ];
        let surface_capabilities2 =
            extension_available(&loader, VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME)?;
        if surface_capabilities2 {
            extensions.push(VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME.as_ptr());
        }
        let layers: Vec<*const c_char> = if validation.is_some() {
            extensions.push(VK_EXT_DEBUG_UTILS_EXTENSION_NAME.as_ptr());
            extensions.push(VK_EXT_LAYER_SETTINGS_EXTENSION_NAME.as_ptr());
            vec![LAYER.as_ptr()]
        } else {
            Vec::new()
        };

        let application = VkApplicationInfo {
            sType: VkStructureType::ApplicationInfo,
            pApplicationName: c"Minecraft".as_ptr(),
            apiVersion: VK_API_VERSION_1_4,
            ..zeroed()
        };
        let report_flags = validation.map(Validation::report_flags).unwrap_or_default();
        let layer_settings = validation.map(|v| v.layer_settings(&report_flags));
        let messenger_info = validation.map(Validation::messenger_info);
        let settings_info = layer_settings
            .as_ref()
            .map(|settings| VkLayerSettingsCreateInfoEXT {
                sType: VkStructureType::LayerSettingsCreateInfoExt,
                pNext: messenger_info
                    .as_ref()
                    .map_or(null(), |info| ptr::from_ref(info).cast()),
                settingCount: settings.len() as u32,
                pSettings: settings.as_ptr(),
            });
        let info = VkInstanceCreateInfo {
            sType: VkStructureType::InstanceCreateInfo,
            pNext: settings_info
                .as_ref()
                .map_or(null(), |info| ptr::from_ref(info).cast()),
            pApplicationInfo: &application,
            enabledLayerCount: layers.len() as u32,
            ppEnabledLayerNames: layers.as_ptr(),
            enabledExtensionCount: extensions.len() as u32,
            ppEnabledExtensionNames: extensions.as_ptr(),
            ..zeroed()
        };
        let handle = create(|handle| unsafe { loader.vkCreateInstance(&info, null(), handle) })?;
        let commands = unsafe { loader.load_instance(handle)? };
        let messenger = match &messenger_info {
            Some(messenger_info) => create(|messenger| unsafe {
                commands.vkCreateDebugUtilsMessengerEXT(handle, messenger_info, null(), messenger)
            })?,
            None => VK_NULL_HANDLE,
        };
        Ok(Arc::new(Self {
            handle,
            commands,
            surface_capabilities2,
            messenger,
            _loader: loader,
        }))
    }
}

impl Drop for Instance {
    fn drop(&mut self) {
        let commands = &self.commands;
        unsafe {
            if self.messenger != VK_NULL_HANDLE {
                commands.vkDestroyDebugUtilsMessengerEXT(self.handle, self.messenger, null());
            }
            commands.vkDestroyInstance(self.handle, null());
        }
    }
}

fn layer_available(loader: &Loader) -> Result<bool> {
    let layers = super::enumerate(|count, items| unsafe {
        loader.vkEnumerateInstanceLayerProperties(count, items)
    })?;
    Ok(layers
        .iter()
        .any(|layer| unsafe { CStr::from_ptr(layer.layerName.as_ptr()) } == LAYER))
}

fn extension_available(loader: &Loader, name: &CStr) -> Result<bool> {
    let extensions = super::enumerate(|count, items| unsafe {
        loader.vkEnumerateInstanceExtensionProperties(null(), count, items)
    })?;
    Ok(extensions
        .iter()
        .any(|extension| unsafe { CStr::from_ptr(extension.extensionName.as_ptr()) } == name))
}

pub struct Surface {
    pub(crate) handle: VkSurfaceKHR,
    pub(crate) instance: Arc<Instance>,
}

impl Surface {
    /// # Safety
    /// The window and display handles must stay valid for the surface's lifetime.
    pub unsafe fn new(
        instance: &Arc<Instance>,
        display: RawDisplayHandle,
        window: RawWindowHandle,
    ) -> Result<Self> {
        let (commands, mut handle) = (&instance.commands, VK_NULL_HANDLE);
        let result = match (display, window) {
            (RawDisplayHandle::Wayland(display), RawWindowHandle::Wayland(window)) => {
                let info = VkWaylandSurfaceCreateInfoKHR {
                    sType: VkStructureType::WaylandSurfaceCreateInfoKhr,
                    display: display.display.as_ptr(),
                    surface: window.surface.as_ptr(),
                    ..zeroed()
                };
                unsafe {
                    commands.vkCreateWaylandSurfaceKHR(instance.handle, &info, null(), &mut handle)
                }
            }
            (RawDisplayHandle::Xlib(display), RawWindowHandle::Xlib(window)) => {
                let info = VkXlibSurfaceCreateInfoKHR {
                    sType: VkStructureType::XlibSurfaceCreateInfoKhr,
                    dpy: display.display.map_or(null_mut(), |d| d.as_ptr()),
                    window: window.window,
                    ..zeroed()
                };
                unsafe {
                    commands.vkCreateXlibSurfaceKHR(instance.handle, &info, null(), &mut handle)
                }
            }
            (RawDisplayHandle::Xcb(display), RawWindowHandle::Xcb(window)) => {
                let info = VkXcbSurfaceCreateInfoKHR {
                    sType: VkStructureType::XcbSurfaceCreateInfoKhr,
                    connection: display.connection.map_or(null_mut(), |c| c.as_ptr()),
                    window: window.window.get(),
                    ..zeroed()
                };
                unsafe {
                    commands.vkCreateXcbSurfaceKHR(instance.handle, &info, null(), &mut handle)
                }
            }
            _ => return Err(Error::UnsupportedWindowSystem),
        };
        check(result)?;
        Ok(Self {
            handle,
            instance: instance.clone(),
        })
    }
}

impl Drop for Surface {
    fn drop(&mut self) {
        let commands = &self.instance.commands;
        unsafe { commands.vkDestroySurfaceKHR(self.instance.handle, self.handle, null()) };
    }
}