rend3 0.3.0

Easy to use, customizable, efficient 3D renderer library built on 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

//! Output frame and surface acquisition.

use std::sync::Arc;
use wgpu::{SurfaceError, SurfaceTexture, TextureView, TextureViewDescriptor};

use crate::types::Surface;

/// Anything that resembles a surface to render to.
pub enum OutputFrame {
    // A surface which has not yet been acquired. This lets rend3 acquire as late as possible.
    Surface {
        surface: Arc<Surface>,
    },
    // Pre-acquired surface. rend3 will present it.
    SurfaceAcquired {
        view: TextureView,
        surface_tex: SurfaceTexture,
    },
    // Arbitrary texture view.
    View(Arc<TextureView>),
}

impl OutputFrame {
    /// If needed, acquire the surface. If the frame is Surface, after this call
    /// it will be SurfaceAcquired.
    pub fn acquire(&mut self) -> Result<(), SurfaceError> {
        if let Self::Surface { surface } = self {
            profiling::scope!("OutputFrame::acquire");
            let mut retrieved_frame = None;
            for _ in 0..10 {
                profiling::scope!("Inner Acquire Loop");
                match surface.get_current_texture() {
                    Ok(frame) => {
                        retrieved_frame = Some(frame);
                        break;
                    }
                    Err(SurfaceError::Timeout) => {}
                    Err(e) => return Err(e),
                }
            }
            let surface_tex = retrieved_frame.expect("Swapchain acquire timed out 10 times.");

            let view = surface_tex.texture.create_view(&TextureViewDescriptor::default());

            *self = Self::SurfaceAcquired { view, surface_tex }
        }

        Ok(())
    }

    /// Turn the given surface into a texture view, if it has one.
    pub fn as_view(&self) -> Option<&TextureView> {
        match self {
            Self::Surface { .. } => None,
            Self::SurfaceAcquired { view, .. } => Some(view),
            Self::View(inner) => Some(&**inner),
        }
    }

    /// Present the surface, if needed.
    pub fn present(self) {
        if let Self::SurfaceAcquired {
            surface_tex: surface, ..
        } = self
        {
            surface.present();
        }
    }
}