covk 0.1.2-1.4.346

Unsafe vulkan bindings for Rust
Documentation
// generated file, do not modify manually
#![allow(unused_qualifications)]
#![allow(mismatched_lifetime_syntaxes)]
use crate::sys;
use crate::sys::ffi::*;
use crate::vk::*;
use crate::vk;
use crate::{Abi, Vk, Sys};

/// `VK_NV_low_latency2` DeviceCommands
#[derive(Debug, Clone, Copy)]
pub struct Device(pub sys::nv::low_latency2::DeviceCommands);

impl Device {
    pub fn load(get: impl FnMut(&::core::ffi::CStr) -> Option<crate::ProcAddr>) -> Self {
        Self(unsafe { sys::nv::low_latency2::DeviceCommands::load(get) })
    }
}

impl Device {
    /// ```c
    /// void vkGetLatencyTimingsNV(VkDevice device, VkSwapchainKHR swapchain, VkGetLatencyMarkerInfoNV* pLatencyMarkerInfo)
    /// ```
    pub unsafe fn get_latency_timings(
        &self,
        device: vk::Device,
        swapchain: vk::SwapchainKHR,
        latency_marker_info: &mut GetLatencyMarkerInfoNV,
    ) -> () {
        unsafe {
            self.0.GetLatencyTimingsNV(
                device.abi(), 
                swapchain.abi(), 
                latency_marker_info.abi(), 
            );
        }
    }
    /// ```c
    /// VkResult vkLatencySleepNV(VkDevice device, VkSwapchainKHR swapchain, VkLatencySleepInfoNV const* pSleepInfo)
    /// ```
    pub unsafe fn latency_sleep(
        &self,
        device: vk::Device,
        swapchain: vk::SwapchainKHR,
        sleep_info: &LatencySleepInfoNV,
    ) -> crate::Result<()> {
        unsafe {
            let _r = self.0.LatencySleepNV(
                device.abi(), 
                swapchain.abi(), 
                sleep_info.abi(), 
            ).vk();
            _r.result(|| Some(()))
        }
    }
    /// ```c
    /// void vkQueueNotifyOutOfBandNV(VkQueue queue, VkOutOfBandQueueTypeInfoNV const* pQueueTypeInfo)
    /// ```
    pub unsafe fn queue_notify_out_of_band(
        &self,
        queue: vk::Queue,
        queue_type_info: &OutOfBandQueueTypeInfoNV,
    ) -> () {
        unsafe {
            self.0.QueueNotifyOutOfBandNV(
                queue.abi(), 
                queue_type_info.abi(), 
            );
        }
    }
    /// ```c
    /// void vkSetLatencyMarkerNV(VkDevice device, VkSwapchainKHR swapchain, VkSetLatencyMarkerInfoNV const* pLatencyMarkerInfo)
    /// ```
    pub unsafe fn set_latency_marker(
        &self,
        device: vk::Device,
        swapchain: vk::SwapchainKHR,
        latency_marker_info: &SetLatencyMarkerInfoNV,
    ) -> () {
        unsafe {
            self.0.SetLatencyMarkerNV(
                device.abi(), 
                swapchain.abi(), 
                latency_marker_info.abi(), 
            );
        }
    }
    /// ```c
    /// VkResult vkSetLatencySleepModeNV(VkDevice device, VkSwapchainKHR swapchain, VkLatencySleepModeInfoNV const* pSleepModeInfo)
    /// ```
    pub unsafe fn set_latency_sleep_mode(
        &self,
        device: vk::Device,
        swapchain: vk::SwapchainKHR,
        sleep_mode_info: &LatencySleepModeInfoNV,
    ) -> crate::Result<()> {
        unsafe {
            let _r = self.0.SetLatencySleepModeNV(
                device.abi(), 
                swapchain.abi(), 
                sleep_mode_info.abi(), 
            ).vk();
            _r.result(|| Some(()))
        }
    }
}

impl crate::CommandScope<vk::Device> for vk::extensions::nv::low_latency2 {
    type Commands = Device;
}

/// Device object
pub trait NvLowLatency2Device {
    fn raw(&self) -> vk::Device;
    fn commands(&self) -> &Device;

