b4503f95cf
Remove manual html target="_blank" links from documentation
2016-09-27 15:55:53 +02:00
f9b78a9312
Configure sphinx to require 1.5 for building htmlhelp
...
* This version contains the fix for sphinx-doc/sphinx#2550 so we want to
assume it is present and tidy up all the external links. However if
needed (and you don't care about the external links being broken) you
can locally remove this version requirement.
2016-09-27 15:13:46 +02:00
e991c12931
Add plthook for hooking libraries on linux even through DEEPBIND
...
* Based on a fork with slight added extra functionality at
https://github.com/baldurk/plthook
2016-09-26 17:33:50 +02:00
0809778b26
Add a FAQ entry about hooking child processes
2016-09-12 15:09:25 +02:00
46644e127f
Add some introductory text to the in-application API about how to start
2016-09-12 15:09:13 +02:00
bf1c2dc165
Fix DockPanel link.
2016-09-06 12:31:00 +02:00
c587e24509
Add documentation of network capture & replay workflow
2016-08-30 14:39:04 +02:00
4c3dc549d1
Remove mention of beta builds
2016-08-30 14:38:45 +02:00
4573c9c20f
Update docs of in-application API to 1.1.1
2016-08-30 14:38:35 +02:00
226ce7a5ce
Remove line about missing features that are now implemented
2016-08-30 14:38:07 +02:00
8ad29b1bce
Add documentation for local-replay option
2016-08-30 14:37:42 +02:00
72c4a43875
Remove sandcastle help file builder project - switched to sphinx now
2016-08-26 13:44:56 +02:00
3e5d55d1d6
Add an option to choose the default save folder for captures. Refs #335
2016-08-24 15:53:52 +02:00
362d33813c
Add code to run hhc.exe to make.bat and Makefile
...
* Thanks to @mivance for the make.bat code!
2016-08-10 12:56:36 +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
5b74d2f90a
Add a little Ctrl-G popup on the texture viewer to jump to a pixel
2016-07-22 12:28:26 +02:00
f24e3b20d9
Add cmdline.h from https://github.com/tanakh/cmdline
...
* BSD licensed - Copyright (c) 2009, Hideyuki Tanaka
2016-07-12 11:47:53 +02:00
e263c107de
Rejig the features list in the docs so it's not one-per-API
...
* It doesn't make sense when 90% of the features are available in all
APIs now.
2016-06-09 15:59:43 -07: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
947f7decb2
Add 'show all instances' mode, and make colours consistent. Closes #248
2016-06-03 17:34:26 +02:00
0cb940fcbe
Support LZ4 compression of stripped separate debug blobs
2016-05-30 12:12:18 +02:00
60706ca4eb
Add options controlling marker colourising
2016-05-27 23:26:59 +02:00
b74ad435e5
Add a 1:1 (zoom 100%) button. Refs #272
2016-05-26 23:58:58 +02:00
4b7e068703
Rename 'create debug device' capture option to 'API validation'
...
* More appropriate for non-D3D11 APIs and will cause less confusion.
2016-05-17 21:16:17 +02:00
3539b06899
Add fix to sphinx css to prevent tiny inline images blowing up on mobile
2016-05-16 21:03:15 +02:00
8890233fe0
Set external links to open with target="_blank" for benefit of chm
...
* Without this, the chm viewer attempts to open the external link in its
own windows. With some ancient IE6 monstrosity. Ouch.
2016-05-16 20:01:17 +02:00
e8f76b35c0
Copy introduction.html over index.html for chm builds
2016-05-16 20:01:16 +02: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
4691972148
Document the actual exported API entry point, RENDERDOC_GetAPI
2016-05-16 17:02:46 +02:00
aa3bd8a674
Add convenience to docs make.sh to also call hhc.exe to build the .chm
2016-05-16 16:33:32 +02:00
29f1d1af62
Add post-processing for the sphinx htmlhelp output before build
...
* Copies our .hhk into the build folder
* Removes TOC entries that just refer to anchors - it's unnecessary and
just clutters up the TOC.
2016-05-16 16:29:08 +02:00
afc5c81d4c
Update the .hhk file with a hand-authored more useful index
2016-05-16 15:56:22 +02:00
4a90373458
Add an anchor for the tip about using RenderDoc as an image viewer
2016-05-16 15:42:53 +02:00
e922e85aa3
Add a reference to where unstripped shader info is detailed
2016-05-16 15:42:42 +02:00
6c24932746
Vulkan support is no longer planned for future!
2016-05-16 15:42:28 +02:00
440c9c4569
Move in application API to root level
2016-05-16 14:43:46 +02:00
2b59a806cf
Remove header from API page
2016-05-16 14:39:06 +02:00
f0f5d84f25
Add documentation for capture window
2016-05-16 13:39:07 +02:00
e1c63c9561
Fill out the text on the options window page
2016-05-16 13:20:03 +02:00
df9025cc8f
Add text to texture viewer documentation page
2016-05-16 12:58:23 +02:00
e610e1e175
Add autobuilt hhk, to customise for future chm builds
2016-05-15 21:42:57 +02:00
a29bed7a5b
Refer to images under correct paths
2016-05-15 21:34:06 +02:00
0d8762befb
Change htmlhelp_basename
2016-05-15 21:34:05 +02:00
1e8967a862
Fix some enumerator definitions that referenced ranges of enums
2016-05-15 21:34:04 +02:00
baldurk