Commit Graph

192 Commits

Author SHA1 Message Date
baldurk 046ca0ad12 Document RenderDoc controlling API validation while active. Closes #1121 2018-10-05 18:17:00 +01:00
baldurk 871685fe86 Split up CONTRIBUTING.md and move it under docs/ 2018-09-17 17:31:05 +01:00
baldurk a38f77a6f7 Move CODE_OF_CONDUCT.md file into docs/ subfolder
* This keeps the root folder a little tidier and is still automatically located
  & linked by github. See: https://help.github.com/articles/adding-a-code-of-
  conduct-to-your-project/
2018-09-17 16:50:47 +01:00
baldurk 416646d027 Fix example python scripts to work in the UI as well
* In the UI program we can't import renderdoc (it's already imported) so we just
  alias it to rd.
2018-08-29 20:50:14 +01:00
baldurk bfd575306c Improve docs build script to work on Windows 10 WSL 2018-08-20 11:57:01 +01:00
baldurk b1246c28ae Update docs reference to renamed SPIRVDisassembler class 2018-08-09 17:26:47 +01:00
baldurk fbec9c13aa If sphinx_rtd_theme_chm_friendly directory is missing, use normal theme 2018-08-06 17:28:35 +01:00
baldurk bd97664681 Fix incorrect copy-pasted title on docs page 2018-07-26 17:24:24 +01:00
baldurk 8410cfd5ab Update documentation for latest code changes and features. 2018-07-18 16:23:11 +01:00
baldurk 34d689b809 Include fetch_counters example in index 2018-06-25 21:58:02 +01:00
baldurk 2476474ca9 Add python sample for fetching counters 2018-06-25 18:14:04 +01:00
baldurk 24adf08a75 Remove references to deleted CommonPipelineState 2018-06-21 17:46:15 +01:00
baldurk 0dda96a045 Change previous/next/parent IDs in DrawcallDescription to pointers
* This is a legacy holdover from the C# interop not being able to preserve
  pointers easily.
2018-06-18 18:39:06 +01:00
baldurk 14e3a3d360 Move API-agnostic pipeline state wrapper into core interface
* There's no need for this to be in the UI, and moving it allows it to be used
  from script which is very useful.
2018-06-18 18:39:06 +01:00
baldurk 11091f1e54 Tidy up python documentation and add examples 2018-06-15 19:44:37 +01:00
baldurk ae5323bccc Remove mention of single-queue limitation from docs 2018-06-13 17:18:00 +01:00
baldurk 851a88133a Remove the 'save all initials' option. Behave as if it's always enabled
* This option has always been a mixed bag - when originally written captures
  weren't compressed at all so saving the cost of a initial contents on a
  gbuffer would have a significant savings.
* Now with compression the savings are lesser, and it's a source of
  bugs/confusion for the case where either a bug is caused by leaking data from
  the previous frame or worse still the contents are discarded incorrectly.
* D3D11 will now behave as the other APIs will - saving initial contents
  whenever needed even if they seem like they might not be used.
2018-05-23 16:08:44 +01:00
baldurk 80724f7130 Add cvconst.h / cvinfo.h from microsoft-pdb repository for SPDB decoding
* This will be used to replace/improve the old reverse-engineered decoding.
2018-05-17 15:04:26 +01:00
baldurk e5835aa6b3 Add documentation for shader viewer and ISA disassembly views 2018-05-08 15:08:49 +01:00
baldurk f6048a074e Clarify how to use dlopen to open the library for in-application API use 2018-05-08 14:56:04 +01:00
baldurk 1a9e22e2f2 Correct spelling/grammar mistakes in docs 2018-05-08 14:09:27 +01:00
baldurk a461df2b58 GL non-sharing context support 2018-05-08 11:10:32 +01:00
Baldur Karlsson d4b1741cec Add issue and pull request templates 2018-03-13 13:32:21 +00:00
herb marselas f720cd1e7d AMD GPUPerfAPI 3.0 Preview Integration.
Direct3D11, Direct3D12, OpenGL, and Vulkan supported.
Fixes Direct3D11 counter command isolation.
2018-02-28 12:10:36 +00:00
baldurk 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
baldurk 2bd35f87ff Remove python modindex file from docs 2018-02-16 09:41:16 +00:00
baldurk 8374e2f01f Add license notes about OpenSSL distribution 2018-02-07 16:06:53 +00:00
baldurk 64c9e93831 Commit interceptor-lib from GAPID @ 9492539f1
* This library will be used to replace the PLT hooking for most core
  functions, and is generally more reliable. It still fails in some
  cases though when the target function is not patchable.
* To build, it requires LLVM. See README.md for instructions on building
  a compatible LLVM for use.
2018-01-31 18:24:12 +00:00
baldurk 969fdaa499 Add the ability to patch android binary XML manifests in-place
* This lets us add the debuggable flag we need, at the cost of needing
  to re-sign the APK. It works in many cases although sometimes it does
  fail - but this is provided just as a 'best effort' and not as a
  recommended workflow.
