raindrop/crates/engine/src/main.rs
2025-04-01 14:22:04 -04:00

532 lines
18 KiB
Rust

use std::{
error::Error,
ffi::{c_char, CStr, CString},
fs::OpenOptions,
sync::Arc,
time::{Duration, Instant},
};
use ash::vk;
use clap::Parser;
use egui::{Context, ViewportId};
use egui_winit::State;
use gfx_hal::{
device::Device, error::GfxHalError, instance::Instance, instance::InstanceConfig,
physical_device::PhysicalDevice, queue::Queue, surface::Surface,
};
use raw_window_handle::HasDisplayHandle;
use renderer::{Renderer, RendererError};
use resource_manager::{ResourceManager, ResourceManagerError};
use tracing::{debug, error, info, warn};
use tracing_subscriber::{filter, layer::SubscriberExt, util::SubscriberInitExt, Layer};
use winit::{
application::ApplicationHandler,
event::WindowEvent,
event_loop::{ActiveEventLoop, EventLoop},
window::Window,
};
// --- Configuration ---
const APP_NAME: &str = "BeginDisregard";
const ENGINE_NAME: &str = "Engine";
// --- Error Handling ---
#[derive(Debug, thiserror::Error)]
enum AppError {
#[error("Window Creation Error: {0}")]
WindowCreation(#[from] winit::error::OsError),
#[error("Graphics HAL Error: {0}")]
GfxHal(#[from] GfxHalError),
#[error("Resource Manager Error: {0}")]
ResourceManager(#[from] ResourceManagerError),
#[error("Renderer Error: {0}")]
Renderer(#[from] RendererError),
#[error("Suitable physical device not found")]
NoSuitableDevice,
#[error("Failed to create CString: {0}")]
NulError(#[from] std::ffi::NulError),
}
struct Application {
_instance: Arc<Instance>, // Keep instance alive
_physical_device: PhysicalDevice, // Keep info, though Device holds handle
_device: Arc<Device>,
_graphics_queue: Arc<Queue>,
_surface: Arc<Surface>,
// Resource Management
_resource_manager: Arc<ResourceManager>,
// Renderer
renderer: Renderer,
egui_ctx: Context,
egui_winit: State,
egui_app: EditorUI,
// Windowing
window: Arc<Window>, // Use Arc for potential multi-threading later
frame_count: u32,
last_fps_update_time: Instant,
last_frame_time: Instant,
}
#[derive(Default)]
struct EditorUI {}
impl EditorUI {
fn title() -> String {
"engine".to_string()
}
fn build_ui(&mut self, ctx: &egui::Context) {
egui::Window::new(Self::title()).show(ctx, |ui| ui.label(Self::title()));
}
}
#[derive(Default)]
struct ApplicationWrapper {
app: Option<Application>,
}
impl ApplicationHandler for ApplicationWrapper {
fn resumed(&mut self, event_loop: &ActiveEventLoop) {
let window = Arc::new(
event_loop
.create_window(
Window::default_attributes()
.with_title(format!("{} - {}", ENGINE_NAME, APP_NAME,)),
)
.expect("Windows to be able to be created"),
);
self.app = Some(Application::new(window).expect("Unable to create the Application."));
}
fn window_event(
&mut self,
event_loop: &ActiveEventLoop,
_window_id: winit::window::WindowId,
event: WindowEvent,
) {
if let Some(app) = &mut self.app {
app.handle_event(&event, event_loop);
}
}
}
impl Application {
fn new(window: Arc<Window>) -> Result<Self, AppError> {
info!("Initializing Application...");
// --- 1. gfx_hal Setup ---
let instance_extensions =
ash_window::enumerate_required_extensions(window.display_handle().unwrap().into())
.unwrap();
let instance_extensions_c: Vec<CString> = instance_extensions
.iter()
.map(|&ptr| {
// Safety: We are trusting that the pointers returned by
// ash_window::enumerate_required_extensions are valid, non-null,
// null-terminated C strings. This is a standard assumption when
// working with C APIs via FFI.
unsafe {
// 1. Create a borrowed CStr reference from the raw pointer.
let c_str = CStr::from_ptr(ptr as *const c_char); // Cast is optional but common
// 2. Convert the borrowed CStr into an owned CString.
c_str.to_owned()
}
})
.collect();
let instance_config = InstanceConfig {
application_name: APP_NAME.to_string(),
engine_name: ENGINE_NAME.to_string(),
enable_validation: cfg!(debug_assertions), // Enable validation in debug
..Default::default()
};
let instance = Instance::new(
&instance_config,
&window.display_handle().unwrap(),
&instance_extensions_c, // Pass external extensions
)?;
info!("Vulkan Instance created.");
let surface = unsafe {
// Need unsafe for create_surface
instance.create_surface(window.as_ref())? // Pass window ref
};
info!("Vulkan Surface created.");
// --- 2. Physical Device Selection ---
let required_device_extensions =
[ash::khr::swapchain::NAME, ash::khr::dynamic_rendering::NAME];
let required_device_extensions_cstr: Vec<&CStr> = required_device_extensions
.iter()
.map(|s| CStr::from_bytes_with_nul(s.to_bytes_with_nul()).unwrap())
.collect();
// Define required features (Dynamic Rendering is crucial)
let required_dynamic_rendering_features =
vk::PhysicalDeviceDynamicRenderingFeaturesKHR::default().dynamic_rendering(true);
// Chain other required features if necessary (e.g., mesh shader)
// let mut required_mesh_shader_features = vk::PhysicalDeviceMeshShaderFeaturesEXT::builder()...
// required_dynamic_rendering_features = required_dynamic_rendering_features.push_next(&mut required_mesh_shader_features);
let physical_devices = unsafe { instance.enumerate_physical_devices()? };
let (physical_device, queue_family_indices) = physical_devices
.into_iter()
.find_map(|pd| {
match find_suitable_device_and_queues(
&pd,
&surface,
&required_device_extensions_cstr,
) {
Ok(indices) => Some((pd, indices)),
Err(e) => {
warn!(
"Skipping physical device {:?}: {}",
unsafe {
instance
.ash_instance()
.get_physical_device_properties(pd.handle())
.device_name_as_c_str()
},
e
);
None
}
}
})
.ok_or(AppError::NoSuitableDevice)?;
let pd_props = unsafe {
instance
.ash_instance()
.get_physical_device_properties(physical_device.handle())
};
info!(
"Selected Physical Device: {}",
pd_props.device_name_as_c_str().unwrap().to_string_lossy()
);
debug!("Using Queue Families: {:?}", queue_family_indices);
// --- 3. Logical Device and Queues ---
// Enable required features
let enabled_features = vk::PhysicalDeviceFeatures::default(); // Add base features if needed
let enabled_buffer_device_address =
vk::PhysicalDeviceBufferDeviceAddressFeatures::default().buffer_device_address(true);
let enabled_dynamic_rendering = required_dynamic_rendering_features; // Copy the builder state
let device = unsafe {
// Need unsafe for create_logical_device
physical_device.create_logical_device(
&required_device_extensions_cstr,
&queue_family_indices,
&enabled_features,
None,
&enabled_dynamic_rendering, // Pass features to enable
&enabled_buffer_device_address,
)?
};
let device_handle_at_creation = device.raw().handle();
info!(
"App: Created Device handle: {:?}",
device_handle_at_creation
);
// Get specific queues (assuming graphics and present are the same for simplicity)
let graphics_queue = device.get_graphics_queue();
let queue_associated_device_handle = graphics_queue.device().raw().handle();
// --- 4. Resource Manager ---
let resource_manager = Arc::new(ResourceManager::new(instance.clone(), device.clone())?);
info!("Resource Manager initialized.");
let renderer_device_handle_to_pass = device.raw().handle();
let renderer_queue_device_handle_to_pass = graphics_queue.device().raw().handle();
// --- 5. Renderer ---
let initial_size = window.inner_size();
let renderer = Renderer::new(
instance.clone(), // Pass instance for allocator creation
device.clone(),
graphics_queue.clone(),
surface.clone(),
resource_manager.clone(),
initial_size.width,
initial_size.height,
)?;
let egui_ctx = Context::default();
let egui_winit = State::new(
egui_ctx.clone(),
ViewportId::ROOT,
&window,
None,
None,
None,
);
let egui_app = EditorUI::default();
info!("Renderer initialized.");
Ok(Self {
_instance: instance,
_physical_device: physical_device,
_device: device,
_graphics_queue: graphics_queue,
_surface: surface,
_resource_manager: resource_manager,
renderer,
window,
egui_winit,
egui_ctx,
egui_app,
frame_count: 0,
last_fps_update_time: Instant::now(),
last_frame_time: Instant::now(),
})
}
fn handle_event(&mut self, event: &WindowEvent, active_event_loop: &ActiveEventLoop) {
let _ = self.egui_winit.on_window_event(&self.window, event);
match event {
WindowEvent::CloseRequested => {
info!("Close requested. Exiting...");
active_event_loop.exit();
}
WindowEvent::Resized(physical_size) => {
info!(
"Window resized to: {}x{}",
physical_size.width, physical_size.height
);
// Important: Resize renderer *before* the next frame
self.renderer
.resize(physical_size.width, physical_size.height);
}
WindowEvent::ScaleFactorChanged { scale_factor, .. } => {
info!("Scale factor changed: {}", scale_factor);
// May also need to resize renderer if size depends on scale factor
let new_inner_size = self.window.inner_size();
self.renderer
.resize(new_inner_size.width, new_inner_size.height);
}
// Handle other inputs if not consumed by egui
WindowEvent::KeyboardInput { .. }
| WindowEvent::CursorMoved { .. }
| WindowEvent::MouseInput { .. } => {}
WindowEvent::RedrawRequested => {
let now = Instant::now();
let _delta_time = now.duration_since(self.last_frame_time);
self.last_frame_time = now;
let elapsed_sice_last_update = now.duration_since(self.last_fps_update_time);
self.frame_count += 1;
if elapsed_sice_last_update >= Duration::from_secs(1) {
let fps = self.frame_count as f64 / elapsed_sice_last_update.as_secs_f64();
let new_title = format!("{} - {} - {:.0} FPS", ENGINE_NAME, APP_NAME, fps);
self.window.set_title(&new_title);
self.frame_count = 0;
self.last_fps_update_time = now;
}
let raw_input = self.egui_winit.take_egui_input(&self.window);
let egui::FullOutput {
platform_output,
textures_delta,
shapes,
pixels_per_point,
..
} = self.egui_ctx.run(raw_input, |ctx| {
self.egui_app.build_ui(ctx);
});
self.renderer.update_textures(textures_delta).unwrap();
self.egui_winit
.handle_platform_output(&self.window, platform_output);
let clipped_primitives = self.egui_ctx.tessellate(shapes, pixels_per_point);
// --- Render Frame ---
match self
.renderer
.render_frame(pixels_per_point, &clipped_primitives)
{
Ok(_) => {
self.window.request_redraw();
}
Err(RendererError::SwapchainSuboptimal) => {
// Swapchain is suboptimal, recreate it next frame by triggering resize
warn!("Swapchain suboptimal, forcing resize.");
let size = self.window.inner_size();
self.renderer.resize(size.width, size.height);
}
Err(e) => {
error!("Failed to render frame: {}", e);
// Decide how to handle persistent errors (e.g., exit)
active_event_loop.exit();
}
}
self.window.as_ref().request_redraw();
}
_ => {}
}
}
}
// --- Helper Functions ---
/// Finds queue family indices for graphics and presentation.
fn find_suitable_device_and_queues(
physical_device: &PhysicalDevice,
surface: &Surface,
required_extensions: &[&CStr],
) -> Result<gfx_hal::physical_device::QueueFamilyIndices, Box<dyn Error>> {
// 1. Check Extension Support
let supported_extensions = unsafe {
physical_device
.instance()
.ash_instance()
.enumerate_device_extension_properties(physical_device.handle())?
};
let supported_extension_names: std::collections::HashSet<&CStr> = supported_extensions
.iter()
.map(|ext| unsafe { CStr::from_ptr(ext.extension_name.as_ptr()) })
.collect();
for &required in required_extensions {
if !supported_extension_names.contains(required) {
return Err(
format!("Missing required extension: {}", required.to_string_lossy()).into(),
);
}
}
// 2. Check Feature Support (Dynamic Rendering)
let mut dynamic_rendering_features = vk::PhysicalDeviceDynamicRenderingFeaturesKHR::default();
let mut features2 =
vk::PhysicalDeviceFeatures2::default().push_next(&mut dynamic_rendering_features);
unsafe {
physical_device
.instance()
.ash_instance()
.get_physical_device_features2(physical_device.handle(), &mut features2);
}
if dynamic_rendering_features.dynamic_rendering == vk::FALSE {
return Err("Dynamic Rendering feature not supported".into());
}
// Add checks for other required features here...
// 3. Check Queue Family Support
let queue_family_properties = unsafe {
physical_device
.instance()
.ash_instance()
.get_physical_device_queue_family_properties(physical_device.handle())
};
let mut graphics_family = None;
let mut present_family = None;
for (i, queue_family) in queue_family_properties.iter().enumerate() {
let index = i as u32;
// Check for graphics support
if queue_family.queue_flags.contains(vk::QueueFlags::GRAPHICS) {
graphics_family = Some(index);
}
// Check for presentation support
let present_support = unsafe {
surface
.surface_loader()
.get_physical_device_surface_support(
physical_device.handle(),
index,
surface.handle(),
)?
};
if present_support {
present_family = Some(index);
}
if graphics_family.is_some() && present_family.is_some() {
break; // Found suitable families
}
}
match (graphics_family, present_family) {
(Some(graphics), Some(present)) => Ok(gfx_hal::physical_device::QueueFamilyIndices {
graphics_family: Some(graphics),
present_family: Some(present), // Could be the same as graphics
compute_family: None, // Not needed for this example
transfer_family: None, // Not needed for this example
}),
_ => Err("Could not find suitable queue families".into()),
}
}
/// Game Engine
#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
struct Args {
/// Whether or not to create debug log (default false)
#[arg(short, long, default_value_t = false)]
debug_log: bool,
}
// --- Entry Point ---
fn main() -> Result<(), Box<dyn Error>> {
color_eyre::install()?;
let args = Args::parse();
let fmt_layer = tracing_subscriber::fmt::layer()
.with_ansi(true)
.with_file(false)
.with_line_number(false)
.with_filter(filter::LevelFilter::DEBUG);
let registry = tracing_subscriber::registry().with(fmt_layer);
if args.debug_log {
let log_file = OpenOptions::new()
.append(true)
.create(true)
.open("log-debug.log")?;
let json_layer = tracing_subscriber::fmt::layer()
.with_ansi(false)
.without_time()
.with_writer(log_file)
.with_filter(filter::LevelFilter::DEBUG);
registry.with(json_layer).init();
} else {
registry.init();
}
// --- Winit Setup ---
let event_loop = EventLoop::new()?;
// --- Event Loop ---
info!("Starting event loop...");
let mut app = ApplicationWrapper::default();
event_loop.run_app(&mut app)?;
Ok(())
}