mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 00:50:40 +00:00
baldurk
84 lines
2.7 KiB
Plaintext
84 lines
2.7 KiB
Plaintext
About:
|
|
------
|
|
|
|
RenderDoc is a debugger for graphics APIs, currently supporting OpenGL
|
|
and Vulkan.
|
|
|
|
The directory structure in the package matches how it should be
|
|
installed, most commonly under /usr but this is up to you.
|
|
|
|
After installation if you'd like to register the desktop files like
|
|
thumbnailer, shortcut, icons, etc, you'll need something along the lines
|
|
of these commands as root:
|
|
|
|
# update-desktop-database
|
|
# update-menus
|
|
# update-mime-database /usr/share/mime/
|
|
# gtk-update-icon-cache /usr/share/icons/hicolor/
|
|
|
|
Documentation is available online at https://renderdoc.org/docs and more
|
|
information in general is available on the github repository and wiki -
|
|
https://github.com/baldurk/renderdoc
|
|
|
|
|
|
Requirements:
|
|
-------------
|
|
|
|
* libxcb
|
|
* libX11
|
|
* libX11-xcb
|
|
* libGL
|
|
|
|
These should be available on any system with X installed. You can always
|
|
build RenderDoc yourself from source. For more information, github.
|
|
|
|
To run qrenderdoc, Qt is statically linked but additional system
|
|
libraries are needed:
|
|
|
|
* libstdc++ >= 6.0.21 (from GCC 5.x)
|
|
* libfontconfig1 >= 2.11.0
|
|
* libfreetype6 >= 2.4.8
|
|
* libproxy >= 0.4.7
|
|
|
|
If you get errors on run about missing GLIBCXX symbols then you likely
|
|
haven't met the libstdc++ requirement and will need to either find a
|
|
package in your distribution to install gcc 5.x, or else compile
|
|
RenderDoc from source (though you will still need gcc-5 to compile).
|
|
|
|
Vulkan Layer registration:
|
|
--------------------------
|
|
|
|
RenderDoc cannot capture Vulkan when run from binary without any
|
|
installation. Any installed package from a distribution or otherwise is
|
|
expected to have registered the Vulkan layer as appropriate, but if you
|
|
are running binaries loose then the renderdoccmd utility will prompt you
|
|
to register the layer. This involves placing an appropriate .json file
|
|
under $HOME/.local/vulkan, or optionally in /etc if desired (and if the
|
|
tool is run with appropriate permissions).
|
|
|
|
|
|
License:
|
|
--------
|
|
|
|
RenderDoc is distributed under the MIT licsense, both in binary form and
|
|
the source code itself. You can find the full detail including 3rd party
|
|
licenses in the source repository as LICENSE.md
|
|
|
|
|
|
Reporting bugs:
|
|
---------------
|
|
|
|
Bugs should be reported to the github bug tracker,
|
|
(https://github.com/baldurk/renderdoc/issues) or directly via email to
|
|
the maintainer - Baldur Karlsson <baldurk@baldurk.org> - if the report
|
|
contains sensitive information or you don't have a github account.
|
|
|
|
|
|
Sending patches/contributions:
|
|
------------------------------
|
|
|
|
Please submit your contributions as pull requests on github
|
|
(https://github.com/baldurk/renderdoc). Please follow the
|
|
docs/CONTRIBUTING.md guidelines available in the repository regarding
|
|
code formatting with clang-format and commit message formatting.
|