Skip to content

Commit

Permalink
[Docs] Added known issues subsection to build documentation.
Browse files Browse the repository at this point in the history
Also added construction icon to Vulkan support in Android since it's not working at the moment.
  • Loading branch information
LukasBanana committed Sep 22, 2024
1 parent cbec0d3 commit ab3372a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ with Introduction, Hello Triangle Tutorial, and Extensibility Example with [GLFW
| <img src="docu/Icons/linux.svg" height="20" /> GNU/Linux | [![GNU/Linux CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_linux.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_linux.yml) | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: | N/A |
| <img src="docu/Icons/macos.svg" height="20" /> macOS | [![macOS CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_macos.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_macos.yml) | N/A | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: |
| <img src="docu/Icons/ios.svg" height="20" /> iOS | [![iOS CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_ios.yml) | N/A | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: |
| <img src="docu/Icons/android.svg" height="20" /> Android | [![Android CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_android.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_android.yml) | N/A | N/A | :heavy_check_mark: | :heavy_check_mark: | N/A |
| <img src="docu/Icons/android.svg" height="20" /> Android | [![Android CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_android.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_android.yml) | N/A | N/A | :construction: | :heavy_check_mark: | N/A |
| <img src="docu/Icons/wasm.svg" height="20" /> Wasm | [![WebAssembly CI](https://github.com/LukasBanana/LLGL/actions/workflows/ci_wasm.yml/badge.svg)](https://github.com/LukasBanana/LLGL/actions/workflows/ci_wasm.yml) | N/A | N/A | N/A | :heavy_check_mark: | N/A |


Expand Down
10 changes: 10 additions & 0 deletions docu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ On Windows, MSYS2 can be used to run *BuildAndroid.sh*.
<img src="Showcase/Showcase_Build_AndroidStudio.png" alt="Screenshot missing: AndroidStudio Build Showcase" style="max-width:600px;width:70%;height:auto;">
</p>

##### Known issues

Currently only the GLES backend is supported for Android. Vulkan backend compiles but is not stable and untested at the moment.


## GNU/Linux

Expand Down Expand Up @@ -84,3 +88,9 @@ Then launch your web browser of choice and open the URL http://localhost:8000/.
<img src="Showcase/Showcase_Build_Wasm.png" alt="Screenshot missing: HTML5 Example Showcase" style="max-width:600px;width:70%;height:auto;">
</p>

##### Known issues

The **WebGL backend does not work correctly on Safari**. There is a workaround which detects Safari browsers to disable anti-aliasing which mitigates the issue on Intel based Macs.
On all ARM based Macs and iOS devices, Safari shows synchronization issues that mostly affect buffer updates via `glBufferSubData` making it look as if staging buffers
are not synchronized between CPU and GPU, even though WebGL does not have a concept of staging buffers like Vulkan or D3D.

0 comments on commit ab3372a

Please sign in to comment.