Enable portability features on macOS

README.md

@@ -22,7 +22,10 @@ To build the project with natives for your platform run
 ./gradlew build
 ```
 in the project root directory.
-
+### macOS
+Blaze4D now (mostly) works on macOS! Building and running follows the same steps as on Windows or Linux.
+The only difference is that you need to set the `VK_INSTANCE_LAYERS` environment variable to `VK_LAYER_KHRONOS_synchronization2` because moltenVK doesn't natively support it.
+### Running
 To run the game with the mod use any of the 3 run targets:
 - `./gradlew runClient`
 - `./gradlew runClientWithValidation` - Enables validation layers

core/natives/src/device/init.rs

@@ -4,6 +4,7 @@ use std::os::raw::c_char;
 use std::sync::Arc;
 
 use ash::vk;
+use ash::vk::{DeviceCreateFlags, PhysicalDeviceFeatures2, PhysicalDevicePortabilitySubsetFeaturesKHR};
 use bumpalo::Bump;
 use vk_profiles_rs::{vp, VulkanProfiles};
 
@@ -97,8 +98,13 @@ pub fn create_device(config: DeviceCreateConfig, instance: Arc<InstanceContext>)
         );
     }
 
-    let device_create_info = device_create_info.queue_create_infos(queue_create_infos.as_slice());
-
+    let mut portability_subset_features = PhysicalDevicePortabilitySubsetFeaturesKHR::default();
+    #[cfg(target_os = "macos")] {
+        let mut dummy_features = PhysicalDeviceFeatures2::builder().push_next(&mut portability_subset_features);
+        unsafe {instance.vk().get_physical_device_features2(physical_device, &mut dummy_features);}
+    }
+    let device_create_info = device_create_info.queue_create_infos(queue_create_infos.as_slice())
+        .push_next(&mut portability_subset_features);
     let mut flags = vp::DeviceCreateFlagBits::MERGE_EXTENSIONS | vp::DeviceCreateFlagBits::OVERRIDE_FEATURES;
     if config.disable_robustness {
         flags |= vp::DeviceCreateFlagBits::DISABLE_ROBUST_ACCESS;
@@ -374,6 +380,15 @@ fn configure_device(device: &mut DeviceConfigurator) -> Result<Option<DeviceConf
     }
     device.add_extension(&push_descriptor_name);
 
+    let request_portability = cfg!(target_os="macos");
+    if request_portability {
+        let portability_subset_name = CString::new("VK_KHR_portability_subset").unwrap();
+        if !device.is_extension_supported(&portability_subset_name) {
+            log::info!("Physical device (moltenVK) {:?} does not support VK_KHR_portability_subset", device.get_name());
+            return Ok(None);
+        }
+        device.add_extension(&portability_subset_name);
+    }
     let maintenance_4_name = CString::new("VK_KHR_maintenance4").unwrap();
     let mut maintenance4;
     if !device.is_extension_supported(&maintenance_4_name) {

core/natives/src/instance/init.rs

@@ -5,6 +5,7 @@ use std::str::Utf8Error;
 use std::sync::Arc;
 
 use ash::vk;
+use ash::vk::InstanceCreateFlags;
 
 use vk_profiles_rs::vp;
 use crate::{BUILD_INFO, CRATE_NAME};
@@ -134,10 +135,23 @@ pub fn create_instance(config: InstanceCreateConfig) -> Result<Arc<InstanceConte
         .engine_version(vk::make_api_version(0, BUILD_INFO.version_major, BUILD_INFO.version_minor, BUILD_INFO.version_patch))
         .api_version(max_api_version.into());
 
+    // this has to be outside of the if statement because it is prematurely dropped otherwise
+    let portability_name = CString::new("VK_KHR_portability_enumeration").unwrap();
+    let request_portability = cfg!(target_os="macos");
+    // Request portability extensions/portability enumeration bit for moltenVK
+    let instance_create_flags = if request_portability {
+        required_extensions_str.push(portability_name.as_c_str().as_ptr());
+        InstanceCreateFlags::ENUMERATE_PORTABILITY_KHR
+    } else {
+        InstanceCreateFlags::default()
+    };
+
     let mut instance_create_info = vk::InstanceCreateInfo::builder()
         .application_info(&application_info)
         .enabled_layer_names(required_layers.as_slice())
-        .enabled_extension_names(required_extensions_str.as_slice());
+        .enabled_extension_names(required_extensions_str.as_slice())
+        .flags(instance_create_flags);
+
 
     let debug_messengers = config.debug_messengers.into_boxed_slice();
     let mut debug_messenger_create_infos: Vec<_> = debug_messengers.iter().map(|messenger| {