mirl 9.2.0

Miners Rust Lib - A massive collection of ever growing and changing functions, structs, and enums. Check the description for compatibility and toggleable features! (Most of the lib is controlled by flags/features so the lib can continue to be lightweight despite its size)
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

use crate::{
    platform::windowing::WindowError,
    prelude::{Buffer, WindowHelper, WindowSettings},
};
/// A unified window creation method
pub const trait NewWindow {
    /// ### Create a new window with the desired settings
    ///
    /// ### Inputs:
    /// `title`: How the window should be named regardless of if it's shown
    ///
    /// `settings`: See [`WindowSettings`](crate::prelude::WindowSettings) for more info
    // /// `cursor`: If you wish to use cursors other than the default one, provide the cursor you want the window to show by default. If this is set to None, [`set_cursor_style()`](ExtendedWindow::set_cursor_style) may not work as intended
    /// # Errors
    /// See [`WindowError`] for the error messages
    fn new(
        title: &str,
        settings: WindowSettings,
        // #[cfg(feature = "svg")] cursor: Option<Cursor>,
    ) -> Result<Self, WindowError>
    where
        Self: Sized;
}

/// A window instance with only the most basic of functionality
///
/// Be aware that [`WindowHelper`] will automatically be implemented for all structs that implement this trait
pub const trait Window: WindowHelper {
    /// Update what the current window displays using a Buffer or \[u32]
    ///
    /// # Errors
    /// See [`WindowError`]
    fn update_raw(
        &mut self,
        pixels: &[u32],
        width: usize,
        height: usize,
    ) -> Result<(), WindowError>;
    /// Wether the current window is still open
    fn is_open(&self) -> bool;
    /// Clean up any remaining data after closing -> Otherwise memory leaks might happen
    fn close_and_clean_up(&mut self);
}
/// More 'advanced' window control
///
/// Like:
/// - Setting the title
pub const trait ExtendedWindow {
    /// Set the title (Duh)
    fn set_title(&mut self, title: &str);
}
#[cfg(feature = "system")]
/// More 'advanced' window control
pub const trait GetWindowHandle {
    /// Get the current window handle
    fn get_window_handle(&self) -> raw_window_handle::RawWindowHandle;
}
/// Set the icon of the window
pub const trait IconControl {
    /// Set the current icon (task bar)
    /// Width/Height should be something like 32x32 or 48x48 for maximal compatibility
    ///
    /// # Errors
    /// See [`WindowError`]
    fn set_icon(&mut self, buffer: &Buffer) -> Result<(), WindowError>;
}
// TODO: Add function to system that retrieves the current icon of a window