lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-09-26 07:35:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Give specific instructions on writing UI extensions

Browse Source 
* This goes through a worked example of a simple extension.
This commit is contained in:
baldurk
2021-01-27 16:05:03 +00:00
parent ea51a816ed
commit dabd2a803a
7 changed files with 407 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how/how_python_extension.rst
+4 -4
View File
@@ -1,9 +1,9 @@
How do I write a python extension?
==================================
How do I register a python extension?
=====================================
RenderDoc supports python extensions using the :doc:`existing python API <../python_api/index>`. These extensions can be configured to be persistent and load whenever the RenderDoc UI does, allowing users to extend the program with custom functionality.
Example extensions can be found at the `community contributed repository <https://github.com/baldurk/renderdoc-contrib>`_.
Example extensions can be found at the `community contributed repository <https://github.com/baldurk/renderdoc-contrib>`_. More information on writing an extension is available at :doc:`../python_api/ui_extensions`.
Creating extensions
-------------------
@@ -62,4 +62,4 @@ A python extension when loaded will have a ``register`` function called in its m
Optionally you can define an ``unregister`` function to be called if the extension is reloaded. This takes no parameters and is simply an opportunity to clean-up or remove anything persistent that shouldn't hang around, before ``register`` is called again.
Extensions use the full :doc:`python API <../python_api/index>` with all of the power that comes with it. There are interfaces geared specifically towards extensions in :doc:`the qrenderdoc module <../python_api/qrenderdoc/extensions>` which allow registering callbacks for menu items.
Extensions use the full :doc:`python API <../python_api/index>` with all of the power that comes with it. There are interfaces geared specifically towards extensions in :doc:`the qrenderdoc module <../python_api/qrenderdoc/extensions>` which allow registering callbacks for menu items.