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

use math::Matrix4;
use utils::Extent;

use crate::rendering::view::View;

/// The `Sink` struct provides a per-frame render destination for a resolved camera view.
///
/// It keeps the view transform, renderable extent, and renderer sink index
/// together while scene managers and render passes prepare an output surface.
#[derive(Debug, Clone, Copy)]
pub struct Sink {
	view: View,
	extent: Extent,
	index: usize,
}

impl Sink {
	/// Creates a sink for render passes that target a specific view and extent.
	pub fn new(view: View, extent: Extent, index: usize) -> Self {
		Self { view, extent, index }
	}

	/// Returns the camera or light view used by this render target.
	pub fn view(&self) -> View {
		self.view
	}

	/// Returns the pixel extent available to render passes for this sink.
	pub fn extent(&self) -> Extent {
		self.extent
	}

	/// Returns the combined projection and view matrix for shader setup.
	pub fn view_projection(&self) -> Matrix4 {
		self.view.view_projection()
	}

	/// Returns the renderer-local sink index.
	pub fn index(&self) -> usize {
		self.index
	}
}

#[cfg(test)]
mod tests {
	use math::Vector3;

	use super::*;

	#[test]
	fn sink_keeps_view_extent_index_and_derived_matrix_consistent() {
		let view = View::new_perspective(
			60.0,
			16.0 / 9.0,
			0.1,
			500.0,
			Vector3::new(0.0, 0.0, 0.0),
			Vector3::new(0.0, 0.0, 1.0),
		);
		let extent = Extent::rectangle(1_920, 1_080);
		let sink = Sink::new(view, extent, 3);

		assert_eq!(sink.view(), view);
		assert_eq!(sink.extent(), extent);
		assert_eq!(sink.index(), 3);
		assert_eq!(sink.view_projection(), view.view_projection());
	}
}