diene-engine-runtime 0.1.0

Runtime application builder and renderer backend selection for Diene.
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! Engine runtime with renderer backend selection policy.

#![forbid(unsafe_code)]

use common::logging::macros::{debug, info};
use engine_core::app::{ApplicationHost, ApplicationHostBuildError, ApplicationHostError, WindowError};
use engine_renderer_api::{BoxedRenderer, RenderWindow, RendererFactory};
use engine_renderer_vulkan::renderer::{VulkanRendererBuilder, VulkanRendererError};
use thiserror::Error;

/// Errors returned by the public application runtime.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ApplicationError {
    /// Renderer backend operation failed.
    #[error("renderer failed: {0}")]
    Renderer(#[source] VulkanRendererError),

    /// Window or event loop operation failed.
    #[error("window failed: {0}")]
    Window(#[from] WindowError),

    /// Application configuration is invalid.
    #[error("application build failed: {0}")]
    Build(#[from] ApplicationHostBuildError),
}

impl From<ApplicationHostError<VulkanRendererError>> for ApplicationError {
    fn from(error: ApplicationHostError<VulkanRendererError>) -> Self {
        match error {
            ApplicationHostError::Renderer(error) => Self::Renderer(error),
            ApplicationHostError::Window(error) => Self::Window(error),
            ApplicationHostError::Build(error) => Self::Build(error),
        }
    }
}

/// Renderer backend selection mode.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
#[non_exhaustive]
pub enum RendererBackend {
    /// Chooses the best supported backend compiled into this binary.
    #[default]
    Auto,

    /// Forces the Vulkan backend.
    Vulkan,
}

/// Public engine application that owns renderer backend selection policy.
#[derive(Debug)]
pub struct Application {
    host: RuntimeApplicationHost,
}

type RuntimeApplicationHost = ApplicationHost<RendererBackendSelector>;

/// Configures an [`Application`].
#[derive(Debug, Default)]
pub struct ApplicationBuilder {
    name: Option<String>,
    renderer_backend: RendererBackend,
    vsync: bool,
}

impl ApplicationBuilder {
    /// Sets the human-readable application name.
    #[must_use]
    pub fn with_name(mut self, name: impl Into<String>) -> Self {
        self.name = Some(name.into());
        self
    }

    /// Selects the renderer backend policy.
    #[must_use]
    pub fn with_renderer_backend(mut self, backend: RendererBackend) -> Self {
        self.renderer_backend = backend;
        self
    }

    /// Enables or disables vertical synchronization.
    #[must_use]
    pub fn with_vsync(mut self, on: bool) -> Self {
        self.vsync = on;
        self
    }

    /// Builds the application.
    pub fn build(self) -> Result<Application, ApplicationError> {
        debug!("building runtime application with backend {:?}", self.renderer_backend);

        let selector = RendererBackendSelector { renderer_backend: self.renderer_backend, vsync: self.vsync };

        let mut builder = ApplicationHost::builder(selector);

        if let Some(name) = self.name {
            builder = builder.with_name(name);
        }

        Ok(Application { host: builder.build()? })
    }
}

impl Application {
    /// Creates a builder for configuring an [`Application`].
    pub fn builder() -> ApplicationBuilder {
        ApplicationBuilder::default()
    }

    /// Returns the human-readable application name.
    pub fn name(&self) -> &str {
        self.host.name()
    }

    /// Runs the application until the event loop exits.
    pub fn run(self) -> Result<(), ApplicationError> {
        self.host.run().map_err(Into::into)
    }
}

#[derive(Clone, Copy, Debug)]
struct RendererBackendSelector {
    renderer_backend: RendererBackend,
    vsync: bool,
}

impl RendererFactory for RendererBackendSelector {
    type Error = VulkanRendererError;

    fn create_renderer(&mut self, window: &dyn RenderWindow) -> Result<BoxedRenderer<Self::Error>, Self::Error> {
        match self.renderer_backend {
            RendererBackend::Auto | RendererBackend::Vulkan => {
                info!(
                    "selected renderer backend vulkan with {} policy",
                    if matches!(self.renderer_backend, RendererBackend::Auto) {
                        "auto"
                    } else {
                        "forced"
                    }
                );
                create_vulkan_renderer(window, self.vsync)
            }
        }
    }
}

fn create_vulkan_renderer(window: &dyn RenderWindow, vsync: bool) -> Result<BoxedRenderer<VulkanRendererError>, VulkanRendererError> {
    debug!("creating vulkan renderer");

    let renderer = VulkanRendererBuilder::default().with_vsync(vsync).build(window)?;

    Ok(Box::new(renderer))
}