dxwr 0.4.3

Direct3D12 and DXGI wrapper library
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use super::*;
use crate::resources::ShareableHandle;
use std::sync::{
    Arc,
    atomic::{self, AtomicU64},
};
use std::time::Duration;
use windows::Win32::Foundation::HANDLE;
use windows::Win32::Graphics::Direct3D12::*;
use windows::core::Interface;

pub struct Builder {
    device: ID3D12Device,
    flags: D3D12_FENCE_FLAGS,
    name: Option<String>,
}

impl Builder {
    fn new<T>(device: &T) -> Self
    where
        T: Into<ID3D12Device> + Clone,
    {
        Self {
            device: device.clone().into(),
            flags: D3D12_FENCE_FLAG_NONE,
            name: None,
        }
    }

    #[inline]
    pub fn flags(mut self, flags: D3D12_FENCE_FLAGS) -> Self {
        self.flags = flags;
        self
    }

    #[inline]
    pub fn name(mut self, name: impl AsRef<str>) -> Self {
        self.name = Some(name.as_ref().to_string());
        self
    }

    #[inline]
    pub fn build(self) -> windows::core::Result<Fence> {
        let handle: ID3D12Fence = unsafe { self.device.CreateFence(0, self.flags)? };
        let next_value = Arc::new(AtomicU64::new(1));
        let name = self.name.as_ref().map(|n| Name::new(&handle, n));
        Ok(Fence {
            handle,
            next_value,
            name,
        })
    }
}

#[derive(Clone, Debug)]
pub struct Fence {
    handle: ID3D12Fence,
    next_value: Arc<AtomicU64>,
    name: Option<Name>,
}

impl Fence {
    #[inline]
    #[allow(clippy::new_ret_no_self)]
    pub fn new(device: &Device) -> Builder {
        Builder::new(device.handle())
    }

    #[inline]
    pub fn signal(&self, signal: &Signal) -> windows::core::Result<()> {
        unsafe {
            if self.handle.GetCompletedValue() < signal.value {
                self.handle.Signal(signal.value)
            } else {
                Ok(())
            }
        }
    }

    #[inline]
    pub fn handle(&self) -> &ID3D12Fence {
        &self.handle
    }

    #[inline]
    pub fn name(&self) -> Option<&str> {
        self.name.as_ref().map(|n| n.as_str())
    }
}

impl PartialEq for Fence {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.handle == other.handle
    }
}

impl Eq for Fence {}

impl ShareableHandle for Fence {
    #[inline]
    fn as_device_child(&self) -> ID3D12DeviceChild {
        self.handle.cast().unwrap()
    }
}

#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Signal {
    fence: Fence,
    value: u64,
}

impl Signal {
    #[inline]
    pub fn new(fence: &Fence) -> Self {
        let value = fence.next_value.fetch_add(1, atomic::Ordering::SeqCst);
        Self {
            fence: fence.clone(),
            value,
        }
    }

    #[inline]
    pub fn wait(&self) -> windows::core::Result<()> {
        unsafe {
            if self.fence.handle.GetCompletedValue() < self.value {
                self.fence
                    .handle
                    .SetEventOnCompletion(self.value, HANDLE::default())?;
            }
        }
        Ok(())
    }

    #[inline]
    pub fn wait_timeout(&self, d: Duration) -> windows::core::Result<bool> {
        unsafe {
            if self.fence.handle.GetCompletedValue() < self.value {
                let event = EventHandle::new()?;
                self.fence
                    .handle
                    .SetEventOnCompletion(self.value, event.handle())?;
                return event.wait_timeout(d);
            }
        }
        Ok(true)
    }

    #[inline]
    pub fn is_completed(&self) -> bool {
        unsafe { self.fence.handle.GetCompletedValue() >= self.value }
    }

    #[inline]
    pub fn fence(&self) -> &Fence {
        &self.fence
    }

    #[inline]
    pub fn value(&self) -> u64 {
        self.value
    }
}