# RenderDoc

Welcome to RenderDoc - a graphics debugger currently available for Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES development on Windows, Linux, Android, and Nintendo Switch TM.

This document serves as reference guide, introductory document and explanation of which features are available in RenderDoc and how to best use them.

The latest information and discussion is always available on the GitHub repository.

# Table of Contents

- Introduction
  - License
  - How to browse this documentation
  - Important notes
  - Documentation and Tutorials
  - Contact info, Feedback, Bug reports
  - See Also
- Credits & Acknowledgements
  - 3rd Party Credits
  - Thanks
  - Contributors
- Getting started
  - Quick Start
  - FAQ
  - Gotchas & Known Issues
  - Features
  - Tips & Tricks
- Behind the scenes
  - Analytics
  - How RenderDoc works
  - OpenGL & OpenGL ES Support
  - Vulkan Support
  - D3D12 Support
- In-application API
- Python API
  - Getting Started (python)
  - Getting Started (RenderDoc UI)
  - Python development environment
  - Writing UI extensions
  - Descriptors and Bindings
  - Basic Interfaces
  - renderdoc Examples
  - qrenderdoc examples
  - renderdoc API Reference
  - qrenderdoc API Reference
- How do I …?
  - How do I capture a frame?
  - How do I use RenderDoc on Android?
  - How do I filter visible events?
  - How do I debug a shader?
  - How do I use shader debug information?
  - How do I inspect a pixel value?
  - How do I specify a buffer format?
  - How do I view a specific texture?
  - How do I view details of an object?
  - How do I capture callstacks?
  - How do I use a custom visualisation shader?
  - How do I edit a shader?
  - How do I capture and replay over a network?
  - How do I annotate a capture?
  - How do I import or export a capture?
  - How do I generate an RGP profile?
  - How do I register a python extension?
  - How do I control the replay?
- Window reference
  - Texture Viewer
  - API Inspector
  - Mesh Viewer
  - Buffer Viewer
  - Capture Dialog
  - Event Browser
  - Settings Window
  - Pipeline State
  - Shader Viewer
  - Shader Messages
  - Timeline Bar
  - Capture Connection
  - Debug Messages
  - Python Shell
  - Resource Inspector
  - Performance Counter Viewer
  - Capture Comments