[update] monitor retrieval.

Author: vmarcella

crates/lambda-platform/src/winit/mod.rs

@@ -187,19 +187,14 @@ pub struct LoopPublisher<E: 'static> {
 }
 
 impl<E: 'static + std::fmt::Debug> LoopPublisher<E> {
-  /// Instantiate a new EventLoopPublisher from an event loop proxy.
+  /// New LoopPublishers are created from a lambda_loop directly and don't need
   #[inline]
-  pub fn new(winit_proxy: EventLoopProxy<E>) -> Self {
-    return LoopPublisher { winit_proxy };
-  }
-
-  /// Instantiate a new LoopPublisher from a loop
-  pub fn from(lambda_loop: &Loop<E>) -> Self {
+  pub fn new(lambda_loop: &Loop<E>) -> Self {
     let winit_proxy = lambda_loop.event_loop.create_proxy();
     return LoopPublisher { winit_proxy };
   }
 
-  /// Send an event
+  /// Publishes an event into the event loop that created this publisher.
   #[inline]
   pub fn publish_event(&self, event: E) {
     self
@@ -210,9 +205,9 @@ impl<E: 'static + std::fmt::Debug> LoopPublisher<E> {
 }
 
 impl<E: 'static + std::fmt::Debug> Loop<E> {
-  pub fn create_publisher(&mut self) -> LoopPublisher<E> {
-    let proxy = self.event_loop.create_proxy();
-    return LoopPublisher::new(proxy);
+  /// Create an event publisher for this Loop.
+  pub fn create_event_publisher(&mut self) -> LoopPublisher<E> {
+    return LoopPublisher::new(&self);
   }
 
   /// Returns the primary monitor for the current OS if detectable.
@@ -225,12 +220,9 @@ impl<E: 'static + std::fmt::Debug> Loop<E> {
     return self.event_loop.available_monitors();
   }
 
-  pub fn get_any_available_monitors(&self) -> MonitorHandle {
-    // TODO(vmarcella): Remove the panic from this in favor of returning a result or an error.
-    match self.event_loop.available_monitors().next() {
-      Some(monitor) => monitor,
-      None => panic!("No available monitors found."),
-    }
+  /// Gets the first available monitor or panics.
+  pub fn get_any_available_monitors(&self) -> Option<MonitorHandle> {
+    return self.event_loop.available_monitors().next();
   }
 
   /// Uses the winit event loop to run forever

lambda/src/core/render/window.rs

@@ -13,21 +13,24 @@ pub struct WindowBuilder {
 }
 
 impl WindowBuilder {
-  /// Construct a new window window builder.
+  /// A new window builder will be 480x360 by default and have the name
+  /// "Window". After customizing the window with whatever properties your
+  /// application needs, you can supply it an event loop to process the
+  /// events that will be generated by the window.
   pub fn new() -> Self {
     return Self {
-      name: "Window".to_string(),
+      name: String::from("Window"),
       dimensions: (480, 360),
     };
   }
 
-  /// The name of the window (Will also appear as the title of the window/application)
+  /// The name to be displayed in the title bar of the window.
   pub fn with_name(mut self, name: &str) -> Self {
     self.name = name.to_string();
     return self;
   }
 
-  /// Specify the dimensions for the window (Defaults to 480 x 360)
+  /// Specify the dimensions for the window (Defaults to 480 x 360).
   pub fn with_dimensions(mut self, width: u32, height: u32) -> Self {
     self.dimensions = (width, height);
     return self;
@@ -50,9 +53,13 @@ impl Window {
     dimensions: (u32, u32),
     event_loop: &mut Loop<Events>,
   ) -> Self {
-    let monitor_handle = event_loop
-      .get_primary_monitor()
-      .unwrap_or(event_loop.get_any_available_monitors());
+    // Attempt to get the primary monitor first and then falls back to the first
+    // available monitor if that isn't found.
+    let monitor_handle = event_loop.get_primary_monitor().unwrap_or(
+      event_loop
+        .get_any_available_monitors()
+        .expect("No monitors available"),
+    );
 
     let window_properties = WindowProperties {
       name: name.to_string(),
@@ -77,7 +84,7 @@ impl Window {
     return &self.window_handle;
   }
 
-  /// Returns the dimensions of the current window.
+  /// Returns the dimensions of the current window. (width, height)
   pub fn dimensions(&self) -> (u32, u32) {
     return (
       self.window_handle.size.width,

lambda/src/runtimes/mod.rs

@@ -132,7 +132,7 @@ impl Runtime for GenericRuntime {
 
     let mut active_render_api = Some(render_api);
 
-    let publisher = event_loop.create_publisher();
+    let publisher = event_loop.create_event_publisher();
     publisher.publish_event(Events::Runtime {
       event: RuntimeEvent::Initialized,
       issued_at: Instant::now(),