ezwin 3.3.0

Easy, minimal Win32 window creation
Documentation 
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
68
69
70
71
72

# ezwin-rs


[![Static Badge](https://img.shields.io/badge/crates.io-ezwin?style=for-the-badge&color=E5AB37)](https://crates.io/crates/ezwin)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R8PGIU6)

## `ezwin` is an easy-to-use Win32 windowing library


⚠️ This project is still very much a WIP; I am only one student, after all. ⚠️

## Goals


The main goal of `ezwin` is to have a simple, easy-to-use API. The target audience is game developers looking to create
a window quickly and easily. I aim to have feature-parity with `winit` eventually as a secondary goal.

Cross-platform support is unlikely, but pull requests are welcomed if anyone else wants to tackle it.

I would like to eventually transition from using `windows` to `windows-sys` to benefit from better compile times,
as the wrappers included in the former are redundant for this crate.

## Why the rework?


I have to agree that the original API for `ezwin` was much nicer to work with, but it had a number of issues related to
the multithreaded nature of things. The main issue which was the most difficult to solve, and I never could, was that of
waiting for the previous message to complete before processing the next message without creating deadlocks. This is
important to prevent issues related to resizing windows and to prevent excessive delays with input. I do plan on
investigating further in the future a way to reintroduce an interator-based API, but for now, the rework should get
things working properly.

## Cargo Features


* **`rwh_05` / `rwh_06`:** use the appropriate version of `raw-window-handle`. `rwh_06` is the default.

## Examples


You can find examples in [the examples folder](examples). You can also see the vulkano branch of
[foxy-rs/foxy](https://github.com/foxy-rs/foxy/tree/vulkano), which as of the time of writing is utilizing `ezwin`, but
is subject to change.

```rust
use ezwin::prelude::*;

#[allow(unused)]

struct App {
  z: i32,
}

// Implement
impl WindowCallback for App {
  fn on_message(&mut self, window: &Arc<Window>, message: Message) {
    if let Message::Window(WindowMessage::Key { key: Key::Escape, .. }) = message {
      window.close();
    }
  }
}

fn main() {
  let x = 69;
  let y = 34;

  // Configure
  let settings = WindowSettings::default()
    .with_flow(Flow::Wait)
    .with_size((1280, 720))
    .with_title("Example");

  // Build
  let window = Window::new(settings).unwrap();

  // Run
  window.run(App { z: x + y });
}
```