2018-01-29 22:37:55 +00:00
baldurk 079c255bd8 Fix some missing whitespace around rst references in docs 2018-01-11 13:48:32 +00:00
baldurk 6572cd97f5 Tidy up handling of windowing data, make it a bit more type safe 2018-01-01 17:31:19 +00:00
baldurk 16f64a5ace Remove use of unnecessary swig generated .py wrappers
* These .py wrappers are relevant for the non-builtin path, but since we
  use -builtin they serve no purpose except to make things more complex.
* So instead we make the module directly exported as 'module' instead of
  '_module'.
* On windows there's no conflict because we have renderdoc.dll vs
  renderdoc.pyd. On linux it's librenderdoc.so vs renderdoc.so.
* To prevent supporting files like .lib / .pdb from conflicting on
  windows we build the python modules into a subdirectory. They're not
  ever used by the UI (it links in the bindings directly).
2017-12-25 15:05:28 +00:00
baldurk 06a25013c1 Fix ' character that was accidentally pasted in 2017-12-22 22:09:43 +00:00
baldurk 4c7ea8e158 Remove paragraph symbol literal from sphinx paramlinks
* It doesn't display properly in chm
2017-12-22 14:41:44 +00:00
baldurk 691f91c9aa Re-organise and tidy python API documentation 2017-12-22 14:41:43 +00:00
baldurk ebaefc82a9 Normalise and make python/public interface more consistent
* We enforce a naming scheme more strongly - types, member functions,
  and enum values must be UpperCaseCamel, and member variables must be
  lowerCaseCamel. No underscores allowed.
* eventId not eventID or EID, and Id preferred to ID in general. Also
  for resourceId.
* Removed some lingering hungarian m_Foo naming.
* Some pipeline state structs that are almost identical between the
  different APIs are pulled out into common structs. Where something
  doesn't make sense (e.g. viewport enable for vulkan) it will just be
  set to a sensible default (in that case always true).
* Changed scissors to be x/y & width/height instead of sometimes
  left/top/right/bottom
* Abbreviations are discouraged, e.g. operation not op, function not
  func.
2017-12-22 13:02:36 +00:00
baldurk fd66995ac2 Let docs build pick release or development built modules 2017-12-21 21:19:49 +00:00
baldurk 8d5a621ee1 Re-enable python API docs 2017-12-15 17:33:55 +00:00
baldurk 229febfbcb Update python API references to latest renames/reorganisations 2017-12-15 17:33:54 +00:00
baldurk f27e5d48f6 Fix typo in in_application_api restructuredText, missing colon on param 2017-12-15 17:33:54 +00:00
baldurk 2460bc998d Add sphinx_paramlinks extension and use :paramref:`` to reference params 2017-12-15 17:33:53 +00:00
baldurk b3e48a7576 Add search logic to find android tools automagically, which we ship
* We search first in specified folders by the user (they can browse to
  the android SDK and java JDK).
* If the tools we want aren't found there, we look relative to the UI
  as we now distribute the required tools with windows builds.
* If we still don't find them, we prefer to look in PATH since the user
  has 'opted in' to any tools found in there. If the tool isn't in PATH
  either then we look relative to known environment variables.
2017-12-14 14:38:39 +00:00
baldurk e8dc6471a3 Add pugixml 1.8 2017-11-03 15:54:57 +00:00
baldurk 32c8b38568 Add zstd v1.3.1
* The directories are flattened since the #include paths aren't
  relative and instead just #include "file.h". The recommended
  solution is just to flatten the directory structure.
2017-11-03 15:54:57 +00:00
baldurk e6e36d1ea4 Update lz4 to v1.8.0 2017-11-03 15:54:57 +00:00
baldurk 9a3ece6a01 Add a helper macro for obtaining renderdoc's handle from VkInstance
* Since other layers could wrap renderdoc has to use the dispatch table
  pointer as the unique identifier for API calls, not the VkInstance
  directly.
2017-10-23 13:43:38 +01:00
baldurk eb15c43b41 Add Catch.hpp for unit testing, with appveyor hooks 2017-08-29 13:19:44 +01:00
baldurk 4532d04b5b Remove stale documentation about python scripting 2017-07-14 22:44:20 +01:00
baldurk ecf88787d7 Add code to disassemble SPIR-V, glsl and DXBC into GCN ISA.
* Requires binary plugins to function from the RGA repository. These
  will be included with distributions (nightly and stable builds) where
  possible, however D3D disassembly currently requires the AMD driver
  DLL which cannot be distributed. Placing it in the folder with the
  other files will automatically work.
2017-07-05 20:37:48 +01:00
baldurk d44528794a Change qrenderdoc icons to Farm-Fresh, to add high-DPI versions. 2017-06-19 16:17:20 +01:00