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

Files

T

follower 3471e64c8f Fix incorrect link for include-bin credit.

The current link appears to be an accidental duplication of the URL from the project listed immediately above.

This commit appears to be the origin of the duplicated URL: https://github.com/baldurk/renderdoc/commit/b5c7944038572eebffde32e1279c45c4f6d84153#diff-4673a3aba01813b595de187a7a6e9e63a3491d55821606fecd9f13a10c188a1dL98

Note: This "correct" link is to the original repository URL which appears to no longer exist.

For reference:

 * Original commit with the inclusion of `include-bin`: https://github.com/baldurk/renderdoc/commit/864fdbe179b6c1f20cae7c753fb018bec74b5738

 * Original issue which lead to the inclusion: https://github.com/baldurk/renderdoc/issues/314#issuecomment-238204556

2022-02-05 18:53:25 +00:00

behind_scenes

Remove path to trust application flushes on coherent maps. Closes #2372

2021-09-23 17:37:26 +01:00

CONTRIBUTING

Update/remove some dated documentation notes when building on VS

2021-09-15 10:32:55 +01:00

getting_started

Update documentation for event browser changes

2021-07-01 19:27:34 +01:00

how

Allow watch variables to specify a color-swatch with ,c. Closes #2475

2022-02-02 15:00:44 +00:00

imgs

Remove show unused/show empty options from texture viewer

2021-08-26 09:51:37 +01:00

include

Add mention of Stadia support to README and docs

2019-03-20 05:32:53 +00:00

pycharm_helpers

Add documentation on setting up python dev environment

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

python_api

Add ShaderSourcePrefix to docs index

2022-01-31 20:38:06 +00: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

Remove navigation elements on embedded help builds (like htmlhelp)

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

window

Remove show unused/show empty options from texture viewer

2021-08-26 09:51:37 +01:00

CODE_OF_CONDUCT.md

Adopt v2.0 of the contributor covenant

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

conf.py

Print renderdoc and qrenderdoc module locations

2021-02-14 15:45:57 +00:00

CONTRIBUTING.md

Clarify acceptable use for issues and support even further

2021-01-22 13:23:53 +00:00

credits_acknowledgements.rst

Fix incorrect link for include-bin credit.

2022-02-05 18:53:25 +00:00

in_application_api.rst

Add a new in-app API function ShowReplayUI to raise the UI window

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

index.rst

Tidy up python documentation and add examples

2018-06-15 19:44:37 +01:00

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

Improve docs build script to work on Windows 10 WSL

2018-08-20 11:57:01 +01:00

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

Rename 'draw' or 'drawcall' to action

2021-07-01 15:15:05 +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.