Commit Graph

163 Commits

Author SHA1 Message Date
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
Matthäus G. Chajdas b7f893b559 Add backend support for AMD performance counters. 2017-06-15 14:29:55 +01:00
baldurk abb07a5be1 Add missing mention of D3D12 support in a couple of places. 2017-05-19 13:52:16 +01:00
baldurk fc61918b89 Update sphinx_rtd_theme (keeping our local changes) 2017-05-15 10:52:43 +01:00
baldurk b4ed02d040 Take out the python API from the docs index until qrenderdoc ships 2017-05-15 10:21:20 +01:00
baldurk 4caa05c2b9 Remove reference to removed GetCommitHash function in the docs 2017-04-28 18:36:54 +01:00
baldurk 94e64a0aec Add build of renderdoc python modules for documentation generation 2017-04-19 18:07:55 +01:00
baldurk c7acbb3990 Document the QRenderDoc python API 2017-04-18 14:57:49 +01:00
baldurk 6930841705 Rename ReplayRenderer to ReplayController
* It's not a renderer, it's an interface to controlling the replay and
  any 'renderer' type work actually happens in ReplayOutput.
2017-04-18 14:57:47 +01:00
baldurk a7ab0d9300 Move capture-file handling functions into a single interface
* This allows us to return complex types like byte arrays or pairs of
  status & render handle.
* Also in future more introspection of the capture file will be possible
  and this provides an easy extension to that without adding new entry
  points.
2017-04-18 14:57:47 +01:00
baldurk f476058567 Pull the ultimate parent pipeline object to the top of any docs page 2017-04-18 14:57:46 +01:00
baldurk dd75707157 Set copyright year to current year at build time 2017-04-18 14:57:45 +01:00
baldurk 99063c2401 Add entries in sphinx documentation to generate correct API autodocs 2017-04-18 14:57:44 +01:00
baldurk 83f769a2cd Document the enums in replay_enums.h 2017-04-18 14:57:44 +01:00
baldurk 5adce29b44 Add support for documenting bindings API directly in code 2017-04-18 14:57:41 +01:00
baldurk d2d86b5726 Add 'floateleven' buffer format for R11G11B10 packed data, fix unpacking 2017-03-20 13:02:20 +00:00
baldurk efc592bfe6 Document capture renaming in the capture connection 2017-02-23 14:57:51 +00:00
baldurk 4abbfd9169 Add documentation for run-to-sample or run-to-NaN/infinity buttons 2017-02-23 14:53:54 +00:00
baldurk ea95d4e943 Update docs on Qt support 2017-02-23 14:49:58 +00:00
baldurk 730f23fc78 Fix docs SetPrivateData example, add examples for GL/VK/D3D12. Refs #517 2017-02-21 12:14:31 +00:00
baldurk 7095d1f2a2 Document that secure boot must be disabled for global hook 2017-02-03 20:11:07 +00:00
baldurk 86200f1a10 Update documentation with new minimum requirements for OpenGL 2017-01-17 18:59:36 +00:00
baldurk ac47036368 Add an option to hide any markers with only "API Calls" but no draws. 2017-01-09 18:15:45 +00:00
baldurk 10053b8be8 Update docs to mention that Vulkan/D3D12 don't support Map() verifying 2017-01-09 11:42:47 +00:00
baldurk 4d00722f57 Add tinyfiledialogs from tinyfiledialogs.sf.net for x-platform messages
* Added a couple of very minor warning suppressions for VS. To do with
  casts between size_t and int or char const * and int.
2017-01-09 11:19:15 +00:00
baldurk 299e427503 Include D3D12 docs page in the table of contents 2017-01-04 17:11:52 +00:00
baldurk c1591a5fe6 Update docs with D3D12 support and progress on Qt 2016-11-28 12:42:15 +01:00
baldurk 0c06590df3 Remove cubemap binding from D3D/HLSL texture view. Just use 2D array 2016-11-18 16:31:05 +01:00
baldurk 57d8cfa89a Add stb_image_resize for thumbnail processing 2016-11-02 23:37:38 +01:00
baldurk 33b8bca64d Added specific list of contributors to highlight notable work 2016-10-12 18:12:20 +02:00