Added Result return type for creating the vulkan Allocator.

Traverse-Research · May 31, 2021 · fdacfde · fdacfde
1 parent 161fe7b
commit fdacfde
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/examples/vulkan-buffer/src/main.rs b/examples/vulkan-buffer/src/main.rs
@@ -93,7 +93,8 @@ fn main() {
         device: device.clone(),
         physical_device: pdevice,
         debug_settings: Default::default(),
-    });
+    })
+    .unwrap();
 
     // Test allocating GPU Only memory
     {

diff --git a/examples/vulkan-visualization/src/main.rs b/examples/vulkan-visualization/src/main.rs
@@ -229,7 +229,8 @@ fn main() {
             device: device.clone(),
             physical_device: pdevice,
             debug_settings: Default::default(),
-        });
+        })
+        .unwrap();
 
         let fence_create_info =
             vk::FenceCreateInfo::builder().flags(vk::FenceCreateFlags::SIGNALED);

diff --git a/src/result.rs b/src/result.rs
@@ -10,6 +10,8 @@ pub enum AllocationError {
     NoCompatibleMemoryTypeFound,
     #[error("Invalid AllocationCreateDesc")]
     InvalidAllocationCreateDesc,
+    #[error("Invalid AllocatorCreateDesc {0}")]
+    InvalidAllocatorCreateDesc(String),
     #[error("Internal error {0}")]
     Internal(String),
 }

diff --git a/src/vulkan/mod.rs b/src/vulkan/mod.rs
@@ -442,7 +442,13 @@ pub struct Allocator {
 }
 
 impl Allocator {
-    pub fn new(desc: &AllocatorCreateDesc) -> Self {
+    pub fn new(desc: &AllocatorCreateDesc) -> Result<Self> {
+        if desc.physical_device == ash::vk::PhysicalDevice::null() {
+            return Err(AllocationError::InvalidAllocatorCreateDesc(
+                "AllocatorCreateDesc field `physical_device` is null.".into(),
+            ));
+        }
+
         let mem_props = unsafe {
             desc.instance
                 .get_physical_device_memory_properties(desc.physical_device)
@@ -519,14 +525,14 @@ impl Allocator {
 
         let granularity = physical_device_properties.limits.buffer_image_granularity;
 
-        Self {
+        Ok(Self {
             memory_types,
             #[cfg(feature = "visualizer")]
             memory_heaps,
             device: desc.device.clone(),
             buffer_image_granularity: granularity,
             debug_settings: desc.debug_settings,
-        }
+        })
     }
 
     pub fn allocate(&mut self, desc: &AllocationCreateDesc) -> Result<Allocation> {