dear-imgui-wgpu 0.17.0

WGPU renderer backend for dear-imgui-rs (native + WebAssembly)
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

use super::resource::ManagedWgpuTexture;
use super::*;

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub(super) enum ManagedRequestOutcome {
    Uploaded(TextureId),
    Destroyed,
    Superseded,
}

impl WgpuTextureManager {
    pub(crate) fn handle_texture_requests(
        &mut self,
        requests: &[TextureRequest],
        request_epoch: u64,
        device: &Device,
        queue: &Queue,
        render_resources: &mut RenderResources,
    ) -> RendererResult<Vec<TextureFeedback>> {
        let mut feedback = Vec::with_capacity(requests.len());
        for request in requests {
            match self.apply_managed_request_at_epoch(
                request.texture(),
                request.operation(),
                request_epoch,
                device,
                queue,
                render_resources,
            )? {
                ManagedRequestOutcome::Uploaded(texture_id) => {
                    feedback.push(request.uploaded(texture_id)?);
                }
                ManagedRequestOutcome::Destroyed => feedback.push(request.destroyed()?),
                ManagedRequestOutcome::Superseded => feedback.push(request.superseded()),
            }
        }
        Ok(feedback)
    }

    pub(super) fn apply_managed_request_at_epoch(
        &mut self,
        id: SnapshotTextureId,
        operation: &TextureOp,
        request_epoch: u64,
        device: &Device,
        queue: &Queue,
        render_resources: &mut RenderResources,
    ) -> RendererResult<ManagedRequestOutcome> {
        match operation {
            TextureOp::Create {
                format,
                width,
                height,
                row_pitch,
                pixels,
            } => {
                if self.destroyed_managed_textures.contains_key(&id) {
                    // A delayed create must not resurrect a resource after its destroy request.
                    return Ok(ManagedRequestOutcome::Superseded);
                }
                let texture_id = if let Some(existing) = self.managed_textures.get(&id) {
                    let texture_id = existing.texture_id;
                    self.upload_managed_texture_contents(
                        queue,
                        id,
                        *format,
                        [*width, *height],
                        *row_pitch,
                        pixels,
                    )?;
                    texture_id
                } else {
                    let resource = Self::create_managed_texture_resource(
                        device, queue, *format, *width, *height, *row_pitch, pixels,
                    )?;
                    let texture_id = self.allocate_managed_texture_id()?;
                    self.managed_textures.insert(
                        id,
                        ManagedWgpuTexture {
                            texture_id,
                            width: *width,
                            height: *height,
                            resource,
                        },
                    );
                    self.managed_by_texture_id.insert(texture_id, id);
                    texture_id
                };
                Ok(ManagedRequestOutcome::Uploaded(texture_id))
            }
            TextureOp::Update {
                format,
                width,
                height,
                rects,
            } => {
                if self.destroyed_managed_textures.contains_key(&id) {
                    return Ok(ManagedRequestOutcome::Superseded);
                }
                self.update_managed_texture(queue, id, *format, *width, *height, rects)?;
                let texture_id = self
                    .managed_texture_id(id)
                    .ok_or(RendererError::ManagedTextureMissing(id))?;
                Ok(ManagedRequestOutcome::Uploaded(texture_id))
            }
            TextureOp::Destroy => {
                self.destroyed_managed_textures
                    .entry(id)
                    .and_modify(|destroy_epoch| {
                        *destroy_epoch = (*destroy_epoch).max(request_epoch);
                    })
                    .or_insert(request_epoch);
                if let Some(entry) = self.managed_textures.remove(&id) {
                    self.managed_by_texture_id.remove(&entry.texture_id);
                    render_resources.remove_image_bind_group(entry.texture_id);
                }
                // Repeated destroy requests are intentionally acknowledged even after the GPU
                // resource is gone. The Context may be retrying feedback from an abandoned epoch.
                Ok(ManagedRequestOutcome::Destroyed)
            }
        }
    }

    #[cfg(test)]
    pub(super) fn apply_managed_request(
        &mut self,
        id: SnapshotTextureId,
        operation: &TextureOp,
        device: &Device,
        queue: &Queue,
        render_resources: &mut RenderResources,
    ) -> RendererResult<ManagedRequestOutcome> {
        self.apply_managed_request_at_epoch(id, operation, 0, device, queue, render_resources)
    }
}