mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 09:00:44 +00:00

Files

T

baldurk 4d94209ec1 Change fixed clang-format version to 15

* We commit statically linked x64 binaries for clang-format-15 for windows and
  linux to make the transition easier for anyone running a linux distro that
  doesn't yet support llvm 15, or in future for distros that drop support for
  it.

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

behind_scenes

Update documentation to account for GL pixel history support

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

CONTRIBUTING

Change fixed clang-format version to 15

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

getting_started

Remove references to Stadia

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

how

Document the new methods of generating SPIR-V shader debug information

2022-11-24 22:58:12 +00:00

imgs

Update docs for buffer viewer changes

2022-05-20 14:15:31 +01:00

include

Remove references to Stadia

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

pycharm_helpers

Add documentation on setting up python dev environment

2021-01-27 16:05:03 +00:00

python_api

Add missing documentation reference

2023-08-01 09:44:00 +01:00

sphinx_exts/sphinx_paramlinks

Fix sphinx-paramlinks for sphinx 4.0.0

2021-05-10 17:02:48 +01:00

sphinx_rtd_theme_chm_friendly

Fix sphinx rtd theme for new sphinx version

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

window

Match SPIR-V version as much as possible when rebuilding shaders

2023-08-22 13:41:39 +01:00

CODE_OF_CONDUCT.md

Adopt v2.0 of the contributor covenant

2020-06-12 13:40:02 +01:00

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

Remove feature toggle for OpenGL Pixel History

2023-02-25 10:52:53 +00: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 some misc tweaks and updates to the docs

2021-06-29 16:55:53 +01:00

make.bat

…

make.sh

Fix some encoding issues with sphinx docs in htmlhelp builder

2020-03-09 10:57:05 +00:00

Makefile

…

README.md

Add tests for viewing depth with ClearBeforeDraw.

2019-12-20 20:11:53 +00:00

remove_lines.py

Fix some encoding issues with sphinx docs in htmlhelp builder

2020-03-09 10:57:05 +00:00

renderdoc.hhk

Split mesh and buffer viewer documentation up

2022-05-20 13:37:26 +01:00

verify-docstrings.py

Handle rdcstrpair or rdcstrpairs in function return types for docstrings

2021-05-17 15:05:13 +01:00

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.