lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-30 10:25:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document problems with VS Code path mappings

Browse Source 
* When adding a 'remote attach' target in VS Code it adds path mappings that
  then break itself when debugging on the same machine :(.
This commit is contained in:
baldurk
2026-08-13 21:05:15 +01:00
parent e20c2b9985
commit 73a125ed41
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/ide_integration.rst
+4 -1
View File
@@ -46,7 +46,7 @@ Python Stubs
Python modules written in C like RenderDoc's can't have type annotations that are key to providing good autocomplete in an IDE. The standard alternative is to provide python 'stub' files which are written in pure python and have no implementations, only signatures and other type annotations.
RenderDoc generates appropriate stubs within your application data directory with one per version as well as a rolling 'latest' version. On Windows this is ``%APPDATA%\qrenderdoc\pystubs`` and on linux it's ``~/.local/share/qrenderdoc/pystubs``.
RenderDoc generates appropriate stubs within your application data directory with one per version as well as a rolling 'latest' version. On Windows this is :file:`%APPDATA%\qrenderdoc\pystubs` and on linux it's :file:`~/.local/share/qrenderdoc/pystubs`.
Typically you can use the ``latest`` version without problems, but if you are targeting a specific version of RenderDoc you can use one of the versioned directories.
@@ -79,6 +79,9 @@ If RenderDoc has detected your installation of VS Code it also provides convenie
You may also need to check the ``User Uncaught Exceptions`` setting under ``Breakpoints`` to properly trap exceptions that are thrown in the python code, as otherwise RenderDoc will catch them itself for display.
.. warning::
By default, RenderDoc creates a :file:`.vscode` folder and :file:`launch.json` configuring the debugging setup for attaching, but it will not overwrite an existing file. Be warned that VS Code's default remote attach configuration contains "path mappings" which can cause RenderDoc debugging to not function correctly, since remote attach is normally not used on the same folder. It is strongly recommended you delete any path mappings and restart RenderDoc & VS Code if you have already tried to attach.
Next steps
----------