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

Files

T

baldurk 7ff7e0a71d Replace fixed C arrays with wrapper class in public interface

* These map more naturally to python tuples and are easier to wrap in and out.
* We also tidy up the FloatVecVal etc and standardise the members of
  ShaderValue.

2020-12-09 18:16:08 +00:00

behind_scenes

Update docs as vulkan pixel history and shader debugging are supported

2020-07-22 17:31:20 +01:00

CONTRIBUTING

Add Fedora dependencies

2020-11-05 17:11:10 +00:00

getting_started

…

how

Remove note about android support being new

2020-08-20 10:47:16 +01:00

imgs

…

include

…

pycharm_helpers

Add a modified and improved version of PyCharm's skeleton generator

2020-12-09 15:18:27 +00:00

python_api

Replace fixed C arrays with wrapper class in public interface

2020-12-09 18:16:08 +00:00

sphinx_exts/sphinx_paramlinks

…

sphinx_rtd_theme_chm_friendly

…

window

Document the new custom shader directories setting

2020-07-22 17:34:40 +01:00

CODE_OF_CONDUCT.md

…

conf.py

Replace fixed C arrays with wrapper class in public interface

2020-12-09 18:16:08 +00:00

CONTRIBUTING.md

Move issue/pull request templates to .github folder and split up

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

credits_acknowledgements.rst

Update to AGS 6.0.1

2020-11-24 16:12:20 +00:00

in_application_api.rst

Update version number on in-application API documentation

2020-08-05 11:41:31 +01:00

index.rst

…

introduction.rst

…

make.bat

…

make.sh

…

Makefile

…

README.md

…

remove_lines.py

…

renderdoc.hhk

…

verify-docstrings.py

Check that all complex struct members that have :type: in docstrings

2020-12-09 15:18:27 +00: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.