voodoo 0.3.1

An intuitive, idiomatic, unopinionated, zero-overhead Vulkan API
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

use std::sync::Arc;
use vks;
use ::{VdResult, CallResult, Handle, Device, FenceCreateFlags, FenceCreateInfo};

pub enum FenceStatus {
    Signaled,
    Unsignaled,
    Error(CallResult),
}

impl From<CallResult> for FenceStatus {
    fn from(res: CallResult) -> FenceStatus {
        match res {
            CallResult::Success => FenceStatus::Signaled,
            CallResult::NotReady => FenceStatus::Unsignaled,
            _ => FenceStatus::Error(res),
        }
    }
}

impl From<i32> for FenceStatus {
    fn from(res: i32) -> FenceStatus {
        CallResult::from(res).into()
    }
}


#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(C)]
pub struct FenceHandle(pub(crate) vks::VkFence);

impl FenceHandle {
    #[inline(always)]
    pub fn to_raw(&self) -> vks::VkFence {
        self.0
    }
}

unsafe impl Handle for FenceHandle {
    type Target = FenceHandle;

    /// Returns this object's handle.
    fn handle(&self) -> Self::Target {
        *self
    }
}


#[derive(Debug)]
struct Inner {
    handle: FenceHandle,
    device: Device,
}

impl Drop for Inner {
    fn drop(&mut self) {
        unsafe {
            self.device.destroy_fence(self.handle, None);
        }
    }
}


/// A fence.
///
///
/// ### Destruction
/// 
/// Dropping this `Fence` will cause `Device::destroy_fence` to be called, 
/// automatically releasing any resources associated with it.
///
#[derive(Debug, Clone)]
pub struct Fence {
    inner: Arc<Inner>,
}

impl Fence {
    /// Creates and returns a new fence.
    pub fn new(device: Device, flags: FenceCreateFlags) -> VdResult<Fence> {
        let create_info = FenceCreateInfo::builder()
            .flags(flags)
            .build();

        let handle = unsafe { device.create_fence(&create_info, None)? };

        Ok(Fence {
            inner: Arc::new(Inner {
                handle,
                device,
            })
        })
    }

    /// Returns this object's handle.
    pub fn handle(&self) -> FenceHandle {
        self.inner.handle
    }

    /// Returns a reference to this object's associated device.
    pub fn device(&self) -> &Device {
        &self.inner.device
    }

    /// Returns the status of this fence.
    ///
    /// https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkGetFenceStatus.html
    //
    pub fn status(&self) -> VdResult<FenceStatus> {
        unsafe { Ok(FenceStatus::from(self.inner.device.get_fence_status(self.handle())?)) }
    }
}

unsafe impl<'h> Handle for &'h Fence {
    type Target = FenceHandle;

    fn handle(&self) -> Self::Target {
        self.inner.handle
    }
}