lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-30 10:25:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable nitpicking in sphinx documentation build and fix some broken refs

Browse Source
This commit is contained in:
baldurk
2026-08-13 17:46:49 +01:00
parent 173510cc8d
commit d4130ce42a
16 changed files with 84 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/examples/renderdoc_intro.rst
+1 -1
View File
@@ -67,7 +67,7 @@ Before doing anything, we must initialise the replay API. We do that by calling
rd.InitialiseReplay(rd.GlobalEnvironment(), [])
To begin with, we use :py:meth:`~renderdoc.OpenCaptureFile` to obtain a :py:class:`~renderdoc.CaptureFile` instance. This gives us access to control over a capture file at a meta level. For more information see the :py:class:`CaptureFile` reference - the interface can also be used to create.
To begin with, we use :py:meth:`~renderdoc.OpenCaptureFile` to obtain a :py:class:`~renderdoc.CaptureFile` instance. This gives us access to control over a capture file at a meta level. For more information see the :py:class:`renderdoc.CaptureFile` reference - the interface can also be used to create.
To open a file, use :py:meth:`~renderdoc.CaptureFile.OpenFile` on the :py:class:`~renderdoc.CaptureFile` instance. This function allows conversion from other formats via an importer, but here we'll use it just for opening a regular ``rdc`` file. It returns a :py:class:`~renderdoc.ResultDetails` which can be used to determine what went wrong in the event that there was a problem. We then check that the capture uses an API which can be replayed locally - for example not every platform supports ``D3D11``, so on linux this would return no local replay support.