byte-engine-ghi 0.1.0

Graphics hardware interface layer used by Byte-Engine.
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

//! # Render Debugger
//!
//! Connects the engine to a render debugger for frame capture and analysis.

#[cfg(target_os = "linux")]
use renderdoc::{RenderDoc, V141};

/// The `RenderDebugger` struct provides a backend-independent frame-capture boundary.
///
/// The current implementation supports RenderDoc.
pub struct RenderDebugger {
	#[cfg(target_os = "linux")]
	renderdoc: Option<RenderDoc<V141>>,
}

impl RenderDebugger {
	/// Detects an available render debugger and connects to it.
	pub fn new() -> RenderDebugger {
		#[cfg(target_os = "linux")]
		{
			let renderdoc = RenderDoc::new().ok();
			RenderDebugger { renderdoc }
		}

		#[cfg(not(target_os = "linux"))]
		{
			RenderDebugger {}
		}
	}

	/// Starts a frame capture on the render debugger.
	pub fn start_frame_capture(&mut self) {
		#[cfg(target_os = "linux")]
		if let Some(renderdoc) = self.renderdoc.as_mut() {
			renderdoc.start_frame_capture(std::ptr::null_mut(), std::ptr::null_mut());
		}
	}

	/// Ends a frame capture on the render debugger.
	pub fn end_frame_capture(&mut self) {
		#[cfg(target_os = "linux")]
		if let Some(renderdoc) = self.renderdoc.as_mut() {
			renderdoc.end_frame_capture(std::ptr::null_mut(), std::ptr::null_mut());
		}
	}
}