plate 0.5.0

Rust library for writing simpler Vulkan code
Documentation 
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

use std::sync::Arc;

use ash::vk;

use crate::{Device, Error};

pub use vk::FenceCreateFlags as FenceFlags;
pub use vk::SemaphoreCreateFlags as SemaphoreFlags;

/// Used to synchronize the host with the GPU.
///
/// Some GPU operations can set the Fence to be signaled or unsignaled, the host can then wait on
/// for these operation to finish accordingly.
pub struct Fence {
    device: Arc<Device>,
    fence: vk::Fence,
}

impl Drop for Fence {
    fn drop(&mut self) { unsafe { self.device.destroy_fence(self.fence, None) }
    }
}

impl std::ops::Deref for Fence {
    type Target = vk::Fence;

    fn deref(&self) -> &Self::Target {
        &self.fence
    }
}

impl Fence {
    /// Creates a Fence.
    ///
    /// Eamples
    /// ```no_run
    /// # let event_loop = winit::event_loop::EventLoop::new();
    /// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
    /// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
    /// let fence = plate::Fence::new(&device, plate::FenceFlags::SIGNALED)?;
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn new(device: &Arc<Device>, flags: FenceFlags) -> Result<Self, Error> {
        let info = vk::FenceCreateInfo::builder().flags(flags);
        let fence = unsafe { device.create_fence(&info, None)? };

        Ok(Self {
            device: Arc::clone(&device),
            fence,
        })
    }

    /// Block until the Fence is signaled.
    ///
    /// Eamples
    /// ```no_run
    /// # let event_loop = winit::event_loop::EventLoop::new();
    /// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
    /// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
    /// # let fence = plate::Fence::new(&device, plate::FenceFlags::SIGNALED)?;
    /// fence.wait()?;
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn wait(&self) -> Result<(), Error> {
        Ok(unsafe { self.device.wait_for_fences(&[self.fence], true, u64::MAX)? })
    }

    /// Resets the state of the Fence to unsignaled.
    ///
    /// Eamples
    /// ```no_run
    /// # let event_loop = winit::event_loop::EventLoop::new();
    /// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
    /// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
    /// # let fence = plate::Fence::new(&device, plate::FenceFlags::SIGNALED)?;
    /// fence.wait()?;
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn reset(&self) -> Result<(), Error> {
        Ok(unsafe { self.device.reset_fences(&[self.fence])? })
    }
}

/// Used to synchronize the execution of GPU instructions.
///
/// The GPU executes instructions in parallel, to make sure these instructions run at the correct
/// order, some operations can wait on or set the state of Semaphores to be signaled or unsignaled.
pub struct Semaphore {
    device: Arc<Device>,
    semaphore: vk::Semaphore,
}

impl Drop for Semaphore {
    fn drop(&mut self) {
        unsafe { self.device.destroy_semaphore(self.semaphore, None) }
    }
}

impl std::ops::Deref for Semaphore {
    type Target = vk::Semaphore;

    fn deref(&self) -> &Self::Target {
        &self.semaphore
    }
}

impl Semaphore {
    /// Creates a Semaphore.
    ///
    /// Eamples
    /// ```no_run
    /// # let event_loop = winit::event_loop::EventLoop::new();
    /// # let window = winit::window::WindowBuilder::new().build(&event_loop)?;
    /// # let device = plate::Device::new(&Default::default(), &Default::default(), Some(&window))?;
    /// let semaphore = plate::Semaphore::new(&device, plate::SemaphoreFlags::empty())?;
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn new(device: &Arc<Device>, flags: SemaphoreFlags) -> Result<Self, Error> {
        let info = vk::SemaphoreCreateInfo::builder().flags(flags);
        let semaphore = unsafe { device.create_semaphore(&info, None)? };

        Ok(Self {
            device: Arc::clone(&device),
            semaphore,
        })
    }
}