Commit Graph

10 Commits

Author SHA1 Message Date
baldurk 565fe17ba2 Add API and usage documentation for custom annotations system 2026-01-28 14:42:11 +00:00
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
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 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 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 c7acbb3990 Document the QRenderDoc python API 2017-04-18 14:57:49 +01:00