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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
use {
    super::{
        driver::{
            image_access_layout, CommandBuffer, Device, DriverError, Swapchain, SwapchainError,
        },
        graph::{node::SwapchainImageNode, RenderGraph, ResolverPool},
    },
    ash::vk,
    log::trace,
    std::{
        error::Error,
        fmt::{Debug, Formatter},
        sync::Arc,
        time::Instant,
    },
    vk_sync::{cmd::pipeline_barrier, AccessType, ImageBarrier, ImageLayout},
};

/// A physical display interface.
pub struct Display {
    cmd_bufs: Vec<[CommandBuffer; 3]>,
    device: Arc<Device>,
    pool: Box<dyn ResolverPool>,
    swapchain: Swapchain,
}

impl Display {
    /// Constructs a new `Display` object.
    pub fn new(device: &Arc<Device>, pool: Box<dyn ResolverPool>, swapchain: Swapchain) -> Self {
        let device = Arc::clone(device);

        Self {
            device,
            cmd_bufs: Default::default(),
            pool,
            swapchain,
        }
    }

    /// Returns a new `RenderGraph` with a bound swapchain image, if possible.
    pub fn acquire_next_image(
        &mut self,
    ) -> Result<(SwapchainImageNode, RenderGraph), SwapchainError> {
        trace!("acquire_next_image");

        let swapchain_image = self.swapchain.acquire_next_image()?;
        let mut render_graph = RenderGraph::new();
        let swapchain = render_graph.bind_node(swapchain_image);

        Ok((swapchain, render_graph))
    }

    unsafe fn begin(cmd_buf: &mut CommandBuffer) -> Result<(), ()> {
        cmd_buf
            .device
            .reset_command_pool(cmd_buf.pool, vk::CommandPoolResetFlags::RELEASE_RESOURCES)
            .map_err(|_| ())?;
        cmd_buf
            .device
            .begin_command_buffer(
                **cmd_buf,
                &vk::CommandBufferBeginInfo::builder()
                    .flags(vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT),
            )
            .map_err(|_| ())
    }

