Skip to content

Commit

Permalink
oak: add COMPATIBILITY.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@200sc
200sc committed Oct 30, 2021
1 parent 56b9471 commit 789f997
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions COMPATIBILITY.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Oak Compatibility Matrix

| OS / Target | Rendering | Multi-Window | Audio | Joysticks | Cgo Required |
|:------------:|:-----------:|:------------:|:-----------:|:-----------------:|:------------:|
| windows | Yes | Yes | Yes | XInput | No |
| linux | Yes | Yes | Yes | XBox 360 (#133) | No |
| osx (darwin) | Yes | Yes | No (#89) | No (#87) | Yes (#175) |
| wasm+js | Yes | N/A | No (#174) | No (#173) | No |
| android | No (#49) | N/A | N/A | N/A | N/A |
| ios | No (#49) | N/A | N/A | N/A | N/A |

## Window Options

| OS / Target | Get Cursor Position* | Fullscreen | Borderless | Set Title** | Reposition | Window On Top | Hide Cursor | Show Notification | Set Tray Icon |
|:------------:|:--------------------:|:----------:|:----------:|:-----------:|:----------:|:-------------:|:-----------:|:-----------------:|:-------------:|
| windows | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| linux | Yes | Yes | Yes | No | Yes | No | No | No | No |
| osx (darwin) | Yes | Yes | Yes | No | Yes | No | Yes | No | No |
| wasm+js | No | No | N/A | N/A | N/A | N/A | No | No | No |

* This refers to asking the OS where the cursor is, which can inform the absolute position of the cursor even if it is outside of the Oak window. Oak can always tell you where the cursor is if it is within the Oak window.
** Changing the title of the window after it is created.

## Other Compatibility Issues

* Issue #171: Under an unknown condition, Oak fails to render or intialize on OSX.

0 comments on commit 789f997

Please sign in to comment.