From 789f997e535d7413804b459282eb52f9278f05b1 Mon Sep 17 00:00:00 2001 From: Patrick Stephen Date: Sat, 30 Oct 2021 15:11:41 -0500 Subject: [PATCH] oak: add COMPATIBILITY.md --- COMPATIBILITY.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 COMPATIBILITY.md diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md new file mode 100644 index 00000000..9cfe2efd --- /dev/null +++ b/COMPATIBILITY.md @@ -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.