0a96643e26
* ash-window: Upgrade to raw-window-handle 0.5.0 * Bump `raw-window-metal` to recently-released `0.3` https://github.com/norse-rs/raw-window-metal/pull/5 * examples: Bump `winit` to `0.27.1` to resolve our MSRV tests While the examples technically aren't part of our MSRV requirement (it's nice, but core crate compatibility is much more important), it's annoying to exempt these especially now that `winit` removed some unneeded MSRV 1.60/1.61 requirements. * Take `Raw{Display,Window}Handle` directly instead of through trait
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
## Ash-window
|
|
|
|
Interoperability between [`ash`](https://github.com/MaikKlein/ash) and [`raw-window-handle`](https://github.com/rust-windowing/raw-window-handle) for surface creation.
|
|
|
|
[](https://crates.io/crates/ash-window)
|
|
[](https://docs.rs/ash-window)
|
|
[](https://github.com/MaikKlein/ash/actions?workflow=CI)
|
|
[](LICENSE-MIT)
|
|
[](LICENSE-APACHE)
|
|
[](https://gitter.im/MaikKlein/ash?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
## Usage
|
|
|
|
```toml
|
|
ash-window = "0.11.0"
|
|
```
|
|
|
|
The library exposes two functions:
|
|
|
|
- [`enumerate_required_extensions`] returns the required instance extensions needed for surface creation from a specific display handle.
|
|
|
|
- [`create_surface`] allows to create a surface from a type implementing [`RawDisplayHandle`] and [`RawWindowHandle`]:
|
|
|
|
```rust
|
|
ash_window::create_surface(&entry, &instance, &window, None)?;
|
|
```
|
|
|
|
[`enumerate_required_extensions`]: https://docs.rs/ash-window/latest/ash_window/fn.enumerate_required_extensions.html
|
|
[`create_surface`]: https://docs.rs/ash-window/latest/ash_window/fn.create_surface.html
|
|
[`RawDisplayHandle`]: https://docs.rs/raw-window-handle/latest/raw_window_handle/enum.RawDisplayHandle.html
|
|
[`RawWindowHandle`]: https://docs.rs/raw-window-handle/latest/raw_window_handle/enum.RawWindowHandle.html
|
|
|
|
## Versions
|
|
```toml
|
|
ash = "0.37"
|
|
```
|
|
|
|
## Support
|
|
|
|
- [x] Windows (`VK_KHR_win32_surface`)
|
|
- [x] Unix (`VK_KHR_xlib_surface`/`VK_KHR_xcb_surface`/`VK_KHR_wayland_surface`)
|
|
- [x] MacOS/IOS (`VK_EXT_metal_surface`)
|
|
- [x] Android (`VK_KHR_android_surface`)
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
## Contribution
|
|
|
|
Unless you explicitly state otherwise, any Contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
|