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.

Why would you may want to use this lib

This is a one for all library, though it theoretically started as a minifb patcher

It offers a "little bit" of content in an unreasonable amount of aspects and loves to ever self improve

How to get started with a simple window:

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

_{(Flags: minifb/glfw/console/all_backends)}

use mirl::platform::windowing::traits::*;
fn main() {
    let mut buffer = mirl::prelude::Buffer::new_empty((800, 600));
    // More backends options can be found in `mirl::platform::windowing`
    let mut window = mirl::prelude::Framework::new(
        "Example window",
        mirl::prelude::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
• ConstBuffer - Compile-time constant buffer support

Windowing & Platform

• Multi-backend window system
  • MiniFB (full support)
  • GLFW (partial support)
  • Console (Uses console instead of standalone window) (Experimental)
• Window manipulation (position, size, opacity, z-order, visibility, borderless, etc.)
• Input handling (keyboard, mouse, raw input)
• Mouse snapshot support for capturing complete input state
• Custom cursor loading and management
• File system abstraction
• Platform-specific features (Windows focus)

Graphics & Rendering

• 2D Rendering
  • Text (standard, antialiased with alpha cutoff control, stretched)
  • Shapes (rectangles, circles, triangles, lines)
  • Buffer-to-buffer blitting with multiple interpolation modes
  • Smart drawing functions for optimized rendering
• 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
  • Index-based texture access
  • Optional 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 (standard and strict)
  • Circle-rectangle collision
  • Point containment tests
  • Rectangle direction calculations
• Number Types
  • U1, U2, U4 - sub-byte unsigned integers with num-traits support
  • UniformRange - normalized [0.0, 1.0] float representation
  • Support for f16 and f128 where possible
• Math Extensions
  • Vector normalization and interpolation
  • Bounded type traits
  • Angle conversions (degrees/radians)
  • Power-of-two utilities
  • No std math support

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
• Container (Cell, Option) & Tuple Operations
  • Saturating arithmetic
  • Clamping and sign manipulation
  • Tuple-wise operations and comparisons
  • Round, Sqrt, Abs, Floor, and Ceil operations
• Type Conversions
  • Tuple into conversions (const and runtime)
  • Result mapping helpers
  • Sign/unsigned mapping
  • TryFromPatch with Number, HashMap, BTreeMap, Vec, and String conversions (Fixes holes like f64 from f32 and adds a whole lot more)
  • TryIntoPatch an automatically implementing TryFromPatch counterpart

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 and const trait support
• Scrollable Camera - 2D viewport with scroll bounds
• Console Utilities - Colored output and input handling
• Time Constants - Duration conversion helpers
• Unsafe Option Unwrapping - EasyUnwrapUnchecked, used when you know that a value isn't None using .easy_unwrap_unchecked (Skips the unsafe {} step. This trait/function violates the rust philosophy, [unlike hopefully the rest of the lib,] yet it is distinct enough from the default unwraps to make it's accidental usage highly unlikely)
• Dependencies Module - Reexports of all dependencies mirl uses

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