glwfr 0.3.0

//! # Window Module
//!
//! This module provides a wrapper for creating and managing a GLFW window with an OpenGL context.
//!
//! ## Usage
//!
//! ```rust
//! use glwfr::graphics::window::Window;
//!
//! fn main() -> Result<(), glwfr::custom_errors::Errors> {
//!     let mut window = Window::new(800, 600, "My Window")?;
//!     window.init_gl();
//!     window.enable_depth_test();
//!
//!     while !window.should_close() {
//!         window.clear(0.0, 0.0, 0.0, 1.0);
//!         window.update();
//!     }
//!     Ok(())
//! }
//! ```

use crate::custom_errors::Errors;
use crate::input;
use glfw::{Action, Context, Key, WindowEvent};
use std::sync::mpsc::Receiver;

pub struct Window {
    glfw: glfw::Glfw,
    window_handle: glfw::Window,
    events: Receiver<(f64, WindowEvent)>,
}

impl Window {
    /// Create a new window with the given width and height and title, and enable polling
    /// for the given window events. If the window cannot be created, returns an error of
    /// type `Errors::WindowCreationError`.
    ///
    /// # Arguments
    ///
    /// * `width` - The width of the window in pixels.
    /// * `height` - The height of the window in pixels.
    /// * `title` - The title of the window.
    ///
    /// # Returns
    ///
    /// A `Result` containing a `Window` instance if successful, or an error of type
    /// `Errors::WindowCreationError` otherwise.
    pub fn new(width: u32, height: u32, title: &str) -> Result<Self, Errors> {
        let glfw = glfw::init(glfw::FAIL_ON_ERRORS)
            .map_err(|e| Errors::GlfwInitializationError(e.to_string()))?;

        let (mut window, events) = glfw
            .create_window(width, height, title, glfw::WindowMode::Windowed)
            .ok_or_else(|| {
                Errors::WindowCreationError("Failed to create GLFW window".to_string())
            })?;

        window.set_framebuffer_size_polling(true);
        window.set_key_polling(true);
        window.set_mouse_button_polling(true);
        window.set_cursor_pos_polling(true);
        window.set_scroll_polling(true);

        Ok(Self {
            glfw,
            window_handle: window,
            events,
        })
    }

    /// Initialize the OpenGL context for the window.
    ///
    /// This function sets the current context to the window's OpenGL context
    /// and loads the OpenGL function pointers using the `gl` crate.
    ///
    /// # Errors
    ///
    /// This function will return an error if there are any OpenGL errors during
    /// the initialization process.

    pub fn init_gl(&mut self) -> Result<(), Errors> {
        self.window_handle.make_current();
        gl::load_with(|s| self.window_handle.get_proc_address(s) as *const _);

        // Check for OpenGL errors
        crate::custom_errors::check_opengl_error()?;
        Ok(())
    }

    /// Check if the window should close.
    ///
    /// # Returns
    ///
    /// `true` if the window should close, otherwise `false`.
    pub fn should_close(&self) -> bool {
        self.window_handle.should_close()
    }

    /// Enable depth testing for this window.
    ///
    /// # OpenGL Functions
    ///
    /// This function is a wrapper around `glEnable(GL_DEPTH_TEST)`.
    pub fn enable_depth_test(&self) {
        unsafe {
            gl::Enable(gl::DEPTH_TEST);
        }
    }

    /// Enable blending for this window.
    ///
    /// # OpenGL Functions
    ///
    /// This function is a wrapper around `glEnable(GL_BLEND)` and
    /// `glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA)`.
    pub fn enable_blend(&self) {
        unsafe {
            gl::Enable(gl::BLEND);
            gl::BlendFunc(gl::SRC_ALPHA, gl::ONE_MINUS_SRC_ALPHA);
        }
    }

    /// Clear the screen with the given color.
    ///
    /// # OpenGL Functions
    ///
    /// This function is a wrapper around `glClearColor` and `glClear`.
    ///
    /// # Arguments
    ///
    /// * `r` - The red component of the color.
    /// * `g` - The green component of the color.
    /// * `b` - The blue component of the color.
    /// * `a` - The alpha component of the color.
    pub fn clear(&self, r: f32, g: f32, b: f32, a: f32) {
        unsafe {
            gl::ClearColor(r, g, b, a);
            gl::Clear(gl::COLOR_BUFFER_BIT | gl::DEPTH_BUFFER_BIT);
        }
    }

    /// Process window events and swap the front and back buffers.
    ///
    /// This must be called every frame to keep the window responsive.
    pub fn update(&mut self) {
        self.process_events();
        self.glfw.poll_events();
        self.window_handle.swap_buffers();
    }

    /// Process window events and update the window state accordingly.
    ///
    /// This function will handle the following events:
    ///
    /// * `FramebufferSize`: Update the OpenGL viewport to match the new window dimensions.
    /// * `Key` with the escape key: Mark the window as needing to close.
    ///
    /// This function also calls `input::process_event` to allow for input to be handled by the user.
    fn process_events(&mut self) {
        for (_, event) in glfw::flush_messages(&self.events) {
            input::process_event(&event);
            match event {
                glfw::WindowEvent::FramebufferSize(width, height) => {
                    // Make sure the viewport matches the new window dimensions.
                    unsafe { gl::Viewport(0, 0, width, height) }
                }
                glfw::WindowEvent::Key(Key::Escape, _, Action::Press, _) => {
                    self.window_handle.set_should_close(true)
                }
                _ => {}
            }
        }
    }
}