Commit Graph

20 Commits

Author SHA1 Message Date
baldurk 8634d8ff22 Add page titles and header texts for all python API ref documentation
* Try to guide people looking for an introduction away from API references and
  towards actual explanations and documentation.
2024-12-17 14:32:54 +00:00
baldurk d3dac4dfc0 Add missing documentation entries for descriptor viewer & root sig 2024-04-10 21:33:19 +01:00
Jake Turner 6ce881d5da UI and Config support for dec/hex display option for Offsets or Sizes
Used when fields are marked as being an Offset or Size
Include simple latch to trigger a UI refresh when closing the settings dialog.
Currently only connected to if the Offset/Size format option is altered
2023-12-06 17:19:05 +00:00
baldurk 605f8a0566 Fix documentation issues 2022-08-10 23:52:24 +01:00
baldurk e4751e66f3 Update docs for buffer viewer changes 2022-05-20 14:15:31 +01:00
baldurk 57a0463aa2 Add new classes to python documentation index 2021-05-11 17:34:31 +01:00
baldurk df6fec13f9 Remove use of automodule in docs
* One automodule in a file for our modules is way too much, so we split it into
  files. Unfortunately this means that only one file can have those classes and
  functions be linkable from elsewhere.
* Instead we bite the bullet and manually curate the items into pages, and at
  the same time subdivide the 'enums and data' page more which is a general
  readability and usability win as well.
* We also add some previously not-included functions, and add a doc-build time
  check to ensure that functions and classes aren't omitted from the
  documentation in future
2020-12-07 17:44:50 +00:00
baldurk 949cff30a2 Add some Qt python interfaces not included in docs 2020-11-27 14:30:01 +00:00
baldurk 58e16414e0 Add a number of control functions to the Qt python interface 2020-11-20 17:02:33 +00:00
baldurk dd4009c588 Remove undoc-members attributes from autoclass docs builds 2020-04-07 09:55:17 +01:00
baldurk a94f238e37 Ensure PersistantConfig member functions are documented 2019-10-09 10:25:49 +01:00
baldurk fa99ca9246 Document python extensions API 2018-10-23 14:23:12 +01:00
baldurk ce213c8f43 Add some missing items into the qrenderdoc python docs index 2018-10-18 19:38:04 +01:00
baldurk b1246c28ae Update docs reference to renamed SPIRVDisassembler class 2018-08-09 17:26:47 +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 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 229febfbcb Update python API references to latest renames/reorganisations 2017-12-15 17:33:54 +00:00
baldurk c7acbb3990 Document the QRenderDoc python API 2017-04-18 14:57:49 +01:00