zenfg 0.1.0

A FrameGraph compiler and transient-resource executor for wgpu
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

use core::ops::Range;

use crate::{
    AccessId, AccessMode, AccessRole, BufferDesc, DebugGroupId, NodeKind, PassId,
    ResourceDescriptor, ResourceId, ResourceKind, ResourceOrigin, ResourceRange, RootReason,
    TextureDesc, TextureSubresourceRange, TextureViewDesc, ValueId, ViewId,
};

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum NormalizedRange {
    Buffer(Range<u64>),
    Texture(Vec<TextureSubresourceRange>),
}

impl NormalizedRange {
    pub(crate) fn report(&self) -> ResourceRange {
        match self {
            Self::Buffer(range) => ResourceRange::Buffer(crate::BufferRange::new(
                range.start,
                range.end - range.start,
            )),
            Self::Texture(regions) => ResourceRange::Texture(regions.clone()),
        }
    }

    pub(crate) fn overlaps(&self, other: &Self) -> bool {
        match (self, other) {
            (Self::Buffer(a), Self::Buffer(b)) => a.start < b.end && b.start < a.end,
            (Self::Texture(a), Self::Texture(b)) => a.iter().any(|left| {
                b.iter().any(|right| {
                    left.base_mip_level == right.base_mip_level
                        && left.aspect == right.aspect
                        && left.base_slice < right.base_slice + right.slice_count
                        && right.base_slice < left.base_slice + left.slice_count
                })
            }),
            _ => false,
        }
    }

    pub(crate) fn is_empty(&self) -> bool {
        match self {
            Self::Buffer(range) => range.is_empty(),
            Self::Texture(regions) => regions.iter().all(|region| region.slice_count == 0),
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct ResourceRecord {
    pub id: ResourceId,
    pub origin: ResourceOrigin,
    pub initial_contents: crate::InitialContents,
    pub descriptor: ResourceDescriptor,
    pub exposed_texture_usage: Option<wgpu::TextureUsages>,
    pub exposed_buffer_usage: Option<wgpu::BufferUsages>,
    pub debug_group: Option<DebugGroupId>,
}

impl ResourceRecord {
    pub(crate) fn kind(&self) -> ResourceKind {
        match self.descriptor {
            ResourceDescriptor::Texture(_) => ResourceKind::Texture,
            ResourceDescriptor::Buffer(_) => ResourceKind::Buffer,
        }
    }

    pub(crate) fn label(&self) -> &str {
        match &self.descriptor {
            ResourceDescriptor::Texture(desc) => &desc.label,
            ResourceDescriptor::Buffer(desc) => &desc.label,
        }
    }

    pub(crate) fn texture(&self) -> Option<&TextureDesc> {
        match &self.descriptor {
            ResourceDescriptor::Texture(desc) => Some(desc),
            ResourceDescriptor::Buffer(_) => None,
        }
    }

    pub(crate) fn buffer(&self) -> Option<&BufferDesc> {
        match &self.descriptor {
            ResourceDescriptor::Buffer(desc) => Some(desc),
            ResourceDescriptor::Texture(_) => None,
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct ViewRecord {
    pub id: ViewId,
    pub texture: ResourceId,
    pub descriptor: TextureViewDesc,
    pub range: NormalizedRange,
}

#[derive(Clone, Debug)]
pub(crate) struct AccessRecord {
    pub id: AccessId,
    pub pass: PassId,
    pub resource: ResourceId,
    pub role: AccessRole,
    pub mode: AccessMode,
    pub consumes_previous: bool,
    pub produces_value: bool,
    pub range: NormalizedRange,
    pub view: Option<ViewId>,
    pub value: Option<ValueId>,
}

#[derive(Clone, Debug)]
pub(crate) struct NodeRecord {
    pub id: PassId,
    pub kind: NodeKind,
    pub label: String,
    pub side_effect: bool,
    pub accesses: Vec<AccessRecord>,
    pub debug_group: Option<DebugGroupId>,
}

#[derive(Clone, Debug)]
pub(crate) struct DebugGroupRecord {
    pub id: DebugGroupId,
    pub parent: Option<DebugGroupId>,
    pub label: String,
}

#[derive(Clone, Debug)]
pub(crate) struct RootRecord {
    pub resource: ResourceId,
    pub reason: RootReason,
    pub range: NormalizedRange,
}