Commit Graph

30 Commits

Author SHA1 Message Date
baldurk a3d4f47865 Add correct return type for new functions in API docs 2026-03-05 16:33:52 +00:00
baldurk 565fe17ba2 Add API and usage documentation for custom annotations system 2026-01-28 14:42:11 +00:00
baldurk dfe07d6822 Update application API to 1.6.0, add capture title setter 2022-11-21 13:49:15 +00:00
baldurk 089126c34b Add a new in-app API function ShowReplayUI to raise the UI window
* This is not guaranteed to work, e.g. on windows where for good reason
  background windows can't necessarily raise themselves.
2022-01-12 11:24:22 +00: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 399f1c59e0 Remove trailing line referring to old removed section of docs 2021-05-20 10:12:52 +01:00
baldurk cc2d736301 Remove piece in documentation that caused more problems than it solved 2021-04-23 19:07:31 +01:00
baldurk 9547b049e3 Update version number on in-application API documentation 2020-08-05 11:41:31 +01:00
baldurk e1fe211f3c Rename Shutdown to RemoveHooks in in-application API. Version is 1.4.1
* This is a binary and source backwards compatible change.
2020-01-30 13:02:23 +00:00
baldurk 6d40bbb783 Add experimental wayland support. Refs #853
* This is only lightly tested and may break heavily. It is disabled by default
 and must be explicitly enabled.
* In particular this is only known to work for Wayland use at capture time.
 Wayland on replay is still unsupported. Known issues include: EGL pbuffer
 surfaces are not implemented on Wayland, Wayland cannot get window dimensions,
 and there are hangs/failures with GL and vulkan presentation with Wayland.
2019-09-02 15:02:27 +01:00
baldurk 776b689701 Fix documentation of return types on some application API functions 2019-07-23 14:46:22 +01:00
baldurk 95ce6d5b59 Add a bit more clarification on how to load and use RenderDoc's API 2019-04-26 14:00:27 +01:00
baldurk af53fdf89a Document what RENDERDOC_DevicePointer should be for D3D12 2019-04-26 13:57:16 +01:00
baldurk 61b39c80a1 Update VerifyMapWrites option to VerifyBufferWrites option in API docs 2019-02-04 18:06:10 +00:00
baldurk 18af132601 Update API documentation to mention SetCaptureFileComments 2019-02-04 18:06:10 +00:00
baldurk ab8d07f29c Add DiscardFrameCapture to in-application API, bumped to version 1.4.0 2019-01-08 11:35:48 +00:00
baldurk cc4a48b6d6 Expand renderdoc API example code in docs slightly
* Show the most common use, StartFrameCapture / EndFrameCapture
2018-11-28 14:43:44 +00: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 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 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 079c255bd8 Fix some missing whitespace around rst references in docs 2018-01-11 13:48:32 +00:00
baldurk f27e5d48f6 Fix typo in in_application_api restructuredText, missing colon on param 2017-12-15 17:33:54 +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 b4503f95cf Remove manual html target="_blank" links from documentation 2016-09-27 15:55:53 +02:00
baldurk 46644e127f Add some introductory text to the in-application API about how to start 2016-09-12 15:09:13 +02:00
baldurk 4573c9c20f Update docs of in-application API to 1.1.1 2016-08-30 14:38:35 +02:00
baldurk 8890233fe0 Set external links to open with target="_blank" for benefit of chm
* Without this, the chm viewer attempts to open the external link in its
  own windows. With some ancient IE6 monstrosity. Ouch.
2016-05-16 20:01:17 +02:00
baldurk 4691972148 Document the actual exported API entry point, RENDERDOC_GetAPI 2016-05-16 17:02:46 +02:00
baldurk 440c9c4569 Move in application API to root level 2016-05-16 14:43:46 +02:00