Add explicit support tiers #323
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,23 @@ | ||
| # Android | ||
| /src/backends/android.rs @MarijnS95 | ||
|
|
||
| # Apple platforms | ||
| /src/backends/cg.rs @madsmtm | ||
|
|
||
| # DRM/KMS (no maintainer) | ||
| /src/backends/kms.rs | ||
|
|
||
| # Redox | ||
| /src/backends/orbital.rs @jackpot51 | ||
|
|
||
| # Wayland | ||
| /src/backends/wayland @ids1024 | ||
|
|
||
| # Web | ||
| /src/backends/web.rs @daxpedda | ||
|
|
||
| # Windows | ||
| /src/backends/win32.rs @notgull | ||
|
|
||
| # X11 | ||
| /src/backends/x11.rs @notgull |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!-- Thanks for contributing! --> | ||
|
|
||
| <!-- If your pull request only touches a single backend, feel free to prune the following list: --> | ||
|
|
||
| Tested on: | ||
| - [ ] AppKit (tier 1) | ||
| - [ ] Wayland (tier 1) | ||
| - [ ] Win32 (tier 1) | ||
| - [ ] XCB / Xlib (tier 1) | ||
| - [ ] Android NDK (tier 2) | ||
| - [ ] UIKit (tier 2) | ||
| - [ ] Web (tier 2) | ||
| - [ ] DRM/KMS (tier 3) | ||
| - [ ] Orbital (tier 3) | ||
|
|
||
| <!-- Note that it's okay to leave these unchecked, this is just a signal to the reviewer that they need to test it themselves. PRs may be merged when all tier 1 backends have been tested. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,35 +27,32 @@ pixels when its GPU-accelerated post-processing effects are not needed. | |
| This library is dual-licensed under MIT or Apache-2.0, just like minifb and rust. Significant portions of code were taken | ||
| from the minifb library to do platform-specific work. | ||
|
|
||
| ## Platform support | ||
|
|
||
| Softbuffer supports many platforms, some to a higher degree than others. This is codified with a "tier" system. Tier 1 platforms can be thought of as "tested and guaranteed to work", tier 2 as "will likely work", and tier 3 as "builds in CI". | ||
|
|
||
| The current status is as follows (based on the list of platforms exposed by [`raw-window-handle`](https://crates.io/crates/raw-window-handle)): | ||
|
|
||
| | Platform | Tier | Available | | ||
| | ------------------ | ---- | --------- | | ||
| | AppKit (macOS) | 1 | ✅ | | ||
| | Wayland | 1 | ✅ | | ||
| | Win32 | 1 | ✅ | | ||
| | XCB / Xlib (X11) | 1 | ✅ | | ||
| | Android NDK | 2 | ✅ | | ||
| | UIKit (iOS) | 2 | ✅ | | ||
| | WebAssembly | 2 | ✅ | | ||
| | DRM/KMS | 3 | ✅ | | ||
| | Orbital | 3 | ✅ | | ||
| | GBM/KMS | N/A | ❌ | | ||
|
Member
There was a problem hiding this comment. Are users interested in a GBM backend - which uses DRM/KMS?
Member
Author
There was a problem hiding this comment. Idk how GBM works, I just kinda filled out the table based on
Member
There was a problem hiding this comment. As long as the
Member
Author
There was a problem hiding this comment. I think it makes sense to list it here anyhow, regardless of whether we ever intend to support it, since it's part of |
||
| | Haiku | N/A | ❌ | | ||
| | OpenHarmony OS NDK | N/A | ❌ ([#261](https://github.com/rust-windowing/softbuffer/pull/261)) | | ||
| | WinRT | N/A | ❌ | | ||
| | UEFI | N/A | ❌ ([#282](https://github.com/rust-windowing/softbuffer/pull/282)) | | ||
|
|
||
| Beware that big endian targets are much less tested, and may behave incorrectly. | ||
|
|
||
| Pull requests to add support for new platforms are welcome! | ||
|
|
||
| ## WebAssembly | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would commit to
1on Android too, if it weren't for the remaining issues inandroid-activityandwinit.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm kind of of the same mind for iOS / UIKit (and Web to a certain extent), the problems there aren't in Softbuffer but in Winit. But effectively, it does mean that Android and iOS are less supported, hence tier 2.