Refresh/README.md

38 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2021-01-23 08:52:51 +00:00
[![Build Status](https://gitea.drone.moonside.games/api/badges/MoonsideGames/Refresh/status.svg)](https://gitea.drone.moonside.games/MoonsideGames/Refresh)
2021-01-05 07:31:56 +00:00
2020-12-15 23:00:46 +00:00
This is Refresh, an XNA-inspired 3D graphics library with modern capabilities.
License
-------
Refresh is licensed under the zlib license. See LICENSE for details.
About Refresh
-------------
Refresh is directly inspired by FNA3D and intended to be a replacement for XNA's Graphics namespace.
XNA 4.0 is a powerful API, but its shader system is outdated and certain restrictions are awkward to handle in a modern context.
2021-01-19 04:54:34 +00:00
In the way that XNA was "one step above" DX9, Refresh intends to be "one step above" Vulkan. It should map nicely to modern graphics APIs.
2020-12-17 20:47:43 +00:00
Refresh will initially have a Vulkan runtime implementation. Support for other APIs like DX12 may come later.
2020-12-31 07:22:34 +00:00
For shaders, we consume SPIR-V bytecode.
2020-12-15 23:00:46 +00:00
Dependencies
------------
2020-12-17 02:12:20 +00:00
Refresh depends on SDL2 for portability.
2020-12-15 23:27:06 +00:00
Refresh never explicitly uses the C runtime.
2020-12-15 23:00:46 +00:00
Building Refresh
----------------
For *nix platforms, use CMake:
$ mkdir build/
$ cd build/
$ cmake ../
$ make
2020-12-18 00:57:55 +00:00
For Windows, use the Refresh.sln in the "visualc" folder.
2020-12-15 23:00:46 +00:00
Want to contribute?
-------------------
2020-12-15 23:28:39 +00:00
Issues can be reported and patches contributed via Github:
2020-12-15 23:00:46 +00:00
2020-12-15 23:28:39 +00:00
https://github.com/thatcosmonaut/Refresh