Commit Graph
77 Commits
Author SHA1 Message Date
baldurk 8dd7692282 Improve parsing of enums in buffer formatter
* Add a [[flags]] annotation for enums that should bitmask-match, and add a
  member to each interpreted enum value leaf to provide the string name.
2026-08-13 21:05:16 +01:00
baldurk e20c2b9985 Expose buffer interpretation helpers to python 2026-08-13 21:05:15 +01:00
baldurk bb23fbc741 Remove 'always load' extra opt-in for extensions
* If an extension is enabled in the extension manager, it will be loaded by
  default after that until disabled
2026-08-13 21:05:13 +01:00
baldurk 4bd0245975 Move new extension creation wizard to python scripting
* We remove the operations and interactions from the extension manager and leave
  it purely for browsing extensions and enabling/disabling them.
2026-08-13 21:05:13 +01:00
baldurk 1292134b47 Add detailed per-topic writeups of relevant areas for python scripts 2026-08-13 21:05:11 +01:00
baldurk eb27bd34bf Rename python shell to python scripting window in docs 2026-08-13 21:05:11 +01:00
baldurk d4130ce42a Enable nitpicking in sphinx documentation build and fix some broken refs 2026-08-13 17:46:49 +01:00
baldurk bb4017a965 Add a spellchecking mode for sphinx and fix some typos
* The worst one was Persistant -> Persistent. This involved renaming
  PersistentConfig but the impact of that is considered minimal enough to be
  worth fixing.
2026-08-13 17:46:47 +01:00
baldurk 16a24406b2 In python extensions, set pyrenderdoc global before calling register() 2026-08-13 17:46:44 +01:00
baldurk 10272fa35b Make most extension json fields optional
* We require `extension_api` and `version` fields in case needed for future
  compatibility
2026-08-13 17:46:44 +01:00
baldurk 565fe17ba2 Add API and usage documentation for custom annotations system 2026-01-28 14:42:11 +00:00
baldurk dec378eb9b Remove documentation note about outdated compute shader debug limitation 2025-10-31 15:43:37 +00:00
baldurk 34c3c40787 Document the PDB search priority/algorithm
* This follows PIX's algorithm in most places which although undocumented is
  something many people expect to work. It deviates only when there would be
  significant performance penalties for little gain.
2025-05-02 10:48:10 +01:00
baldurk e690587683 Update docs for D3D12 shader debugging 2024-12-20 12:03:34 +00:00
baldurk 7fe2749b38 Add custom D3D12 interface for per-heap descriptor naming by index 2024-12-13 21:19:47 +00:00
baldurk f4d579ffaa Allow specifying tighter alignment than natural for odd buffer cases 2024-10-30 10:33:40 +00:00
baldurk 6408799b5d Allow specifying scalar pointers in buffer formatter 2024-10-19 01:21:48 +01:00
baldurk 41adeb65b1 Add UI to manage the list of ignored PDBs for callstacks. Closes #3329 2024-06-27 13:54:41 +01:00
baldurk 2b40a17f8a Add packing rule for bitfield packing/straddling a la #pragma pack(1) 2024-06-27 13:54:41 +01:00
Jake Turner 7d2094d52b Add a link to "below section" to the buffer viewer struct docs 2023-11-16 09:00:14 +00:00
William Pearson a64c24ff96 Add missing brackets to docs/how/how_buffer_format.rst 2023-11-09 17:57:02 +00:00
baldurk 24da6390eb Document the new methods of generating SPIR-V shader debug information 2022-11-24 22:58:12 +00:00
baldurk d7404bb66d Fix missing newline in docs code snippet 2022-05-20 17:00:47 +01:00
baldurk e4751e66f3 Update docs for buffer viewer changes 2022-05-20 14:15:31 +01:00
baldurk 949165d739 Split mesh and buffer viewer documentation up
* There's no reason to make users aware that the mesh viewer and buffer viewer
  are implemented in a common way, they are very different and should be
  documented separately.
* This hasn't updated the buffer viewer documentation with the recently added
  features.
2022-05-20 13:37:26 +01:00
baldurk 8aa0390948 Add string messages to returned result codes to display to user
* Most of the main entry points that can fail with relevant reasons now has a
  way of specifying a message to return with it. This message can be displayed
  to the user to give more information or context about an error.
