A small wrapper for the renderdoc in-app api in python.
Project description
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
:
pip install pyRenderdocApp
The package includes renderdoc binaries for Windows and Mac.
Example
Here's what the example from the RenderDoc documentation (link) would look like in python:
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
:
pip install build twine hatch
Build the wheel:
python -m build
Then to upload the package to PyPI, do:
twine upload dist/pyrenderdocapp*
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyrenderdocapp-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 573a643d3e48fc704263d51924bfb312f8fe7ad3cb2847a38e164e2889df56c8 |
|
MD5 | 8c8308210f5a19fe4769f0b38caa4c25 |
|
BLAKE2b-256 | 1e0cc91ee78241fc51e730716492a99489d4c184c13f515257c4ca4b6ba51b55 |