Windows Installation

Prerequisites

  • Windows 10 / 11 64-bit
  • Python 3.12.x (exact minor version must match the renderdoc .pyd)
  • Visual Studio 2022 Build Tools with "Desktop development with C++" workload
  • Git (for building renderdoc from source)

Install rdc-cli

pip install rdc-cli

This installs the rdc command. You still need the renderdoc Python module — see below.

RenderDoc Python Module

The renderdoc Python module (renderdoc.cpython-3*.pyd) is not available on PyPI. Your Python minor version must exactly match the one used to compile the module.

Option A: RenderDoc Installer

Download and install RenderDoc for Windows. The installer places renderdoc.dll in C:\Program Files\RenderDoc. The Python bindings (.pyd) may be included depending on the installer version.

Option B: Build from Source

A cross-platform build script is planned for Phase W2. In the meantime, see scripts/build_renderdoc.py (coming in Phase W2) or build manually: 

git clone --depth 1 https://github.com/baldurk/renderdoc.git
cd renderdoc
cmake -B build -G "Visual Studio 17 2022" -DENABLE_PYRENDERDOC=ON -DENABLE_QRENDERDOC=OFF
cmake --build build --config Release
set RENDERDOC_PYTHON_PATH=%cd%\build\lib\Release

Configure RENDERDOC_PYTHON_PATH

Set the environment variable to point at the directory containing the .pyd file: 

set RENDERDOC_PYTHON_PATH=C:\path\to\renderdoc\build\lib

To make it permanent, add it via System Properties → Environment Variables.

Validate with rdc doctor

rdc doctor

A successful output on Windows shows 8 checks, including the three Windows-specific checks:

  • win-python-version — Python version matches .pyd
  • win-vs-build-tools — Visual Studio Build Tools detected
  • win-renderdoc-install — RenderDoc .dll found

Known Limitations

  • Daemon process management (rdc session start) is not yet functional on Windows. Phase W2 will implement the required OS-level process APIs.
  • All analysis commands (rdc open, rdc info, rdc shaders, etc.) will work once the daemon is running.

Troubleshooting

Python version mismatch

If rdc doctor reports a version mismatch between your running Python and the .pyd, install the matching Python version or rebuild renderdoc with your current Python.

renderdoc module not found

Ensure RENDERDOC_PYTHON_PATH points to the directory containing renderdoc.pyd (not renderdoc.dll).

vswhere.exe not found

Install Visual Studio 2022 Build Tools with the "Desktop development with C++" workload selected.