Skip to content

Commit

Permalink
extensions/ext: Add VK_EXT_image_drm_format_modifier
Browse files Browse the repository at this point in the history
  • Loading branch information
i509VCB committed Apr 15, 2022
1 parent 61ab543 commit a598e62
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 2 deletions.
1 change: 1 addition & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

- Update Vulkan-Headers to 1.3.211 (#605, #608)
- Added `VK_EXT_image_drm_format_modifier` device extension (#603)

### Removed

Expand Down
122 changes: 122 additions & 0 deletions ash/src/extensions/ext/image_drm_format_modifier.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
use crate::extensions::khr::GetPhysicalDeviceProperties2;
use crate::prelude::*;
use crate::vk;
use crate::{Device, Instance};
use std::ffi::CStr;
use std::mem;

/// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_drm_format_modifier.html>
#[derive(Clone)]
pub struct ImageDrmFormatModifier {
handle: vk::Device,
fp: vk::ExtImageDrmFormatModifierFn,
}

impl ImageDrmFormatModifier {
pub fn new(instance: &Instance, device: &Device) -> Self {
let handle = device.handle();
let fp = vk::ExtImageDrmFormatModifierFn::load(|name| unsafe {
mem::transmute(instance.get_device_proc_addr(handle, name.as_ptr()))
});
Self { handle, fp }
}

/// <https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetImageDrmFormatModifierPropertiesEXT.html>
pub unsafe fn get_image_drm_format_modifier_properties(
&self,
image: vk::Image,
properties: &mut vk::ImageDrmFormatModifierPropertiesEXT,
) -> VkResult<()> {
(self.fp.get_image_drm_format_modifier_properties_ext)(self.handle, image, properties)
.result()
}

/// Retrieve a list of DRM format modifiers the supported for a format on the physical device.
///
/// This is equivalent to calling [`Instance::get_physical_device_format_properties2`] with
/// [`DrmFormatModifierPropertiesListEXT`](vk::DrmFormatModifierPropertiesListEXT) extending [`FormatProperties2`](vk::FormatProperties2).
///
/// # Safety
///
/// * This function requires the [`VK_EXT_image_drm_format_modifier`] extension.
/// * This function requires Vulkan 1.1.
///
/// If you use Vulkan 1.0, use [`GetPhysicalDeviceProperties2::get_drm_format_properties_list`]
/// instead.
///
/// [`VK_EXT_image_drm_format_modifier`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_drm_format_modifier.html
pub unsafe fn get_drm_format_properties_list(
instance: &Instance,
pdevice: vk::PhysicalDevice,
format: vk::Format,
mut format_properties: &mut vk::FormatProperties2,
) -> Vec<vk::DrmFormatModifierPropertiesEXT> {
let mut list = vk::DrmFormatModifierPropertiesListEXT::default();
format_properties.push_next(&mut list);

read_into_uninitialized_vector(|count, data| {
// The data pointer will always be null on the first invocation of the closure.
list.p_drm_format_modifier_properties = data;

instance.get_physical_device_format_properties2(
pdevice,
format,
&mut format_properties,
);

*count = list.drm_format_modifier_count;

vk::Result::SUCCESS
})
// The closure always returns SUCCESS
.unwrap()
}

pub const fn name() -> &'static CStr {
vk::ExtImageDrmFormatModifierFn::name()
}

pub fn fp(&self) -> &vk::ExtImageDrmFormatModifierFn {
&self.fp
}

pub fn device(&self) -> vk::Device {
self.handle
}
}

// Vulkan 1.0
impl GetPhysicalDeviceProperties2 {
/// Retrieve a list of DRM format modifiers the supported for a format on the physical device.
///
/// This is equivalent to calling [`GetPhysicalDeviceProperties2::get_physical_device_format_properties2`] with
/// [`DrmFormatModifierPropertiesListEXT`](vk::DrmFormatModifierPropertiesListEXT) extending [`FormatProperties2KHR`](vk::FormatProperties2KHR).
///
/// # Safety
///
/// This function requires the [`VK_EXT_image_drm_format_modifier`] extension.
///
/// [`VK_EXT_image_drm_format_modifier`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_drm_format_modifier.html
pub unsafe fn get_drm_format_properties_list(
&self,
pdevice: vk::PhysicalDevice,
format: vk::Format,
mut format_properties: &mut vk::FormatProperties2KHR,
) -> Vec<vk::DrmFormatModifierPropertiesEXT> {
let mut list = vk::DrmFormatModifierPropertiesListEXT::default();
format_properties.push_next(&mut list);

read_into_uninitialized_vector(|count, data| {
// The data pointer will always be null on the first invocation of the closure.
list.p_drm_format_modifier_properties = data;

self.get_physical_device_format_properties2(pdevice, format, &mut format_properties);

*count = list.drm_format_modifier_count;

vk::Result::SUCCESS
})
// The closure always returns SUCCESS
.unwrap()
}
}
2 changes: 2 additions & 0 deletions ash/src/extensions/ext/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ pub use self::extended_dynamic_state::ExtendedDynamicState;
pub use self::extended_dynamic_state2::ExtendedDynamicState2;
pub use self::full_screen_exclusive::FullScreenExclusive;
pub use self::headless_surface::HeadlessSurface;
pub use self::image_drm_format_modifier::ImageDrmFormatModifier;
pub use self::metal_surface::MetalSurface;
pub use self::physical_device_drm::PhysicalDeviceDrm;
pub use self::private_data::PrivateData;
Expand All @@ -25,6 +26,7 @@ mod extended_dynamic_state;
mod extended_dynamic_state2;
mod full_screen_exclusive;
mod headless_surface;
mod image_drm_format_modifier;
mod metal_surface;
mod physical_device_drm;
mod private_data;
Expand Down
4 changes: 2 additions & 2 deletions ash/src/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ impl vk::Result {
///
/// [`vkEnumerateInstanceExtensionProperties`]: https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateInstanceExtensionProperties.html
pub(crate) unsafe fn read_into_uninitialized_vector<N: Copy + Default + TryInto<usize>, T>(
f: impl Fn(&mut N, *mut T) -> vk::Result,
mut f: impl FnMut(&mut N, *mut T) -> vk::Result,
) -> VkResult<Vec<T>>
where
<N as TryInto<usize>>::Error: std::fmt::Debug,
Expand Down Expand Up @@ -67,7 +67,7 @@ pub(crate) unsafe fn read_into_defaulted_vector<
N: Copy + Default + TryInto<usize>,
T: Default + Clone,
>(
f: impl Fn(&mut N, *mut T) -> vk::Result,
mut f: impl FnMut(&mut N, *mut T) -> vk::Result,
) -> VkResult<Vec<T>>
where
<N as TryInto<usize>>::Error: std::fmt::Debug,
Expand Down

0 comments on commit a598e62

Please sign in to comment.