mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-29 13:20:54 +00:00
Add documentation for shader viewer and ISA disassembly views
This commit is contained in:
@@ -9,6 +9,7 @@ Window reference
|
||||
event_browser
|
||||
settings_window
|
||||
pipeline_state
|
||||
shader_viewer
|
||||
timeline_bar
|
||||
capture_connection
|
||||
debug_messages
|
||||
|
||||
@@ -181,6 +181,8 @@ This option tries to make the disassembly of shaders easier to read by substitut
|
||||
|
||||
| :guilabel:`Vulkan Disassemblers`
|
||||
|
||||
.. _vulkan-disassem:
|
||||
|
||||
Here you can configure external tools that disassemble binary SPIR-V into a human-readable representation.
|
||||
|
||||
Some built-in tools are supported such as SPIRV-Cross and spirv-dis, for these tools if they can be auto-detected they will already be present, and they may be distributed with RenderDoc builds in case a version isn't installed on the system.
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
Shader Viewer
|
||||
=============
|
||||
|
||||
The Shader Viewer is used for displaying, editing, and debugging shaders.
|
||||
|
||||
Information about editing shaders can be found in other documents such as :doc:`../how/how_edit_shader` and :doc:`../how/how_custom_visualisation`.
|
||||
|
||||
Debugging shaders is documented in :doc:`../how/how_debug_shader`.
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
.. figure:: ../imgs/Screenshots/ShaderViewer.png
|
||||
|
||||
The shader viewer displaying a D3D11 shader
|
||||
|
||||
When opened from the :doc:`pipeline_state` for a given shader stage, the shader viewer display the shader itself as well as the input and output signatures. These signatures form the interface between this shader stage and the previous and next parts of the rendering pipeline. For example a vertex shader will list the fixed function vertex inputs, and the interpolated values that are passed to the next stage.
|
||||
|
||||
The shader viewer displays the source code in the formats that are available. When debugging information has embedded it there will be tabs for each original source file. For APIs using a bytecode IR the disassembly of that bytecode will also be displayed in a separate tab.
|
||||
|
||||
Several different disassembly forms are possible, depending on the API and available plugins and hardware support. Above the disassembly tab will be a drop-down listing the possible representations including hardware specific ISA formats like AMD GCN.
|
||||
|
||||
For Vulkan SPIR-V shaders, you can configure custom disassemblers :ref:`in the settings window <vulkan-disassem>` which allows for various customised disassemblers such as SPIRV-Cross and spirv-dis.
|
||||
|
||||
.. figure:: ../imgs/Screenshots/ShaderDisassembly.png
|
||||
|
||||
The disassembly options for a Vulkan SPIR-V shader
|
||||
Reference in New Issue
Block a user