https://github.com/space928/pyrenderdocapp
A small wrapper for the renderdoc in-app api in python.
https://github.com/space928/pyrenderdocapp
directx opengl python renderdoc vulkan
Last synced: about 24 hours ago
JSON representation
A small wrapper for the renderdoc in-app api in python.
- Host: GitHub
- URL: https://github.com/space928/pyrenderdocapp
- Owner: space928
- License: mit
- Created: 2023-12-05T15:11:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-24T07:00:14.000Z (over 2 years ago)
- Last Synced: 2026-04-03T19:36:48.905Z (about 2 months ago)
- Topics: directx, opengl, python, renderdoc, vulkan
- Language: Python
- Homepage:
- Size: 18.6 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyRenderdocApp
[](https://pypi.org/project/pyRenderdocApp/)
A small wrapper for the renderdoc in-app api in python.
This project wraps the methods exposed by `renderdoc_app.h` with the python ctypes API. It's designed to closely match
the official API, with the main difference being that the function and parameter names have been converted to snake case
(ie: `GetAPIVersion()` --> `get_api_version()`). The original doc comments from `renderdoc_app.h` have also been ported
over (and modified where appropriate). For more information about using the Renderdoc in-app API, read the official
documentation: https://renderdoc.org/docs/in_application_api.html
## Installing
Install with `pip`:
```bash
pip install pyRenderdocApp
```
The package includes renderdoc binaries for Windows and Mac.
## Example
Here's what the example from the RenderDoc documentation ([link](https://renderdoc.org/docs/in_application_api.html#_CPPv416RENDERDOC_GetAPI17RENDERDOC_VersionPPv)) would look like in python:
```py
from pyRenderdocApp import load_render_doc
# At init, load the renderdoc api
rdoc_api = load_render_doc()
# To start a frame capture, call StartFrameCapture.
# You can specify None, None for the device to capture on if you have only one device and
# either no windows at all or only one window, and it will capture from that device.
# See the documentation for a longer explanation
rdoc_api.start_frame_capture(None, None)
# Your rendering should happen here
# Stop the capture
rdoc_api.end_frame_capture(None, None)
```
## Building
Build using `build`:
```bash
pip install build twine hatch
```
Build the wheel:
```bash
python -m build
```
Then to upload the package to PyPI, do:
```bash
twine upload dist/pyrenderdocapp*
```