alex/librashader
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

doc: clarify compatibility

Browse source
This commit is contained in:
chyyran 2022-12-11 01:19:25 -05:00
parent e428e02dfe
commit d5f0bece0b
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -9,7 +9,7 @@ librashader (*/ˈli:brəʃeɪdɚ/*) is a preprocessor, compiler, and runtime for
Heavily WIP.
## Supported Render APIs
librashader supports OpenGL 3, OpenGL 4.6, Vulkan, DirectX 11, and DirectX 12. Support is WIP for all runtimes except OpenGL 3. Older versions
librashader supports OpenGL 3, OpenGL 4.6, Vulkan, DirectX 11, and DirectX 12. Older versions
of DirectX and OpenGL, as well as Metal, are not supported (but pull-requests are welcome).
| **API** | **Status** | **`librashader` feature** |
@ -23,6 +23,7 @@ of DirectX and OpenGL, as well as Metal, are not supported (but pull-requests ar
| DirectX 9 | ❌ | |
| Metal | ❌ | |
✔ = Render API is supported — 🚧 = Support is in progress — ❌ Render API is not supported
## Usage
🚧 *`librashader_ld` is WIP* 🚧
@ -84,6 +85,11 @@ Please report an issue if you run into a shader that works in RetroArch, but not
Most, if not all shader presets should work fine on librashader. The runtime specific differences should not affect the output,
and are more a heads-up for integrating librashader into your project.
Compatibility issues may arise with framebuffer copies for original history, but I have not found any yet;
if it does end up that this results in actual rendering differences I may change the implementation to be more in line
with RetroArch's copy implementation. However, since the Vulkan runtime already uses `vkCmdCopyImage` it is likely that it will
not cause issues.
## License
The core parts of librashader such as the preprocessor, the preset parser,
the reflection library, and the runtimes, are all licensed under the Mozilla Public License version 2.0.