Home

Awesome

Overlays

Game overlays are usually created in one of two ways:

This crate uses the second technique, and I'm working on a yet-to-be-announced crate utilizing the first technique.

There is also (potentially) a third way to draw an overlay which involves messing with the compositor, but I haven't really looked into that.

Usage

use overlay::OverlayBuilder;
use winit::event_loop::EventLoop;

fn main() {
    let event_loop = EventLoop::new();
    let mut overlay = OverlayBuilder::new().build();

    // Initialize renderer

    event_loop.run(..);
}

To toggle the overlay, use Overlay::toggle(..).

Limitiations

How does it work?

The Windows implementation is based on this CodeProject article from 2007.