Skip to content

Commit

Permalink
Clarify Vulkan compilation and extension/version requirements in Remo…
Browse files Browse the repository at this point in the history
…tery.h and README
  • Loading branch information
Valakor committed Jan 14, 2024
1 parent 70a13a9 commit e7141d6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/Remotery.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ Compiling
-I lib -pthread -lm
* Vulkan - Ensure your include directories are set such that the Vulkan headers can be
included with the statement: #include <vulkan/vulkan.h>.
included with the statement: #include <vulkan/vulkan.h>. Currently the Vulkan implementation
requires either Vulkan 1.2+ with the "hostQueryReset" and "timelineSemaphore" features enabled,
or < 1.1 with the "VK_EXT_host_query_reset" and "VK_KHR_timeline_semaphore" extensions. The
extension "VK_EXT_calibrated_timestamps" is also always required.
You can define some extra macros to modify what features are compiled into Remotery. These are
documented just below this comment.
Expand Down
6 changes: 6 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ Compiling
([devel/remotery](https://www.freshports.org/devel/remotery/)) and modify the port's
Makefile if needed. There is also a package available via `pkg install remotery`.

* Vulkan - Ensure your include directories are set such that the Vulkan headers can be
included with the statement: `#include <vulkan/vulkan.h>`. Currently the Vulkan implementation
requires either Vulkan 1.2+ with the `hostQueryReset` and `timelineSemaphore` features enabled,
or < 1.1 with the `VK_EXT_host_query_reset` and `VK_KHR_timeline_semaphore` extensions. The
extension `VK_EXT_calibrated_timestamps` is also always required.

You can define some extra macros to modify what features are compiled into Remotery:

Macro Default Description
Expand Down

0 comments on commit e7141d6

Please sign in to comment.