lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-05 01:20:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for v1.0

Browse Source 
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
  performance counter viewer, as well as new features like saving
  bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
This commit is contained in:
baldurk
2018-02-25 23:27:13 +00:00
parent 1cd8559d0c
commit 933c00985d
175 changed files with 1187 additions and 711 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/index.rst
+1 -1
View File
@@ -3,7 +3,7 @@ Python API
The python API is accessible via scripting in the QRenderDoc tool. This gives access to both the base replay API that the UI is built on top of, as well as scripting ability for the UI itself and some higher level utility functionality.
It is also possible to build a standalone module of just the base API which can be loaded into python and used for scripting directly without the UI. Due to the inherent difficulty of distributing C python modules this isn't included by default in distributed builds at the time of writing, but is generated by default in source builds - ``renderdoc.py`` and ``_renderdoc.dll`` or ``_renderdoc.so`` make up this module.
It is also possible to build a standalone module of just the base API which can be loaded into python and used for scripting directly without the UI. Due to the inherent difficulty of distributing C python modules this isn't included by default in distributed builds at the time of writing, but is generated by default in source builds - ``renderdoc.pyd`` on windows or ``renderdoc.so`` elsewhere.
.. toctree::
base/index