Commit Graph

71 Commits

Author SHA1 Message Date
baldurk 7320aa27a1 Add ShaderSourcePrefix to docs index 2022-01-31 20:38:06 +00:00
baldurk 62babcb497 Fix python example for API change 2021-11-24 14:08:52 +00:00
John Kattukudiyil a2978dc33d readded custom axis mapping button and updated documentation 2021-11-08 11:39:28 +00:00
baldurk 88d005d945 Update python examples to work with latest code 2021-07-28 11:37:14 +01:00
baldurk d0accc409b Rename 'name' member of ActionDescription to 'customName'
* This is a deliberate break of compatibility since the field is now often
  empty, for non-markers. This means code will get a more explicit error when
  the name is being referenced, so it can be updated to fetch the name it needs
  as needed.
2021-07-01 15:15:05 +01:00
baldurk 7149302680 Rename 'draw' or 'drawcall' to action
* There's not a good accepted terminology for this kind of event, and for
  historical reasons 'drawcall' has been the accepted term, even though
  that can be quite confusing when a dispatch or a copy is a 'drawcall'.
* This is particularly highlighted by the event browser filters where
  $draw() includes draws and dispatches, but $dispatch() only includes
  dispatches, it's hard to intuitively understand why $draw() matches all
  of these calls.
* As a result we've defined the term 'action' to cover these types of
  events in the same way that we defined 'event' in the first place to
  mean a single atomic API call.
2021-07-01 15:15:05 +01:00
baldurk 57a0463aa2 Add new classes to python documentation index 2021-05-11 17:34:31 +01:00
baldurk 2a61a7f32d Fix documentation build 2021-04-14 19:59:07 +01:00
baldurk 30dd13feb8 Pull index byte width and topology out of drawcall state
* These are treated as state on most APIs, only GL treats it as a drawcall
  parameter.
2021-02-24 13:52:07 +00:00
baldurk fc2b2c11cc Include ShadingRateCombiner in the documentation 2021-02-10 15:07:37 +00:00
baldurk dabd2a803a Give specific instructions on writing UI extensions
* This goes through a worked example of a simple extension.
2021-01-27 16:05:03 +00:00
baldurk 9424b8a3fe Add documentation on setting up python dev environment 2021-01-27 16:05:03 +00:00
baldurk 7ff7e0a71d Replace fixed C arrays with wrapper class in public interface
* These map more naturally to python tuples and are easier to wrap in and out.
* We also tidy up the FloatVecVal etc and standardise the members of
  ShaderValue.
2020-12-09 18:16:08 +00:00
baldurk 580f96c8a1 Rename ShaderVariableType/Descriptor to ShaderConstant
* These structs are no longer used with ShaderVariable so the name is misleading
  at best.
2020-12-09 15:18:27 +00: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 6c26562201 Remove duplicate documentation entry for GlobalEnvironment 2020-11-27 14:19:33 +00:00
baldurk 58e16414e0 Add a number of control functions to the Qt python interface 2020-11-20 17:02:33 +00:00
baldurk 75c3156286 Add note that python scripting on Android is unreliable and unsupported
* It may work since the python scripting is generally not Android specific, but
  Android itself is quite likely going to cause problems that are out of scope.
2020-10-21 10:24:35 +01:00
baldurk c8fcdbae05 Update fetch_shader python example to latest API 2020-09-14 15:58:20 +01:00
baldurk d5f45f6476 Allow overriding the python install on windows
* Also document the new requirement for os.add_dll_directory as of python 3.8
2020-08-31 12:38:49 +01:00
baldurk 287bb81fca Add a note about the python module version restriction 2020-07-24 16:33:34 +01:00
baldurk 6a8e7cbbe5 Fix python examples not being up to date with latest API changes 2020-07-20 10:52:59 +01:00
sindney 34b3484baa Update decode_mesh.py 2020-06-16 11:01:28 +01:00
sindney 689f6960c0 fix unpackData max negative 2020-06-16 11:01:28 +01:00
sindney 8e267c01ba fix unpackData bug when unpacking UNorm and SNorm data 2020-06-16 11:01:28 +01:00
baldurk fa9215477d Update examples to latest python API 2020-05-20 11:51:52 +01:00
baldurk 63c1ecd89c Handle vertexOffset properly in mesh decode example. Closes #1852 2020-04-28 18:15:34 +01:00
baldurk dd4009c588 Remove undoc-members attributes from autoclass docs builds 2020-04-07 09:55:17 +01:00
baldurk 98af55d513 Fix fetch_shader example for latest API changes 2020-03-05 19:35:45 +00:00
baldurk 4e4ef40612 Add replay API initialisation/shutdown to python examples 2020-03-05 19:35:45 +00:00
baldurk 82fca7d325 Make the display_window.py example quit after a few loops 2020-01-15 10:02:20 +00:00
baldurk 7d22448d3f Sample code should take the capture to load as an argument
* This makes it easier to run the examples from the command line without editing
  them
2020-01-15 09:23:12 +00:00
baldurk b450b3ff29 Fix qrenderdoc examples for latest API 2020-01-10 14:59:11 +00:00
baldurk 7454e9047e Ensure only one sphinx module:: directive exists
* Others using automodule:: must have :noindex:.
* I'm unclear when this is required - travis hit an error on this but I couldn't
  reproduce it locally, but it seems harmless.
2020-01-06 16:20:44 +00:00
baldurk 50da67195c Add missing Create*WindowingData to documented functions 2019-12-18 19:09:17 +00:00
baldurk 47fdb5add3 Exclude StructuredBufferList, StructuredObjectList from python docs
* These types should be mapped/treated invisibly as native python lists.
2019-11-12 20:44:35 +00:00
baldurk a94f238e37 Ensure PersistantConfig member functions are documented 2019-10-09 10:25:49 +01:00
baldurk ba16bd9bfe Pass PSO when decoding cbuffer variables in python example 2019-09-18 13:04:50 +01:00
baldurk 702c7cf093 Add use of ReplayOptions to python API examples 2019-09-18 13:04:38 +01:00
baldurk 07158ad24c Fix support for triangle fans on GL/Vulkan 2019-08-20 15:33:12 +01:00
Waffle fa18367109 Updated documentation with unpackData fix
Updated example documentation to match the already accepted "Fixed Incorrect Tuple Usage in unpackData" fix.
2019-08-13 10:33:34 +01:00
baldurk e2704fa2eb Add an abstracted interface around android-specific handling
* This makes it easier to use the same kind of interface to manage other kinds
  of devices.
2019-07-31 17:51:13 +01:00
Waffle 9aaca1bb5f Fixed Incorrect Tuple Usage in unpackData
Fixed "IndexError: tuple index out of range"
`value = tuple(float(value[i]) / divisor for i in value)`
Was effectively attempting to access the value tuple using an element as an index.

`value = tuple(float(i) / divisor for i in value)`
Uses the elements from the tuple and modifies them.

Ex: (0,0,0,255) becomes: (0.0, 0.0, 0.0, 255.0)
Instead of throwing an error.
2019-07-22 12:42:26 +01:00
baldurk ec1f104b44 Shutdown capture file properly in python example 2019-04-12 11:04:54 +01:00
baldurk 27a4353ffa Fix out of date python use in documentation examples 2019-01-16 12:38:10 +00:00
baldurk 91a7d45f85 Document new python version info functions 2018-11-30 15:48:42 +00: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 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