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

//! Frame module docs.


use crate::{command::Fence, factory::Factory};

/// Fences collection.

pub type Fences<B> = smallvec::SmallVec<[Fence<B>; 8]>;

/// Single frame rendering task.

/// Command buffers can be submitted as part of the `Frame`.

#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
#[allow(missing_copy_implementations)]
pub struct Frame {
    index: u64,
}

impl Frame {
    /// Create frame with specific index.

    pub fn with_index(index: u64) -> Self {
        Frame { index }
    }

    /// Get frame index.

    pub fn index(&self) -> u64 {
        self.index
    }
}

/// Proof that frame is complete.

#[derive(Debug)]
#[allow(missing_copy_implementations)]
pub struct CompleteFrame {
    index: u64,
}

impl CompleteFrame {
    /// Get frame index.

    pub fn index(&self) -> u64 {
        self.index
    }
}

/// Complete - next frame range.

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FramesRange {
    next: u64,
    complete_upper_bound: u64,
}

impl FramesRange {
    /// Check if given frame is.

    pub fn is_complete(&self, frame: Frame) -> bool {
        self.complete_upper_bound > frame.index
    }

    /// Check if given frame is.

    pub fn complete(&self, frame: Frame) -> Option<CompleteFrame> {
        if self.complete_upper_bound > frame.index {
            Some(CompleteFrame { index: frame.index })
        } else {
            None
        }
    }

    /// Get next frame

    pub fn next(&self) -> Frame {
        Frame { index: self.next }
    }
}

/// Timeline of frames, complete, pending and next.

#[derive(Debug)]
pub struct Frames<B: rendy_core::hal::Backend> {
    pending: std::collections::VecDeque<Fences<B>>,
    next: u64,
}

impl<B> Frames<B>
where
    B: rendy_core::hal::Backend,
{
    /// Create new `Frames` instance.

    pub fn new() -> Self {
        Frames {
            pending: Default::default(),
            next: 0,
        }
    }

    /// Get next frame reference.

    pub fn next(&self) -> Frame {
        Frame { index: self.next }
    }

    /// Advance to the next frame.

    /// All fences of the next frame must be queued.

    pub fn advance(&mut self, fences: Fences<B>) {
        assert!(fences.iter().all(Fence::is_submitted));
        self.pending.push_back(fences);
        self.next += 1;
    }

    /// Get upper bound of complete frames.

    /// All frames with index less than result of this function are complete.

    pub fn complete_upper_bound(&self) -> u64 {
        debug_assert!(self.pending.len() as u64 <= self.next);
        self.next - self.pending.len() as u64
    }

    /// Check if given frame is.

    pub fn is_complete(&self, frame: Frame) -> bool {
        self.complete_upper_bound() > frame.index
    }

    /// Check if frame with specified index is complete.

    pub fn complete(&self, frame: Frame) -> Option<CompleteFrame> {
        if self.complete_upper_bound() > frame.index {
            Some(CompleteFrame { index: frame.index })
        } else {
            None
        }
    }

    /// Wait for completion of the frames until specified (inclusive)

    /// Returns proof.

    ///

    /// # Parameters

    ///

    /// `target` - frame that must complete.

    /// `factory` - The factory.

    ///

    /// # Panics

    ///

    /// This function will panic if `target` is greater than or equal to next frame.

    pub fn wait_complete(
        &mut self,
        target: Frame,
        factory: &Factory<B>,
        free: impl FnMut(Fences<B>),
    ) -> CompleteFrame {
        assert!(target.index <= self.next);
        if let Some(complete) = self.complete(target) {
            complete
        } else {
            // n - p <= t

            // p - n + t + 1 >= 1

            // count >= 1

            let count = self.pending.len() - (self.next - target.index - 1) as usize;
            let ready = factory.wait_for_fences(
                self.pending.iter_mut().take(count).flatten(),
                rendy_core::hal::device::WaitFor::All,
                !0,
            );
            assert_eq!(ready, Ok(true));
            self.pending.drain(..count).for_each(free);
            CompleteFrame {
                index: target.index,
            }
        }
    }

    /// Dispose of the `Frames`

    pub fn dispose(mut self, factory: &mut Factory<B>) {
        let ready = factory.wait_for_fences(
            self.pending.iter_mut().flatten(),
            rendy_core::hal::device::WaitFor::All,
            !0,
        );
        assert_eq!(ready, Ok(true));

        self.pending
            .drain(..)
            .flatten()
            .for_each(|fence| factory.destroy_fence(fence));
    }

    /// Get range of frame indices in this form:

    /// `upper bound of finished frames .. next frame`.

    pub fn range(&self) -> FramesRange {
        FramesRange {
            next: self.next,
            complete_upper_bound: self.complete_upper_bound(),
        }
    }
}