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
use crate::graph::{RenderGraphNodeId, RenderGraphResourceName};
use rafx_api::RafxResourceType;

/// Unique ID for a particular usage (read or write) of a specific buffer
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub struct RenderGraphBufferUsageId(pub(super) usize);

/// An ID for a buffer used within the graph between passes
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct VirtualBufferId(pub(super) usize);

/// An ID for a buffer allocation (possibly reused)
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct PhysicalBufferId(pub(super) usize);

/// Unique ID provided for any buffer registered as an output buffer
#[derive(Debug, Copy, Clone)]
pub struct RenderGraphOutputBufferId(pub(super) usize);

/// Unique ID for a particular version of a buffer. Any time a buffer is modified, a new version is
/// produced
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub struct RenderGraphBufferVersionId {
    pub(super) index: usize,
    pub(super) version: usize,
}

/// A "virtual" buffer that the render graph knows about. The render graph will allocate buffers as
/// needed, but can reuse the same buffer for multiple resources if the lifetimes of those buffers
/// don't overlap
#[derive(Debug)]
pub struct RenderGraphBufferResource {
    pub(super) name: Option<RenderGraphResourceName>,

    pub(super) versions: Vec<RenderGraphBufferResourceVersionInfo>,
}

impl RenderGraphBufferResource {
    pub(super) fn new() -> Self {
        RenderGraphBufferResource {
            name: None,
            versions: Default::default(),
        }
    }
}

/// Defines what created a RenderGraphBufferUsage
#[derive(Debug)]
pub enum RenderGraphBufferUser {
    Node(RenderGraphNodeId),
    Output(RenderGraphOutputBufferId),
}

/// A usage of a particular buffer
#[derive(Debug)]
pub struct RenderGraphBufferUsage {
    pub(super) user: RenderGraphBufferUser,
    pub(super) usage_type: RenderGraphBufferUsageType,
    pub(super) version: RenderGraphBufferVersionId,
}

/// Immutable, fully-specified attributes of a buffer. A *constraint* is partially specified and
/// the graph will use constraints to solve for the specification
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RenderGraphBufferSpecification {
    pub size: u64,
    pub resource_type: RafxResourceType,
}

impl RenderGraphBufferSpecification {
    /// Returns true if no fields in the two constraints are conflicting
    pub fn can_merge(
        &self,
        other: &RenderGraphBufferSpecification,
    ) -> bool {
        if self.size != other.size {
            return false;
        }

        true
    }

    /// Merge other's constraints into self, but only if there are no conflicts. No modification
    /// occurs if any conflict exists
    pub fn try_merge(
        &mut self,
        other: &RenderGraphBufferSpecification,
    ) -> bool {
        if !self.can_merge(other) {
            return false;
        }

        self.resource_type |= other.resource_type;

        true
    }
}

/// Constraints on a buffer. Constraints are set per-field and start out None (i.e. unconstrained)
/// The rendergraph will derive specifications from the constraints
#[derive(Clone, Debug)]
pub struct RenderGraphBufferConstraint {
    // Rename to RenderGraphBufferUsageConstraint?
    pub size: Option<u64>,
    pub resource_type: RafxResourceType,
}

impl Default for RenderGraphBufferConstraint {
    fn default() -> Self {
        RenderGraphBufferConstraint {
            size: None,
            resource_type: RafxResourceType::UNDEFINED,
        }
    }
}

impl From<RenderGraphBufferSpecification> for RenderGraphBufferConstraint {
    fn from(specification: RenderGraphBufferSpecification) -> Self {
        RenderGraphBufferConstraint {
            size: Some(specification.size),
            resource_type: specification.resource_type,
        }
    }
}

impl RenderGraphBufferConstraint {
    pub fn try_convert_to_specification(self) -> Option<RenderGraphBufferSpecification> {
        // Format is the only thing we can't default sensibly
        if self.size.is_none() {
            None
        } else {
            Some(RenderGraphBufferSpecification {
                size: self.size.unwrap(),
                resource_type: self.resource_type,
            })
        }
    }
}

impl RenderGraphBufferConstraint {
    /// Returns true if no fields in the two constraints are conflicting
    pub fn can_merge(
        &self,
        other: &RenderGraphBufferConstraint,
    ) -> bool {
        if self.size.is_some() && other.size.is_some() && self.size != other.size {
            return false;
        }

        true
    }

    /// Merge other's constraints into self, but only if there are no conflicts. No modification
    /// occurs if any conflict exists
    pub fn try_merge(
        &mut self,
        other: &RenderGraphBufferConstraint,
    ) -> bool {
        if !self.can_merge(other) {
            return false;
        }

        if self.size.is_none() && other.size.is_some() {
            self.size = other.size;
        }

        self.resource_type |= other.resource_type;

        true
    }

    /// Merge other's constraints into self. We will merge fields where we can and skip fields with
    /// conflicts
    pub fn partial_merge(
        &mut self,
        other: &RenderGraphBufferConstraint,
    ) -> bool {
        let mut complete_merge = true;

        if self.size.is_some() && other.size.is_some() && self.size != other.size {
            complete_merge = false;
        } else if other.size.is_some() {
            self.size = other.size;
        }

        self.resource_type |= other.resource_type;

        complete_merge
    }

    /// Sets the constraints based on the given specification
    pub fn set(
        &mut self,
        other: &RenderGraphBufferSpecification,
    ) {
        *self = other.clone().into();
    }
}

/// How a buffer is being used
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum RenderGraphBufferUsageType {
    Create,
    //Input,
    Read,
    ModifyRead,
    ModifyWrite,
    Output,
}

impl RenderGraphBufferUsageType {
    //TODO: Add support to see if multiple writes actually overlap
    pub fn is_read_only(&self) -> bool {
        match self {
            RenderGraphBufferUsageType::Read => true,
            RenderGraphBufferUsageType::Output => true,
            RenderGraphBufferUsageType::ModifyRead => false,
            RenderGraphBufferUsageType::Create => false,
            // RenderGraphBufferUsageType::Input => false,
            RenderGraphBufferUsageType::ModifyWrite => false,
        }
    }
}

/// Information about a specific version of the buffer.
#[derive(Debug)]
pub struct RenderGraphBufferResourceVersionInfo {
    /// What node created the buffer (keep in mind these are virtual buffers, not buffers provided
    /// from outside the graph. So every buffer will have a creator node)
    pub(super) creator_node: RenderGraphNodeId,

    pub(super) create_usage: RenderGraphBufferUsageId,
    pub(super) read_usages: Vec<RenderGraphBufferUsageId>,
}

impl RenderGraphBufferResourceVersionInfo {
    pub(super) fn new(
        creator: RenderGraphNodeId,
        create_usage: RenderGraphBufferUsageId,
    ) -> Self {
        RenderGraphBufferResourceVersionInfo {
            creator_node: creator,
            create_usage,
            read_usages: Default::default(),
        }
    }

    pub(super) fn add_read_usage(
        &mut self,
        usage: RenderGraphBufferUsageId,
    ) {
        self.read_usages.push(usage);
    }
}