2022-04-26 16:21:54 +01:00
Bertrand Guay-Paquet cb0dc39bf3 Add link to the contrib repository for custom visualisation 2022-04-22 13:49:56 +01:00
baldurk eb1e625b96 Add better documentation for how to specify separate shader debug info 2022-03-30 14:53:20 +01:00
baldurk 9c1eeed29b Fix copy-paste error with GLSL unsigned integer texture declarations 2022-03-30 12:51:36 +01:00
baldurk 99adcc614f Allow multiple remote servers on one hostname, on different ports
* When a port is specified (with the usual :12345 suffix on the hostname) we use
  that for remote replay connections. We disable target control enumeration
  since that requires a port _range_ and captured applications self-assign those
  ports. Those can still be accessed via a normal unsuffixed remote specifier -
  even if there is no remote server running on the default port.
2022-02-15 17:15:48 +00:00
baldurk fdda8be9c6 Allow watch variables to specify a color-swatch with ,c. Closes #2475 2022-02-02 15:00:44 +00:00
baldurk 3ac4bd0ebd Refactor custom shaders to abstract binding differences. Closes #2458
* Newly written shaders and any updated shaders can now use pre-defined macros
  to abstract away binding differences between APIs, so custom shaders will be
  more portable in particular shaders written in HLSL for D3D or GLSL on OpenGL
  won't break on vulkan because they refer to incorrect binds.
2022-01-31 19:14:08 +00:00
Mikkel Gjoel 41d39b58ce Pass range-min/max to ApplyCustomShader
Adding rangeminmax to globals, snippet support and updated docs to match

Fixes bug in replay_output.cpp, causing a crash due to missing texhandle
2021-11-03 20:26:18 +00:00
baldurk d4a5592780 Add functionality to reset an edited shader to original. Closes #2334
* We also add the ability to toggle on/off the replacement being active without
  needing to intentionally add a compile error (and this also makes it more
  explicitly clear when the shader replacement is enabled or not. This could be
  useful for quick A/B testing between the edited version and the original.
2021-11-02 14:09:50 +00:00
baldurk b64fa99d2b Update documentation for event browser changes 2021-07-01 19:27:34 +01:00
baldurk 7149302680 Rename 'draw' or 'drawcall' to action
* There's not a good accepted terminology for this kind of event, and for
  historical reasons 'drawcall' has been the accepted term, even though
  that can be quite confusing when a dispatch or a copy is a 'drawcall'.
* This is particularly highlighted by the event browser filters where
  $draw() includes draws and dispatches, but $dispatch() only includes
  dispatches, it's hard to intuitively understand why $draw() matches all
  of these calls.
* As a result we've defined the term 'action' to cover these types of
  events in the same way that we defined 'event' in the first place to
  mean a single atomic API call.
2021-07-01 15:15:05 +01:00
baldurk fb95285ca1 Put all annotation docs into the same 'how do I' page. Refs #2285
* This page now documents both how to annotate things from code in the
  application, as well as at runtime in the UI.
2021-06-01 13:29:09 +01:00
baldurk 4d189b7f90 Add bigger warning in documentation about process injection 2021-05-28 11:46:13 +01:00
baldurk 57b6190c85 Link to proper github new issue page
* Github doesn't redirect when there are templates, which leads to users not
  seeing the template.
2021-03-23 23:09:58 +00:00
baldurk dabd2a803a Give specific instructions on writing UI extensions
* This goes through a worked example of a simple extension.
2021-01-27 16:05:03 +00:00
baldurk ae96b674c9 Update docs to reference VK_EXT_debug_utils
* VK_EXT_debug_marker still works fine but is deprecated.
2021-01-27 13:03:16 +00:00
baldurk 3f637e0d9b Link to renderdoc-contrib repository 2021-01-27 12:58:51 +00:00
baldurk 83714b825c Remove note about android support being new 2020-08-20 10:47:16 +01:00
baldurk 0ee1209a5f Mention that Vulkan supports shader debugging in documentation 2020-08-05 11:41:32 +01:00
Steve Karolewics 1d579dfb66 Update docs about D3D12 shader debugging support 2020-05-15 19:03:00 +01:00
baldurk 1d270254c1 Add documentation for replay options 2019-08-27 18:51:57 +01:00
baldurk 8c6fc67acd Make it extra clear that RenderDoc needs to find the Android SDK 2019-08-27 18:51:56 +01:00
baldurk e4333291a1 Allow using shader processing tools for custom shaders
* This is primarily useful for HLSL on Vulkan, but could be used with any other
  combination. If multiple tools can perform the conversion, the highest
  priority one is used.
2019-05-22 17:54:10 +01:00
baldurk db89f50a30 Rename Mesh Output panel to Mesh Viewer, since it displays inputs too 2019-03-08 15:40:11 +00:00
baldurk 383d8158cc Fix docs build with missing end string terminator 2018-12-14 20:42:45 +00:00