    /// ```c
    /// void vkGetLatencyTimingsNV(VkDevice device, VkSwapchainKHR swapchain, VkGetLatencyMarkerInfoNV* pLatencyMarkerInfo)
    /// ```
    unsafe fn get_latency_timings(
        &self,
        swapchain: vk::SwapchainKHR,
        latency_marker_info: &mut GetLatencyMarkerInfoNV,
    ) -> () {
        unsafe {
            self.commands().get_latency_timings(
                self.raw(),
                swapchain,
                latency_marker_info,
            )
        }
    }
    /// ```c
    /// VkResult vkLatencySleepNV(VkDevice device, VkSwapchainKHR swapchain, VkLatencySleepInfoNV const* pSleepInfo)
    /// ```
    unsafe fn latency_sleep(
        &self,
        swapchain: vk::SwapchainKHR,
        sleep_info: &LatencySleepInfoNV,
    ) -> crate::Result<()> {
        unsafe {
            self.commands().latency_sleep(
                self.raw(),
                swapchain,
                sleep_info,
            )
        }
    }
    /// ```c
    /// void vkSetLatencyMarkerNV(VkDevice device, VkSwapchainKHR swapchain, VkSetLatencyMarkerInfoNV const* pLatencyMarkerInfo)
    /// ```
    unsafe fn set_latency_marker(
        &self,
        swapchain: vk::SwapchainKHR,
        latency_marker_info: &SetLatencyMarkerInfoNV,
    ) -> () {
        unsafe {
            self.commands().set_latency_marker(
                self.raw(),
                swapchain,
                latency_marker_info,
            )
        }
    }
    /// ```c
    /// VkResult vkSetLatencySleepModeNV(VkDevice device, VkSwapchainKHR swapchain, VkLatencySleepModeInfoNV const* pSleepModeInfo)
    /// ```
    unsafe fn set_latency_sleep_mode(
        &self,
        swapchain: vk::SwapchainKHR,
        sleep_mode_info: &LatencySleepModeInfoNV,
    ) -> crate::Result<()> {
        unsafe {
            self.commands().set_latency_sleep_mode(
                self.raw(),
                swapchain,
                sleep_mode_info,
            )
        }
    }
}

impl crate::HndScope<vk::Device> for vk::extensions::nv::low_latency2 {
    type Impl = _hs_Device::Device;
}

mod _hs_Device {
    use super::*;
    #[derive(Debug)]
    pub struct Device(pub(crate) ::alloc::sync::Arc<super::Device>, pub(crate) crate::hnd::Device<vk::core>);

    impl Clone for Device {
        fn clone(&self) -> Self { Self(self.0.clone(), self.1.clone()) }
    }

    impl crate::hnd::Device<vk::extensions::nv::low_latency2> {
        pub unsafe fn new(base: &crate::hnd::Device<vk::core>) -> Self {
            unsafe {
                Self(Device(
                   ::alloc::sync::Arc::new(super::Device::load(|name| unsafe { base.get_proc_addr(name) })),
                   base.clone(),
                ))
            }
        }
    }

    impl crate::Extension<crate::hnd::Device<vk::core>> for vk::extensions::nv::low_latency2 {
        type Output = crate::hnd::Device<vk::extensions::nv::low_latency2>;
        unsafe fn make(target: &crate::hnd::Device<vk::core>) -> Self::Output {
            unsafe { crate::hnd::Device::<vk::extensions::nv::low_latency2>::new(target) }
        }
    }

    impl crate::hnd::Device<vk::extensions::nv::low_latency2> {
        pub fn raw(&self) -> vk::Device { self.0.1.raw() }
        pub fn commands(&self) -> &::alloc::sync::Arc<super::Device> { &self.0.0 }
        pub fn core(&self) -> &crate::hnd::Device<vk::core> { &self.0.1 }
    }

    impl ::core::fmt::Debug for crate::hnd::Device<vk::extensions::nv::low_latency2> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            f.write_fmt(format_args!("Device({:p})", self.raw()))
        }
    }

    impl ::core::fmt::Pointer for crate::hnd::Device<vk::extensions::nv::low_latency2> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            self.raw().fmt(f)
        }
    }

    impl ::core::ops::Deref for crate::hnd::Device<vk::extensions::nv::low_latency2> {
        type Target = super::Device;
        fn deref(&self) -> &Self::Target { self.commands() }
    }

    impl super::NvLowLatency2Device for crate::hnd::Device<vk::extensions::nv::low_latency2> {
        fn raw(&self) -> vk::Device { self.raw() }
        fn commands(&self) -> &super::Device { self.commands() }
    }

    impl crate::HndCtx<vk::extensions::nv::low_latency2, vk::Device> for crate::hnd::Device<vk::extensions::nv::low_latency2> {
        type Ctx = Self;
        fn ctx(&self) -> Self::Ctx { self.clone() }
        fn raw(&self) -> vk::Device { self.raw() }
        fn commands(&self) -> &::alloc::sync::Arc<super::Device> { self.commands() }
    }
}

/// Queue object
pub trait NvLowLatency2Queue {
    fn raw(&self) -> vk::Queue;
    fn commands(&self) -> &Device;

    /// ```c
    /// void vkQueueNotifyOutOfBandNV(VkQueue queue, VkOutOfBandQueueTypeInfoNV const* pQueueTypeInfo)
    /// ```
    unsafe fn notify_out_of_band(
        &self,
        queue_type_info: &OutOfBandQueueTypeInfoNV,
    ) -> () {
        unsafe {
            self.commands().queue_notify_out_of_band(
                self.raw(),
                queue_type_info,
            )
        }
    }
}