Skip to content

Add RenderDoc GPU debugging instructions for Copilot #1645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bghgary wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add RenderDoc GPU debugging instructions for Copilot #1645

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13baee9
Add RenderDoc GPU debugging instructions for Copilot
bghgary Mar 25, 2026
bc54fcd
Address review: fix stale references to non-existent files/flags
bghgary Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# RenderDoc + GitHub Copilot GPU Debugging

> Based on [rudybear/renderdoc-skill](https://github.com/rudybear/renderdoc-skill) — adapted for GitHub Copilot.

## Project Overview

This project provides Copilot with instructions for GPU frame capture, inspection, and debugging using `rdc-cli` (a 66-command CLI wrapping RenderDoc's Python API). Works with Vulkan, D3D11, D3D12, and OpenGL applications.

## Tools

- **rdc-cli** (`rdc`): CLI wrapping RenderDoc's Python API. Install via `pip install rdc-cli`.
- **renderdoc.pyd**: Python module from RenderDoc (built from source or from an official install).

## Environment

- `RENDERDOC_PYTHON_PATH=<path-to-renderdoc-module>` — rdc-cli uses this to find renderdoc.pyd
- Captures go in `./captures/` (or any directory you choose)
- Analysis exports (PNGs, meshes, buffers) go in `./captures/analysis/`

## Your Application (customize this section)

<!-- Replace with your application details -->
- **Executable**: `/path/to/your/app`
- **CWD requirement**: Set CWD to your project root if the app resolves assets relative to CWD
- **Debug markers**: List any debug markers your app emits (e.g., "Shadow Pass", "GBuffer Pass")
- **Scenes / modes**: List any flags or scenes relevant to your app

## Capture Requirements

- **Vulkan layer**: Must be registered (see README.md for setup)
- **Environment**: `ENABLE_VULKAN_RENDERDOC_CAPTURE=1` must be set for Vulkan apps
- **Swapchain**: The app must present frames (headless apps without `vkQueuePresentKHR` cannot be captured)
- **Capture script**: See `capture_frame.py` for an example using the RenderDoc Python API directly

## Quick Start

```bash
# Check setup
rdc doctor

# Capture a frame (adapt the capture script for your app)
python capture_frame.py

# Inspect
rdc open ./captures/my_capture.rdc
rdc info --json
rdc draws --limit 20
rdc close
```

## GPU Debugging Instructions

See `.github/instructions/renderdoc-gpu-debug.instructions.md` for the full GPU debugging instructions with workflows, recipes, and command reference.
Loading
Loading