Mirl

Miners Rust Lib - A modular utility library featuring windowing, 2D rendering, input handling, color manipulation, system integration, math utilities, extensive type extensions, and more. Content is listed at the bottom.

How to get started (flags: minifb/glfw/all_backends):

If you want to enable everything this library has to offer you can use the all flag

MiniFB is recommended but every backend has their own unique limitations/quirks which is the reason this lib exists in the first place

use mirl::platform::framework_traits::Window;
fn main() {
    let mut buffer = mirl::platform::Buffer::new_empty((800, 600));
    let mut window = mirl::platform::{minifb/glfw}::Framework::new(
        "Example window",
        mirl::platform::WindowSettings::default(&buffer),
    ).unwrap();
    while window.is_open() {
        buffer.clear();

        // Draw here, use mirl::render for simple presets/helper functions

        window.update(&buffer);
    }
}

For a debugging window lib "similar" to Dear ImGui you can use the dear_mirl_gui crate (which is RmMode)

Compatibility

Features/Flags

Default (disabled with default-features = false)

• texture_manager_cleanup - Adds extra cleanup logic for 'automatic' texture unloading
• num_traits - Enables num-traits dependency which is relied on by many functions and structs for modular number support
• std - Enables the default rust lib which most of the lib relies on

Optional

• imagery - Enables support for the image crate for image loading
• svg - Enables SVG rasterization via the resvg and tempfile crates (used for things like cursor support)
• minifb - Enables the framework backend using minifb and requires low-level system access
• glfw - Enables the framework backend using glfw, OpenGL, and requires low-level system access
• font_support - Adds support for fontdue and uses once_cell for font rendering logic
• system - Low-level system interaction using platform-specific crates (x11, windows, winapi, raw-window-handle)
• all_backends - Enables all major backends: minifb_backend, glfw_backend, and keycode_support
• all - Enables all major features: default, imagery, full_backend_support, discord, and random
• keycodes - Enables the ability to interact with keyboard
• keyboard_query - Get the currently pressed keys -> Required for MiniFB
• cursor_show_hotspot - A debug option for adding a red dot to the hotspot of a customly loaded cursor
• discord - Support for sending stuff to discord webhooks
• parking_lot - Enables the parking_lot dependency for more efficient synchronization primitives
• ahash - Enables the ahash dependency for faster HashMap implementations
• random - Enables random number generation support

Other

This lib is heavily guided by clippy and as such:

• Almost everything has a short docstring
• Execution stopping functions/macros like panic! or unwrap() are only ever used in custom panic/unwrap functions

To add:

• Clipboard support
• Sound support
• More terminal functionality
• Network support

Content

Core Types & Buffer Management

• Buffer - ARGB u32 pixel buffer with manipulation operations
• Pixel-level operations (safe/unsafe accessors)
• Buffer transformations (flip, rotate, trim, resize)
• Collision detection from buffers

Windowing & Platform

• Multi-backend window system
  • MiniFB (full support)
  • GLFW (partial support)
• Window manipulation (position, size, opacity, z-order, visibility, borderless, etc.)
• Input handling (keyboard, mouse, raw input)
• Custom cursor loading and management
• File system abstraction
• Platform-specific features (Windows focus)

Graphics & Rendering

• 2D Rendering
  • Text (standard, antialiased, stretched)
  • Shapes (rectangles, circles, triangles, lines)
  • Buffer-to-buffer blitting
• Color Utilities
  • RGB/HSL conversion and manipulation
  • Hex/ARGB conversion
  • Color interpolation and shifting
  • Brightness and saturation adjustment
• Image Processing
  • Multiple interpolation modes (Nearest, Linear, Cubic, Lanczos, Gaussian, etc.)
  • Image resizing and filtering
  • SVG rasterization
  • Format conversion (BMP, ICO, CUR generation)
• Texture Management
  • Lazy loading and caching
  • Automatic cleanup of unused textures

System Integration

• Window Control (Windows-specific)
  • Window positioning and sizing
  • Minimization, maximization, restoration
  • Z-order and window level management
  • Opacity and click-through
  • Taskbar progress indicators
• System Actions
  • Screen capture (full screen, desktop background)
  • CPU priority control
  • Screen resolution queries

Math & Geometry

• Collision Detection
  • Rectangle-rectangle intersection
  • Circle-rectangle collision
  • Point containment tests
• Number Types
  • U1, U2, U4 - sub-byte unsigned integers with num-traits support
  • UniformRange - normalized [0.0, 1.0] float representation
• Math Extensions
  • Vector normalization and interpolation
  • Bounded type traits
  • Angle conversions (degrees/radians)
• Positioning
  • Point2D and Point3D - 2D and 3D point structures

Extensions & Utilities

• List Operations
  • Finding differences, duplicates, regions
  • Push-or-replace for max-sized lists
  • Averaging and combining
• String Extensions
  • Text justification and centering
  • Tab expansion
  • Number validation
• Cell & Tuple Operations
  • Saturating arithmetic
  • Clamping and sign manipulation
  • Tuple-wise operations and comparisons
• Type Conversions
  • Tuple into conversions (const and runtime)
  • Result mapping helpers
  • Sign/unsigned mapping
  • TryFromPatch with Number, HashMap, BTreeMap, Vec, and String conversions

Miscellaneous

• Discord Integration - Webhook payloads with embeds, components, and attachments
• Keybinding System - Action-based keybind handling with priority
• Direction Types - Cardinal and extended directions with rotation
• Scrollable Camera - 2D viewport with scroll bounds
• Console Utilities - Colored output and input handling
• Time Constants - Duration conversion helpers
• Map Trait - Unified interface for working with different map types
• Unsafe Option Unwrapping - EasyUnwrapUnchecked, used when you know that a value isn't None using .easy_unwrap_unchecked (Skips the unsafe {} step)

Updating

What do the version numbers mean?

• Major: Changes have been made across the library that are almost sure to affect anyone using it
• Minor: A breaking change has been made but it is likely not be to the area of the library you're working with
• Patch: No breaking API change, only fixes and additions

• Patch: You can update the lib without any changes to your code

• Minor: You can probably update safely but there is a chance of something erroring

• Major: You will most likely have to fix something

Note that these rules do not apply to modules (and sub modules) named misc, they are collections of objects that have not yet been assigned a proper place to stay

Hi there

What brought you to this strange place?

This is just a little big lib I built for easy function/struct/etc. reusability across my never ending stream of unfinished projects. Even if many of the functions in here will never be used again, considering there are ~3.5k functions, ~25 enums, ~60 structs, ~200 traits, ~1.3 trait implementations; you are sure to find something of use

My philosophy follows 3 things:

• Modularity: Why put a limit on things?
• Usability What is something worth when it's unusable?
• Speed: No questions. More speed more better.

You can find the most random yet oddly specific things here. Enjoy! Or don't, honestly...

If you use the lib in a public project, let me know; I'd genuinely love to see what other people create with the lib

The lib was created on the 21.12.2024.

At the time of writing it is the 1.12.2025. (I will not update this frequently)

Having existed for almost a year here are the stats (pub only):

(Not displayed: Types)