alex/ash
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
ash/ash-window/README.md

59 lines
2.5 KiB
Markdown
Raw Normal View History

changelog: Add entries for recent PRs #545, #534, #553, #551, #549 (#555) And drop the deprecated =/- markdown syntax from our readme: this is analogous to #/## for a h1/h2 header, instead of defining a title and (usually smaller font) subtitle or description.
2022-01-17 20:45:10 +01:00
## Ash-window
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
Update repository links and crate keywords/categories (#819) Some links were still pointing to the (moved) `MaikKlein/ash` repo, instead of the new shared `ash-rs/ash` repository under this organisation, GitHub still provides a redirect, but we should aim to provide the correct link from the get-go. Only the gitter channel remains as it was impossible to get the room to be renamed. The `ash-rs/ash` channel exists but there is currently no activity.
2023-11-17 16:55:05 +01:00
Interoperability between [`ash`](https://github.com/ash-rs/ash) and [`raw-window-handle`](https://github.com/rust-windowing/raw-window-handle) for surface creation.
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
Unify readme between Ash and Ash-window (#455)
2021-07-30 12:32:52 +02:00
[![Crates.io Version](https://img.shields.io/crates/v/ash-window.svg)](https://crates.io/crates/ash-window)
[![Documentation](https://docs.rs/ash-window/badge.svg)](https://docs.rs/ash-window)
Update repository links and crate keywords/categories (#819) Some links were still pointing to the (moved) `MaikKlein/ash` repo, instead of the new shared `ash-rs/ash` repository under this organisation, GitHub still provides a redirect, but we should aim to provide the correct link from the get-go. Only the gitter channel remains as it was impossible to get the room to be renamed. The `ash-rs/ash` channel exists but there is currently no activity.
2023-11-17 16:55:05 +01:00
[![Build Status](https://github.com/ash-rs/ash/workflows/CI/badge.svg)](https://github.com/ash-rs/ash/actions?workflow=CI)
Unify readme between Ash and Ash-window (#455)
2021-07-30 12:32:52 +02:00
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE-MIT)
[![LICENSE](https://img.shields.io/badge/license-apache-blue.svg)](LICENSE-APACHE)
ash-window: Link to the `ash` gitter instead of nonexistent `ash-window` (#659) It seems there's no gitter channel for `ash-window` (404), and since everyone is in the `ash` channel already, just use the same one.
2022-09-22 18:07:17 +02:00
[![Join the chat at https://gitter.im/MaikKlein/ash](https://badges.gitter.im/MaikKlein/ash.svg)](https://gitter.im/MaikKlein/ash?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Switch to safe `CStr::from_bytes_until_nul` on sized `c_char` array wrapper (#746) Certain structs contain sized character arrays that are converted to `CStr` for convenient accss to the user and our `Debug` implementation using unsafe `CStr::from_ptr(...as_ptr())`. There is no need to round-trip to a pointer and possibly read out of bounds if the NUL-terminator index (string length) is instead searched for by the newly stabilized `CStr::from_bytes_until_nul()` fn since Rust 1.69 (which panics if no NUL-terminator is found before the end of the slice). Unfortunately `unsafe` is still needed to cast the array from a `c_char` (`i8` on most platforms) to `u8`, which is what `from_bytes_until_nul()` accepts.
2023-12-02 20:04:57 +01:00
[![MSRV](https://img.shields.io/badge/rustc-1.69.0+-ab6000.svg)](https://blog.rust-lang.org/2023/04/20/Rust-1.69.0.html)
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
## Usage
Unify readme between Ash and Ash-window (#455)
2021-07-30 12:32:52 +02:00
```toml
ash-window: Sync up with `0.12.0` release
2023-02-24 22:01:58 +01:00
ash-window = "0.12.0"
Unify readme between Ash and Ash-window (#455)
2021-07-30 12:32:52 +02:00
```
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
The library exposes two functions:
ash-window: Upgrade to raw-window-handle 0.5.0 (#645) * 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
2022-09-23 12:40:12 +02:00
- [`enumerate_required_extensions`] returns the required instance extensions needed for surface creation from a specific display handle.
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
ash-window: Upgrade to raw-window-handle 0.5.0 (#645) * 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
2022-09-23 12:40:12 +02:00
- [`create_surface`] allows to create a surface from a type implementing [`RawDisplayHandle`] and [`RawWindowHandle`]:
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
Unify readme between Ash and Ash-window (#455)
2021-07-30 12:32:52 +02:00
```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
ash-window: Upgrade to raw-window-handle 0.5.0 (#645) * 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
2022-09-23 12:40:12 +02:00
[`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
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
## Versions
README: Remove deprecated `builder()` snippets and guidelines (#743) * README: Autoformat * README: Remove deprecated `builder()` snippets and guidelines #602 introduced builder functions directly on the raw Vulkan struct types by using lifetime borrows which are FFI compatible (ABI is identical) wuth raw pointers, simplifying the whole system and protecting the user against losing lifetimes upon calling `.build()`. However, this change wasn't propagated through to the `README` so the code snippets were still showcasing removed `::builder()` and `.build()` functions and documenting "the `.build()` footgun" which doesn't even exist anymore 🎉
2023-04-16 22:19:09 +02:00
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
```toml
Release ash 0.37.0 and ash-window 0.10.0 (#600)
2022-03-23 22:04:12 +01:00
ash = "0.37"
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
```
## 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
README: Remove deprecated `builder()` snippets and guidelines (#743) * README: Autoformat * README: Remove deprecated `builder()` snippets and guidelines #602 introduced builder functions directly on the raw Vulkan struct types by using lifetime borrows which are FFI compatible (ABI is identical) wuth raw pointers, simplifying the whole system and protecting the user against losing lifetimes upon calling `.build()`. However, this change wasn't propagated through to the `README` so the code snippets were still showcasing removed `::builder()` and `.build()` functions and documenting "the `.build()` footgun" which doesn't even exist anymore 🎉
2023-04-16 22:19:09 +02:00
- 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)
Add interoperability functions for raw-window-handle (#308) * Add ash-window as workspace member * ash-window: fix repository link * ash-window: Address CI fmt&clippy issues * ash-window: Try fix SDL2 CI issues * ash-window: Remove beryllium example
2020-07-04 15:21:39 +02:00
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.
Reference in a new issue Copy permalink