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

Add a note about the python module version restriction

Browse Source
This commit is contained in:
baldurk
2020-07-24 16:33:21 +01:00
parent e147a5a6d1
commit 287bb81fca
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/examples/renderdoc_intro.rst
+5 -1
View File
@@ -12,6 +12,10 @@ Loading the Module
For this section we assume you have built a copy of RenderDoc and have the module (``renderdoc.pyd`` or ``renderdoc.so`` depending on your platform). For information on how to build see the `GitHub repository <https://github.com/baldurk/renderdoc>`_.
.. note::
You must use exactly the same version of python to load the module as was used to build it. On Windows the version of python that comes with the repository and is used by default is python 3.6.
Once you have the module, either place the module within your python's default library search path, or else insert the location of the python module into the path in your script. You can either set the ``PYTHONPATH`` environment variable or do it at the start of your script:
.. highlight:: python
@@ -118,4 +122,4 @@ The full source for this example is available below:
:download:`Download the example script <renderdoc_intro.py>`.
.. literalinclude:: renderdoc_intro.py
.. literalinclude:: renderdoc_intro.py