Commit Graph

385 Commits

Author SHA1 Message Date
baldurk 8aa0390948 Add string messages to returned result codes to display to user
* Most of the main entry points that can fail with relevant reasons now has a
  way of specifying a message to return with it. This message can be displayed
  to the user to give more information or context about an error.
2022-04-26 16:21:54 +01:00
Bertrand Guay-Paquet cb0dc39bf3 Add link to the contrib repository for custom visualisation 2022-04-22 13:49:56 +01:00
baldurk eb1e625b96 Add better documentation for how to specify separate shader debug info 2022-03-30 14:53:20 +01:00
baldurk 9c1eeed29b Fix copy-paste error with GLSL unsigned integer texture declarations 2022-03-30 12:51:36 +01:00
baldurk 6d5140e5b5 Remove links to deleted wiki pages, and planned/roadmap features doc 2022-03-15 14:34:38 +00:00
Jake Turner 6bd8bcee60 Add note that Mac requires a C++17 compiler 2022-02-19 11:17:33 +00:00
Jake Turner 39d11975b2 Update build requirements for Apple
CMake version 3.20 or higher (needed to support Xcode project generation)
clang version 12.0 or higher (needed to support arm64+x64 universal binary compilation)
XCode 12.2 is the oldest version which includes clang version 12.0
2022-02-19 11:17:33 +00:00
baldurk fcdea67879 Update copyright years to 2022 2022-02-17 17:38:32 +00:00
baldurk 99adcc614f Allow multiple remote servers on one hostname, on different ports
* When a port is specified (with the usual :12345 suffix on the hostname) we use
  that for remote replay connections. We disable target control enumeration
  since that requires a port _range_ and captured applications self-assign those
  ports. Those can still be accessed via a normal unsuffixed remote specifier -
  even if there is no remote server running on the default port.
2022-02-15 17:15:48 +00:00
Remi Palandri d1858f4479 add support for VK_QCOM_FDM_offset 2022-02-14 21:02:27 +00:00
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
baldurk fdda8be9c6 Allow watch variables to specify a color-swatch with ,c. Closes #2475 2022-02-02 15:00:44 +00:00
baldurk 7320aa27a1 Add ShaderSourcePrefix to docs index 2022-01-31 20:38:06 +00:00
baldurk 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
baldurk 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
baldurk 62babcb497 Fix python example for API change 2021-11-24 14:08:52 +00:00
John Kattukudiyil a2978dc33d readded custom axis mapping button and updated documentation 2021-11-08 11:39:28 +00:00
Mikkel Gjoel 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
baldurk 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
baldurk 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
baldurk 21e5aa8bcf Update/remove some dated documentation notes when building on VS 2021-09-15 10:32:55 +01:00
baldurk a21d245114 Remove show unused/show empty options from texture viewer 2021-08-26 09:51:37 +01:00
baldurk 87e08feb7c Document that only 64-bit x86 is supported on linux. Closes #2332 2021-08-02 22:55:12 +01:00
baldurk 88d005d945 Update python examples to work with latest code 2021-07-28 11:37:14 +01:00
baldurk 6130a120ef Update some out-of-date docs 2021-07-19 16:51:50 +01:00
baldurk 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
baldurk 4170e51255 Fix mistaken reference in documentation 2021-07-01 20:29:37 +01:00
baldurk b64fa99d2b Update documentation for event browser changes 2021-07-01 19:27:34 +01:00
baldurk 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
baldurk 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
baldurk 6272683678 Remove event browser settings about hiding empty regions 2021-07-01 15:15:03 +01:00
baldurk c276d3dc4f Make some misc tweaks and updates to the docs 2021-06-29 16:55:53 +01:00
baldurk 9db41e0a5e Update IRC details to point to OFTC 2021-06-15 11:26:58 +01:00
baldurk 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
baldurk 50b2cecc50 Add documentation for shader messages window 2021-05-28 12:19:12 +01:00
baldurk 4d189b7f90 Add bigger warning in documentation about process injection 2021-05-28 11:46:13 +01:00
baldurk 399f1c59e0 Remove trailing line referring to old removed section of docs 2021-05-20 10:12:52 +01:00
baldurk 16b82d1689 Handle rdcstrpair or rdcstrpairs in function return types for docstrings 2021-05-17 15:05:13 +01:00
baldurk 57a0463aa2 Add new classes to python documentation index 2021-05-11 17:34:31 +01:00
baldurk 9c50927777 Remove navigation elements on embedded help builds (like htmlhelp) 2021-05-10 17:02:49 +01:00
baldurk e33263270d Remove encoding & embedded js that breaks htmlhelp builder 2021-05-10 17:02:49 +01:00
baldurk 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
baldurk 95e55549d8 Fix sphinx-paramlinks for sphinx 4.0.0 2021-05-10 17:02:48 +01:00
baldurk cc2d736301 Remove piece in documentation that caused more problems than it solved 2021-04-23 19:07:31 +01:00
baldurk 2a61a7f32d Fix documentation build 2021-04-14 19:59:07 +01:00
baldurk cc05b288b6 List sparse resources as supported in the documentation 2021-03-29 12:19:34 +01:00
baldurk 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
baldurk 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
baldurk 673579e854 Print renderdoc and qrenderdoc module locations 2021-02-14 15:45:57 +00:00
baldurk 321fbdefe9 Don't check docs build consistency if an exception happened 2021-02-14 15:10:21 +00:00