mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00

Files

T

Jake Turner 6ce881d5da UI and Config support for dec/hex display option for Offsets or Sizes

Used when fields are marked as being an Offset or Size
Include simple latch to trigger a UI refresh when closing the settings dialog.
Currently only connected to if the Offset/Size format option is altered

2023-12-06 17:19:05 +00:00

behind_scenes

Update documentation to account for GL pixel history support

2023-03-31 19:56:04 +01:00

CONTRIBUTING

Update Ubuntu dependencies to prioritise newer (18.04 and up) versions

2023-09-13 16:26:29 +01:00

getting_started

Remove references to Stadia

2022-10-28 15:36:26 +01:00

how

Add a link to "below section" to the buffer viewer struct docs

2023-11-16 09:00:14 +00:00

imgs

…

include

Remove references to Stadia

2022-10-28 15:36:26 +01:00

pycharm_helpers

…

python_api

UI and Config support for dec/hex display option for Offsets or Sizes

2023-12-06 17:19:05 +00:00

sphinx_exts/sphinx_paramlinks

…

sphinx_rtd_theme_chm_friendly

Fix sphinx rtd theme for new sphinx version

2023-05-01 17:43:49 +01:00

window

Update documentation to mention meshlet solid shading

2023-11-30 14:41:14 +00:00

CODE_OF_CONDUCT.md

…

conf.py

On python 3.8+ call os.add_dll_directory in documentation build

2023-02-02 13:14:04 +00:00

CONTRIBUTING.md

Change fixed clang-format version to 15

2023-09-05 11:02:08 +01:00

credits_acknowledgements.rst

fix copyrights

2023-09-28 13:52:23 +01:00

in_application_api.rst

Update application API to 1.6.0, add capture title setter

2022-11-21 13:49:15 +00:00

index.rst

…

introduction.rst

…

make.bat

…

make.sh

…

Makefile

…

README.md

…

remove_lines.py

…

renderdoc.hhk

…

verify-docstrings.py

…

README.md

RenderDoc documentation

This readme only covers the documentation. For general information about renderdoc check out the main github repository.

Generating documentation

Generating the documentation requires the same python version as was used to build the version of RenderDoc you are testing. On windows this is likely python 3.6 as that's what comes with the repository.

The documentation uses restructured text with Sphinx. Sphinx can be acquired via pip install Sphinx

To generate the documentation, run make.bat or make.sh found in this folder. Run make help to see all options, but make html is a likely place to start.

License

RenderDoc is released under the MIT license, see the main github repository for full details.

The documentation uses Sphinx, which is BSD licensed.