Skip to content

Commit

Permalink
Specify that RenderDoc is not compatible with Vulkan.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
serenity4 committed Jul 7, 2024
1 parent 29e253a commit 174a8bb
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/src/utility.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,17 @@ Feel free to check out the official [Vulkan website](https://www.vulkan.org/) fo

### NVIDIA Nsight Systems

[NVIDIA Nsight Systems](https://developer.nvidia.com/nsight-systems) is a tool developed by NVIDIA to profile applications, showing both CPU and GPU usage. It can be very useful for analyzing the balance between CPU and GPU usage, as well as troubleshoot general performance bottlenecks. However, it only outputs high-level information regarding GPU tasks. Therefore, to catch GPU bottlenecks on a low-level (such as inside shaders) one should instead use a dedicated profiler such as [Nsight Graphics](@ref nsight-graphics) or [Renderdoc](@ref renderdoc).
[NVIDIA Nsight Systems](https://developer.nvidia.com/nsight-systems) is a tool developed by NVIDIA to profile applications, showing both CPU and GPU usage. It can be very useful for analyzing the balance between CPU and GPU usage, as well as troubleshoot general performance bottlenecks. However, it only outputs high-level information regarding GPU tasks. Therefore, to catch GPU bottlenecks in a fine-grained manner (such as inside shaders) one should instead use a dedicated profiler such as [Nsight Graphics](@ref nsight-graphics).

### [NVIDIA Nsight Graphics](@id nsight-graphics)

[Nsight Graphics](https://developer.nvidia.com/nsight-graphics) dives deeper into the execution details of an application and provides detailed information regarding graphics pipelines, shaders and so on. This is a tool of choice to consider for NVIDIA GPUs once the GPU is identified as a bottleneck with Nsight Systems.

### [Renderdoc](@id renderdoc)
### RenderDoc

[Renderdoc](https://renderdoc.org/) plays a similar role to Nsight Graphics for a wider range of GPUs. It is open-source and community-maintained.
[RenderDoc](https://renderdoc.org/) plays a similar role to Nsight Graphics for a wider range of GPUs. It is open-source and community-maintained.

!!! warning
It is not yet known whether RenderDoc is supported with Vulkan.jl, due to the requirement of [going through the UI](https://github.com/baldurk/renderdoc/issues/3301#issuecomment-2090985133) and providing an executable to enable it. In our case, we have a language runtime executable (`julia`) that loads Vulkan dynamically, and not a compiled executable linked to Vulkan; this difference *might* prevent Vulkan.jl from working with RenderDoc. You are encouraged to follow [this issue](https://github.com/JuliaGPU/Vulkan.jl/issues/53) for more information. Feel free to share your experience there with RenderDoc to help clarify any potential issue.
*RenderDoc is not supported with Vulkan.jl; see [this issue](https://github.com/JuliaGPU/Vulkan.jl/issues/53) for more details on the matter.*

### CPU implementation of Vulkan

Expand Down

0 comments on commit 174a8bb

Please sign in to comment.