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

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