b64fa99d2b
Update documentation for event browser changes
2021-07-01 19:27:34 +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
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
4d189b7f90
Add bigger warning in documentation about process injection
2021-05-28 11:46:13 +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
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
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
83714b825c
Remove note about android support being new
2020-08-20 10:47:16 +01:00
0ee1209a5f
Mention that Vulkan supports shader debugging in documentation
2020-08-05 11:41:32 +01:00
1d579dfb66
Update docs about D3D12 shader debugging support
2020-05-15 19:03:00 +01:00
1d270254c1
Add documentation for replay options
2019-08-27 18:51:57 +01:00
8c6fc67acd
Make it extra clear that RenderDoc needs to find the Android SDK
2019-08-27 18:51:56 +01:00
e4333291a1
Allow using shader processing tools for custom shaders
...
* This is primarily useful for HLSL on Vulkan, but could be used with any other
combination. If multiple tools can perform the conversion, the highest
priority one is used.
2019-05-22 17:54:10 +01:00
db89f50a30
Rename Mesh Output panel to Mesh Viewer, since it displays inputs too
2019-03-08 15:40:11 +00:00
383d8158cc
Fix docs build with missing end string terminator
2018-12-14 20:42:45 +00:00
13e7d1c134
Support display of YUV textures on D3D11, D3D12 and Vulkan
...
* Supported textures are decoded into standard format of YUVA, displayed
visually with Y in green, U in blue, V in red.
* A new texture display mode 'YUVA decode' has been added which does a default
full-range conversion from YUV to RGB.
* Custom shaders can be used to implement a custom decode matrix.
2018-12-14 20:14:07 +00:00
204724bebe
Add documentation for python extensions
2018-11-30 16:42:49 +00:00
fac080ab4d
Add documentation for expanded shader processing tools functionality.
2018-11-30 16:25:24 +00:00
8b1251a8b8
Add a note to the RGP howto page to enable RGP integration
2018-11-30 16:04:01 +00:00
8410cfd5ab
Update documentation for latest code changes and features.
2018-07-18 16:23:11 +01:00
1a9e22e2f2
Correct spelling/grammar mistakes in docs
2018-05-08 14:09:27 +01:00
933c00985d
Update documentation for v1.0
...
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
performance counter viewer, as well as new features like saving
bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
2018-02-25 23:27:13 +00:00
4abbfd9169
Add documentation for run-to-sample or run-to-NaN/infinity buttons
2017-02-23 14:53:54 +00:00
730f23fc78
Fix docs SetPrivateData example, add examples for GL/VK/D3D12. Refs #517
2017-02-21 12:14:31 +00:00
c1591a5fe6
Update docs with D3D12 support and progress on Qt
2016-11-28 12:42:15 +01:00
0c06590df3
Remove cubemap binding from D3D/HLSL texture view. Just use 2D array
2016-11-18 16:31:05 +01:00
c587e24509
Add documentation of network capture & replay workflow
2016-08-30 14:39:04 +02:00
4f06161fb9
Update template custom shader to include UV, add new globals. Refs #304
2016-07-26 15:18:45 +02:00
89402c03bf
Add a note about the VULKAN predefined macro.
2016-07-25 11:39:50 +02:00
a001f35329
Output UVs in [0,1] from blit shader, for custom vis shaders. Refs #304
2016-07-25 11:39:49 +02:00
ffa96736ee
Add required 'uniform' to glsl varaibles in documentation
2016-07-25 11:39:48 +02:00
fefb6b2526
Pass selected slice/face and sample idx to custom vis shaders. Refs #304
2016-07-25 11:39:47 +02:00
8b64868025
For GLSL, insert text after #version statement.
2016-06-09 10:48:50 -07:00
22d58cf739
Implement custom display shaders for vulkan
2016-06-09 10:48:44 -07:00
8bc80b41b0
Various improvements/tweaks/missing bits/extra links
...
* General proof-reading pass on the new docs, so some of these issues
are old and just haven't been noticed before.
2016-05-16 20:01:15 +02:00
3146b905b5
Remove unneeded toctree:: statements in non-index pages
2016-05-16 18:35:39 +02:00
e922e85aa3
Add a reference to where unstripped shader info is detailed
2016-05-16 15:42:42 +02:00
a29bed7a5b
Refer to images under correct paths
2016-05-15 21:34:06 +02:00
81a1b2e020
Add syntax highlighting
2016-05-15 21:34:00 +02:00
f124f3f389
Port the remaining pages where I know how to style them.
2016-05-15 21:33:54 +02:00
f04f016a99
Remove "other resources" to flatten the hierarchy a bit.
2016-05-15 21:33:52 +02:00
925f33bfb5
Add all How do I ...? pages.
2016-05-15 21:33:52 +02:00
baldurk