mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 01:20:42 +00:00
Clarify renderdoc module vs library for python
This commit is contained in:
@@ -17,8 +17,6 @@ Build instructions for your platform are available `on github <https://github.co
|
||||
|
||||
RenderDoc requires pythonXY.lib, include files such as include/Python.h, as well as a .zip of the standard library. If you installed python with an installer you have the first two, and can generate the standard library zip by zipping the contents of the Lib folder. If you downloaded the embeddable zip distribution you will only have the standard library zip, you need to obtain the include files and ``.lib`` file separately.
|
||||
|
||||
Once you have compiled RenderDoc copy the python module into the same folder as the main renderdoc library. On windows this means copying out of the ``pymodules`` subdirectory, on linux this will likely be the case already. We do this to keep things simple, so the python module can load the library without needing to change ``PATH``.
|
||||
|
||||
Python Setup for VS Code
|
||||
------------------------
|
||||
Using the same python version as the RenderDoc build used (Python 3.6 by default).
|
||||
|
||||
@@ -31,7 +31,7 @@ Once you have the module, either place the module within your python's default l
|
||||
|
||||
sys.path.append('/path/to/renderdoc/module')
|
||||
|
||||
Additionally, the renderdoc python module needs to be able to load the main renderdoc library - the module library it self just contains stubs and python wrappers for the C++ interfaces. You can either place the renderdoc library in the system library paths, or solve it in a platform specific way. For example on windows you can either place ``renderdoc.dll`` in the same directory as the python module, or append to ``PATH``. On Python 3.8 and above ``PATH`` is no longer searched by default so you need to explicitly add the DLL folder:
|
||||
Additionally, the renderdoc python module needs to be able to load the main renderdoc library (``renderdoc.dll`` or ``librenderdoc.so`` depending on your platform) - the module library itself just contains stubs and python wrappers for the C++ interfaces. You can either place the renderdoc library in the system library paths, or solve it in a platform specific way. For example on windows you can either place ``renderdoc.dll`` in the same directory as the python module, or append to ``PATH``. On Python 3.8 and above ``PATH`` is no longer searched by default so you need to explicitly add the DLL folder:
|
||||
|
||||
.. highlight:: python
|
||||
.. code:: python
|
||||
|
||||
Reference in New Issue
Block a user