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
fdda8be9c6
Allow watch variables to specify a color-swatch with ,c. Closes #2475
2022-02-02 15:00:44 +00:00
7320aa27a1
Add ShaderSourcePrefix to docs index
2022-01-31 20:38:06 +00:00
3ac4bd0ebd
Refactor custom shaders to abstract binding differences. Closes #2458
...
* Newly written shaders and any updated shaders can now use pre-defined macros
to abstract away binding differences between APIs, so custom shaders will be
more portable in particular shaders written in HLSL for D3D or GLSL on OpenGL
won't break on vulkan because they refer to incorrect binds.
2022-01-31 19:14:08 +00:00
089126c34b
Add a new in-app API function ShowReplayUI to raise the UI window
...
* This is not guaranteed to work, e.g. on windows where for good reason
background windows can't necessarily raise themselves.
2022-01-12 11:24:22 +00:00
62babcb497
Fix python example for API change
2021-11-24 14:08:52 +00:00
a2978dc33d
readded custom axis mapping button and updated documentation
2021-11-08 11:39:28 +00:00
41d39b58ce
Pass range-min/max to ApplyCustomShader
...
Adding rangeminmax to globals, snippet support and updated docs to match
Fixes bug in replay_output.cpp, causing a crash due to missing texhandle
2021-11-03 20:26:18 +00:00
d4a5592780
Add functionality to reset an edited shader to original. Closes #2334
...
* We also add the ability to toggle on/off the replacement being active without
needing to intentionally add a compile error (and this also makes it more
explicitly clear when the shader replacement is enabled or not. This could be
useful for quick A/B testing between the edited version and the original.
2021-11-02 14:09:50 +00:00
b4e4fed40f
Remove path to trust application flushes on coherent maps. Closes #2372
...
* We used to allow applications to call vkFlushMappedMemoryRanges on coherent
memory to manually annotate regions of memory that are changed in persistent
maps, thus avoiding the overhead of RenderDoc needing to check for changes on
each submit.
* Unfortunately this means that if the application calls flush wrongly then
changes will no longer appear, even though the application was completely
correct, if misleading, since by the spec behaviour vkFlushMappedMemoryRanges
is a no-op on coherent memory so incorrect calls to it make no difference.
* Since applications making use of this are rare or non-existant we just remove
the optimisation.
2021-09-23 17:37:26 +01:00
21e5aa8bcf
Update/remove some dated documentation notes when building on VS
2021-09-15 10:32:55 +01:00
a21d245114
Remove show unused/show empty options from texture viewer
2021-08-26 09:51:37 +01:00
87e08feb7c
Document that only 64-bit x86 is supported on linux. Closes #2332
2021-08-02 22:55:12 +01:00
88d005d945
Update python examples to work with latest code
2021-07-28 11:37:14 +01:00
6130a120ef
Update some out-of-date docs
2021-07-19 16:51:50 +01:00
81b4d3d804
Add public domain md5 library and implement modified DXBC container hash
...
* This allows us to disabled any requirement for "experimental shaders".
2021-07-07 19:18:32 +01:00
4170e51255
Fix mistaken reference in documentation
2021-07-01 20:29:37 +01:00
b64fa99d2b
Update documentation for event browser changes
2021-07-01 19:27:34 +01:00
d0accc409b
Rename 'name' member of ActionDescription to 'customName'
...
* This is a deliberate break of compatibility since the field is now often
empty, for non-markers. This means code will get a more explicit error when
the name is being referenced, so it can be updated to fetch the name it needs
as needed.
2021-07-01 15:15:05 +01:00
7149302680
Rename 'draw' or 'drawcall' to action
...
* There's not a good accepted terminology for this kind of event, and for
historical reasons 'drawcall' has been the accepted term, even though
that can be quite confusing when a dispatch or a copy is a 'drawcall'.
* This is particularly highlighted by the event browser filters where
$draw() includes draws and dispatches, but $dispatch() only includes
dispatches, it's hard to intuitively understand why $draw() matches all
of these calls.
* As a result we've defined the term 'action' to cover these types of
events in the same way that we defined 'event' in the first place to
mean a single atomic API call.
2021-07-01 15:15:05 +01:00
6272683678
Remove event browser settings about hiding empty regions
2021-07-01 15:15:03 +01:00
c276d3dc4f
Make some misc tweaks and updates to the docs
2021-06-29 16:55:53 +01:00
9db41e0a5e
Update IRC details to point to OFTC
2021-06-15 11:26:58 +01:00
fb95285ca1
Put all annotation docs into the same 'how do I' page. Refs #2285
...
* This page now documents both how to annotate things from code in the
application, as well as at runtime in the UI.
2021-06-01 13:29:09 +01:00
50b2cecc50
Add documentation for shader messages window
2021-05-28 12:19:12 +01:00
4d189b7f90
Add bigger warning in documentation about process injection
2021-05-28 11:46:13 +01:00
399f1c59e0
Remove trailing line referring to old removed section of docs
2021-05-20 10:12:52 +01:00
16b82d1689
Handle rdcstrpair or rdcstrpairs in function return types for docstrings
2021-05-17 15:05:13 +01:00
57a0463aa2
Add new classes to python documentation index
2021-05-11 17:34:31 +01:00
9c50927777
Remove navigation elements on embedded help builds (like htmlhelp)
2021-05-10 17:02:49 +01:00
e33263270d
Remove encoding & embedded js that breaks htmlhelp builder
2021-05-10 17:02:49 +01:00
b8abb18810
Reset sphinx rtd theme to 0.5.2 with no modifications
...
* The next commit will contain our customisations that we still need for chm, to
make it clearer.
2021-05-10 17:02:49 +01:00
95e55549d8
Fix sphinx-paramlinks for sphinx 4.0.0
2021-05-10 17:02:48 +01:00
cc2d736301
Remove piece in documentation that caused more problems than it solved
2021-04-23 19:07:31 +01:00
2a61a7f32d
Fix documentation build
2021-04-14 19:59:07 +01:00
cc05b288b6
List sparse resources as supported in the documentation
2021-03-29 12:19:34 +01:00
57b6190c85
Link to proper github new issue page
...
* Github doesn't redirect when there are templates, which leads to users not
seeing the template.
2021-03-23 23:09:58 +00:00
30dd13feb8
Pull index byte width and topology out of drawcall state
...
* These are treated as state on most APIs, only GL treats it as a drawcall
parameter.
2021-02-24 13:52:07 +00:00
673579e854
Print renderdoc and qrenderdoc module locations
2021-02-14 15:45:57 +00:00
321fbdefe9
Don't check docs build consistency if an exception happened
2021-02-14 15:10:21 +00:00
fc2b2c11cc
Include ShadingRateCombiner in the documentation
2021-02-10 15:07:37 +00:00
dabd2a803a
Give specific instructions on writing UI extensions
...
* This goes through a worked example of a simple extension.
2021-01-27 16:05:03 +00:00
9424b8a3fe
Add documentation on setting up python dev environment
2021-01-27 16:05:03 +00:00
ae96b674c9
Update docs to reference VK_EXT_debug_utils
...
* VK_EXT_debug_marker still works fine but is deprecated.
2021-01-27 13:03:16 +00:00
3f637e0d9b
Link to renderdoc-contrib repository
2021-01-27 12:58:51 +00:00
a377a61aa2
Clarify acceptable use for issues and support even further
...
* Capturing copyrighted programs is absolutely not supported or tolerated.
2021-01-22 13:23:53 +00:00
e7e2b73170
Search extracted namespace for class, not all headers
2020-12-16 20:39:58 +00:00
fede056ef7
Fix bug in redeclarator if type hint like Tuple[int, ...] is used
...
* The ... confused the declaration process and so an empty identifier got
registered, which then broke things later.
2020-12-15 22:52:37 +00:00
ea2410fe9f
Make new python documentation checks optional
...
* Older sphinx versions don't have an easy 'objects' property so we just drop
this check. As long as it happens on CI builds that's the main thing.
2020-12-10 10:05:10 +00:00
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
follower