byte-engine 0.1.0

A composable Rust game engine focused on graphics, input, audio, physics, and retained UI.
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

use std::error::Error;
use std::fmt::{Display, Formatter};

/// Initializes Tracy profiling for applications built on Byte-Engine.
///
/// Call this function before creating the application. The `log` and `tracing`
/// crates allow only one global collector per process.
#[cfg(feature = "tracy")]
pub fn setup_tracy() -> Result<(), TracySetupError> {
	use tracing_subscriber::layer::SubscriberExt;

	// Bridge `log` records into `tracing` events so the Tracy layer receives engine logs too.
	tracing_log::LogTracer::init().map_err(TracySetupError::LogTracer)?;

	let subscriber = tracing_subscriber::registry()
		.with(tracing_subscriber::fmt::layer())
		.with(tracing_tracy::TracyLayer::default());

	tracing::subscriber::set_global_default(subscriber).map_err(TracySetupError::Subscriber)
}

/// Initializes Tracy profiling for applications built on Byte-Engine.
///
/// Enable the `tracy` Cargo feature on `byte-engine` to export spans and logs to Tracy.
#[cfg(not(feature = "tracy"))]
pub fn setup_tracy() -> Result<(), TracySetupError> {
	Err(TracySetupError::Disabled)
}

#[derive(Debug)]
pub enum TracySetupError {
	#[cfg(not(feature = "tracy"))]
	Disabled,
	#[cfg(feature = "tracy")]
	LogTracer(log::SetLoggerError),
	#[cfg(feature = "tracy")]
	Subscriber(tracing::subscriber::SetGlobalDefaultError),
}

impl Display for TracySetupError {
	fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
		match self {
			#[cfg(not(feature = "tracy"))]
			Self::Disabled => formatter.write_str(
				"Failed to set up Tracy profiling. The most likely cause is that byte-engine was built without the `tracy` feature.",
			),
			#[cfg(feature = "tracy")]
			Self::LogTracer(_) => formatter.write_str(
				"Failed to set up Tracy log export. The most likely cause is that another logger was initialized before Tracy setup.",
			),
			#[cfg(feature = "tracy")]
			Self::Subscriber(_) => formatter.write_str(
				"Failed to set up Tracy trace export. The most likely cause is that another tracing subscriber was initialized before Tracy setup.",
			),
		}
	}
}

impl Error for TracySetupError {
	fn source(&self) -> Option<&(dyn Error + 'static)> {
		match self {
			#[cfg(not(feature = "tracy"))]
			Self::Disabled => None,
			#[cfg(feature = "tracy")]
			Self::LogTracer(error) => Some(error),
			#[cfg(feature = "tracy")]
			Self::Subscriber(error) => Some(error),
		}
	}
}