witer 0.7.2

An iterator-based Win32 windowing library
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
73
74
75
76
77
78
79

# `witer`


## An iterator-based Win32 window library built in Rust


[![Crates.io Version](https://img.shields.io/crates/v/witer)](https://crates.io/crates/witer)
[![Discord](https://img.shields.io/discord/1215348294105169940?logo=discord&label=discord&color=5865F2)](https://discord.gg/KEtfte9xWZ)

```rust
use witer::prelude::*;

fn main() {
  // Configure
  let settings = WindowSettings::default()
    .with_title("My App")
    .with_outer_size(LogicalSize::new(800.0, 600.0));

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

  // Run
  for message in &window {
    if let Message::Key { .. } = message {
      println!("{message:?}");
    }
  }
}
```

## Goals


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

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

## Documentation


Documentation is a work-in-progress as the crate evolves. Don't expect much here yet, so if you have any
questions, either:

* Make a post in the Discussions tab on GitHub
* Send a message over Discord
* Dive into the codebase yourself

## 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 `witer`, but
is subject to change.

## Contact Me


You can get in contact through the discord linked at the top, or post in the Discussions tab on GitHub.

Alternatively, you can email me at <dev.gabriel.lugo@gmail.com>

## FAQ


**Q:** Why not `winit`?

**A:** While `winit` is the best choice for pretty much everyone, I found that multithreading the windows message pump
could lead to performance gains (unsubstantiated). Additionally, I was simply not satisfied with the way the `winit` API
looks and feels. If you are perfectly satisfied with what `winit` offers, then I recommend you stick with it.

**Q:** What happened to `ezwin`?

**A:** I wanted a name that was more inline with the ideas and goals behind the project. Additionally, I wanted a chance
to pull the project back to `v0.x.y` to reflect its volatile nature. This isn't currently possible with Crates.io (ignoring
yanking). Furthermore, the `v3.x.y` could be seen as confusing for those who didn't understand why they existed.

## ⚠️ Warning ⚠️


This project is still hilariously incomplete. I am only one student, after all.

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R8PGIU6)