lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation to mention SetCaptureFileComments

Browse Source
This commit is contained in:
baldurk
2019-02-04 14:59:45 +00:00
parent f20e871510
commit 18af132601
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/in_application_api.rst
+7
View File
@@ -438,3 +438,10 @@ The path follows the template set in :cpp:func:`SetCaptureFilePathTemplate` so i
Each capture will be taken independently and saved to a separate file, with no reference to the other frames.
:param uint32_t numFrames: the number of frames to capture, as an unsigned integer.
.. cpp:function:: void SetCaptureFileComments(const char *filePath, const char *comments)
This function adds an arbitrary comments field to an existing capture on disk, which will then be displayed in the UI to anyone opening the capture.
:param const char* filePath: specifies the path to the capture file to set comments in, as UTF-8 null-terminated string. If this path is ``NULL`` or an empty string, the most recent capture file that has been created will be used.
:param const char* comments: specifies the comments to set in the capture file, as UTF-8 null-terminated string.