    /// Displays the given swapchain image using passes specified in `render_graph`, if possible.
    pub fn present_image(
        &mut self,
        render_graph: RenderGraph,
        swapchain_image: SwapchainImageNode,
    ) -> Result<(), DisplayError> {
        use std::slice::from_ref;

        trace!("present_image");

        // The swapchain should have been written to, otherwise it would be noise and that's a panic
        let last_swapchain_access = render_graph
            .last_write(swapchain_image)
            .expect("uninitialized swapchain image: write something each frame!");
        let mut resolver = render_graph.resolve();
        let wait_dst_stage_mask = resolver.node_pipeline_stages(swapchain_image);
        let swapchain_node = swapchain_image;
        let swapchain_image = resolver.unbind_node(swapchain_node);
        let swapchain_image_idx = swapchain_image.idx as usize;

        while self.cmd_bufs.len() <= swapchain_image_idx {
            self.cmd_bufs.push([
                CommandBuffer::create(&self.device, self.device.queue.family)?,
                CommandBuffer::create(&self.device, self.device.queue.family)?,
                CommandBuffer::create(&self.device, self.device.queue.family)?,
            ]);
        }

        let cmd_bufs = &mut self.cmd_bufs[swapchain_image_idx];
        let cmd_buf = &mut cmd_bufs[0];

        let started = Instant::now();

        unsafe {
            Self::wait_for_fence(cmd_buf)?;
        }

        let mut wait_elapsed = Instant::now() - started;

        unsafe {
            Self::begin(cmd_buf)?;
        }

        resolver.record_node_dependencies(&mut *self.pool, cmd_buf, swapchain_node)?;

        unsafe {
            trace!("submitting swapchain dependencies");

            // Record up to but not including the swapchain work
            Self::submit(
                cmd_buf,
                vk::SubmitInfo::builder().command_buffers(from_ref(cmd_buf)),
            )?;
        }

        // Switch commnd buffers because we're going to be submitting with a wait semaphore on the
        // swapchain image before we get access to record commands that use it
        let cmd_buf = &mut cmd_bufs[1];

        let wait_started = Instant::now();

        unsafe {
            Self::wait_for_fence(cmd_buf)?;
        }

        wait_elapsed += Instant::now() - wait_started;

        unsafe {
            Self::begin(cmd_buf)?;
        }

        resolver.record_node(&mut *self.pool, cmd_buf, swapchain_node)?;

        pipeline_barrier(
            &cmd_buf.device,
            **cmd_buf,
            None,
            &[],
            from_ref(&ImageBarrier {
                previous_accesses: from_ref(&last_swapchain_access),
                next_accesses: from_ref(&AccessType::Present),
                previous_layout: image_access_layout(last_swapchain_access),
                next_layout: ImageLayout::General,
                discard_contents: false,
                src_queue_family_index: cmd_buf.device.queue.family.idx,
                dst_queue_family_index: cmd_buf.device.queue.family.idx,
                image: **swapchain_image,
                range: vk::ImageSubresourceRange {
                    layer_count: 1,
                    aspect_mask: vk::ImageAspectFlags::COLOR,
                    base_array_layer: 0,
                    base_mip_level: 0,
                    level_count: 1,
                },
            }),
        );

        unsafe {
            trace!("submitting swapchain passes");

            Self::submit(
                cmd_buf,
                vk::SubmitInfo::builder()
                    .command_buffers(from_ref(cmd_buf))
                    .signal_semaphores(from_ref(&swapchain_image.rendered))
                    .wait_semaphores(from_ref(&swapchain_image.acquired))
                    .wait_dst_stage_mask(from_ref(&wait_dst_stage_mask)),
            )?;
        }

        let cmd_buf = &mut cmd_bufs[2];

        let wait_started = Instant::now();

        unsafe {
            Self::wait_for_fence(cmd_buf)?;
        }

        wait_elapsed += Instant::now() - wait_started;

        // We may have unresolved nodes; things like copies that happen after present or operations
        // before present which use nodes that are unused in the remainder of the graph.
        // These operations are still important, but they don't need to wait for any of the above
        // things so we do them last
        if !resolver.is_resolved() {
            unsafe {
                Self::begin(cmd_buf)?;
            }

            resolver.record_unscheduled_passes(&mut *self.pool, cmd_buf)?;

            unsafe {
                trace!("submitting unscheduled passes");

                Self::submit(
                    cmd_buf,
                    vk::SubmitInfo::builder().command_buffers(from_ref(cmd_buf)),
                )
            }?;
        }

        let elapsed = Instant::now() - started - wait_elapsed;
        trace!(
            "🔜🔜🔜 vkQueueSubmit took {} μs (delay {} μs)",
            elapsed.as_micros(),
            wait_elapsed.as_micros()
        );

        self.swapchain.present_image(swapchain_image);

        // Store the resolved graph because it contains bindings, leases, and other shared resources
        // that need to be kept alive until the fence is waited upon.
        CommandBuffer::push_fenced_drop(&mut self.cmd_bufs[swapchain_image_idx][2], resolver);

        Ok(())
    }

    unsafe fn submit(
        cmd_buf: &CommandBuffer,
        submit_info: vk::SubmitInfoBuilder<'_>,
    ) -> Result<(), ()> {
        use std::slice::from_ref;

        cmd_buf
            .device
            .end_command_buffer(**cmd_buf)
            .map_err(|_| ())?;
        cmd_buf
            .device
            .reset_fences(from_ref(&cmd_buf.fence))
            .map_err(|_| ())?;
        cmd_buf
            .device
            .queue_submit(
                *cmd_buf.device.queue,
                from_ref(&*submit_info),
                cmd_buf.fence,
            )
            .map_err(|_| ())
    }

    unsafe fn wait_for_fence(cmd_buf: &mut CommandBuffer) -> Result<(), ()> {
        Device::wait_for_fence(&cmd_buf.device, &cmd_buf.fence).map_err(|_| ())?;
        CommandBuffer::drop_fenced(cmd_buf);

        Ok(())
    }
}

impl Debug for Display {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str("Display")
    }
}

/// Describes error conditions relating to physical displays.
#[derive(Debug)]
pub enum DisplayError {
    /// Unrecoverable device error; must destroy this device and display and start a new one
    DeviceLost,

    /// Recoverable driver error
    Driver(DriverError),
}

impl Error for DisplayError {}

impl From<()> for DisplayError {
    fn from(_: ()) -> Self {
        Self::DeviceLost
    }
}

impl From<DriverError> for DisplayError {
    fn from(err: DriverError) -> Self {
        Self::Driver(err)
    }
}

impl From<SwapchainError> for DisplayError {
    fn from(_: SwapchainError) -> Self {
        Self::DeviceLost
    }
}

impl std::fmt::Display for DisplayError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self)
    }
}