Repository navigation
Expand file tree
/
Copy pathapp_api.cpp
More file actions
455 lines (365 loc) · 12.5 KB
/
Copy pathapp_api.cpp
File metadata and controls
455 lines (365 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2015-2026 Baldur Karlsson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
#include <string.h>
#include "api/app/renderdoc_app.h"
#include "api/replay/apidefs.h" // for RENDERDOC_API to export the RENDERDOC_GetAPI function
#include "common/common.h"
#include "common/formatting.h"
#include "core/core.h"
#include "hooks/hooks.h"
#include "serialise/rdcfile.h"
static void SetFocusToggleKeys(RENDERDOC_InputButton *keys, int num)
{
RenderDoc::Inst().SetFocusKeys(keys, num);
}
static void SetCaptureKeys(RENDERDOC_InputButton *keys, int num)
{
RenderDoc::Inst().SetCaptureKeys(keys, num);
}
static uint32_t GetOverlayBits()
{
return RenderDoc::Inst().GetOverlayBits();
}
static void MaskOverlayBits(uint32_t And, uint32_t Or)
{
RenderDoc::Inst().MaskOverlayBits(And, Or);
}
static void RemoveHooks()
{
RenderDoc::Inst().RemoveHooks();
LibraryHooks::RemoveHooks();
}
static void UnloadCrashHandler()
{
RenderDoc::Inst().UnloadCrashHandler();
}
static void SetCaptureFilePathTemplate(const char *pathtemplate)
{
RDCLOG("Using capture file template %s", pathtemplate);
RenderDoc::Inst().SetCaptureFileTemplate(pathtemplate);
}
static const char *GetCaptureFilePathTemplate()
{
return RenderDoc::Inst().GetCaptureFileTemplate();
}
static uint32_t GetNumCaptures()
{
return (uint32_t)RenderDoc::Inst().GetCaptures().size();
}
static uint32_t GetCapture(uint32_t idx, char *filename, uint32_t *pathlength, uint64_t *timestamp)
{
rdcarray<CaptureData> caps = RenderDoc::Inst().GetCaptures();
if(idx >= (uint32_t)caps.size())
{
if(filename)
filename[0] = 0;
if(pathlength)
*pathlength = 0;
if(timestamp)
*timestamp = 0;
return 0;
}
CaptureData &c = caps[idx];
if(filename)
memcpy(filename, c.path.c_str(), sizeof(char) * (c.path.size() + 1));
if(pathlength)
*pathlength = uint32_t(c.path.size() + 1);
if(timestamp)
*timestamp = c.timestamp;
return 1;
}
static void SetCaptureFileComments(const char *filePath, const char *comments)
{
rdcstr path;
if(filePath == NULL || filePath[0] == 0)
{
rdcarray<CaptureData> caps = RenderDoc::Inst().GetCaptures();
if(caps.empty())
{
RDCERR(
"SetCaptureFileComments called with NULL/empty filePath, but no captures have been made");
return;
}
path = caps.back().path;
}
else
{
path = filePath;
}
RDCFile rdc;
rdc.Open(path);
if(rdc.Error() != ResultCode::Succeeded)
{
RDCERR("Error adding capture file comments: %s", ResultDetails(rdc.Error()).Message().c_str());
return;
}
SectionProperties props;
props.type = SectionType::Notes;
props.version = 1;
StreamWriter *writer = rdc.WriteSection(props);
if(comments)
{
rdcstr commentsjson = "{\"comments\":\"";
commentsjson.reserve(strlen(comments));
const char *c = comments;
while(*c)
{
// escape some characters
if(*c == '"')
commentsjson += "\\\"";
else if(*c == '\\')
commentsjson += "\\\\";
else if(*c == '\b')
commentsjson += "\\b";
else if(*c == '\f')
commentsjson += "\\f";
else if(*c == '\n')
commentsjson += "\\n";
else if(*c == '\r')
commentsjson += "\\r";
else if(*c == '\t')
commentsjson += "\\t";
else
commentsjson.push_back(*c);
c++;
}
commentsjson += "\"}";
writer->Write(commentsjson.c_str(), commentsjson.size());
}
delete writer;
}
static void TriggerCapture()
{
RenderDoc::Inst().TriggerCapture(1);
}
static void TriggerMultiFrameCapture(uint32_t numFrames)
{
RenderDoc::Inst().TriggerCapture(numFrames);
}
static uint32_t IsTargetControlConnected()
{
return RenderDoc::Inst().IsTargetControlConnected();
}
static uint32_t LaunchReplayUI(uint32_t connectTargetControl, const char *cmdline)
{
rdcstr replayapp = FileIO::GetReplayAppFilename();
if(replayapp.empty())
return 0;
rdcstr cmd = cmdline ? cmdline : "";
if(connectTargetControl)
cmd += StringFormat::Fmt(" --targetcontrol localhost:%u",
RenderDoc::Inst().GetTargetControlIdent());
return Process::LaunchProcess(replayapp, "", cmd, false);
}
static void SetActiveWindow(void *device, void *wndHandle)
{
RenderDoc::Inst().SetActiveWindow(DeviceOwnedWindow(device, wndHandle));
}
static void StartFrameCapture(void *device, void *wndHandle)
{
DeviceOwnedWindow devWnd(device, wndHandle);
RenderDoc::Inst().StartFrameCapture(devWnd);
if(devWnd.device == NULL || devWnd.windowHandle == NULL)
RenderDoc::Inst().MatchClosestWindow(devWnd);
if(devWnd.device != NULL && devWnd.windowHandle != NULL)
RenderDoc::Inst().SetActiveWindow(devWnd);
}
static uint32_t IsFrameCapturing()
{
return RenderDoc::Inst().IsFrameCapturing() ? 1 : 0;
}
static uint32_t EndFrameCapture(void *device, void *wndHandle)
{
return RenderDoc::Inst().EndFrameCapture(DeviceOwnedWindow(device, wndHandle)) ? 1 : 0;
}
static void SetCaptureTitle(const char *title)
{
RenderDoc::Inst().SetCaptureTitle(title);
}
static uint32_t DiscardFrameCapture(void *device, void *wndHandle)
{
return RenderDoc::Inst().DiscardFrameCapture(DeviceOwnedWindow(device, wndHandle)) ? 1 : 0;
}
static uint32_t ShowReplayUI()
{
return RenderDoc::Inst().ShowReplayUI() ? 1 : 0;
}
static uint32_t SetObjectAnnotation(void *device, void *object, const char *key,
RENDERDOC_AnnotationType valueType, uint32_t valueVectorWidth,
const RENDERDOC_AnnotationValue *value)
{
if(object == NULL)
{
RDCWARN("Invalid annotation - object must not be NULL.");
return 3;
}
if((valueType == eRENDERDOC_Empty && value != NULL) ||
(valueType != eRENDERDOC_Empty && value == NULL))
{
RDCWARN("Invalid annotation - value should be NULL and type should be empty");
return 3;
}
if((valueType == eRENDERDOC_Empty || valueType == eRENDERDOC_String ||
valueType == eRENDERDOC_APIObject) &&
valueVectorWidth != 0)
{
RDCWARN(
"Invalid annotation - for deletion, or setting strings and objects, vector width must be "
"0");
return 3;
}
if(key == NULL || key[0] == 0 || key[0] == '.')
{
RDCWARN("Invalid annotation - key should not be NULL, empty, or start with a .");
return 3;
}
DeviceOwnedWindow devWnd(device, NULL);
IFrameCapturer *capturer = RenderDoc::Inst().MatchFrameCapturer(devWnd);
if(!capturer)
return 1;
return capturer->SetObjectAnnotation(object, key, valueType, valueVectorWidth, value);
}
static uint32_t SetCommandAnnotation(void *device, void *queueOrCommandBuffer, const char *key,
RENDERDOC_AnnotationType valueType, uint32_t valueVectorWidth,
const RENDERDOC_AnnotationValue *value)
{
if((valueType == eRENDERDOC_Empty && value != NULL) ||
(valueType != eRENDERDOC_Empty && value == NULL))
{
RDCWARN("Invalid annotation - value should be NULL and type should be empty");
return 3;
}
if(key == NULL || key[0] == 0 || key[0] == '.')
{
RDCWARN("Invalid annotation - key should not be NULL, empty, or start with a .");
return 3;
}
if((valueType == eRENDERDOC_Empty || valueType == eRENDERDOC_String ||
valueType == eRENDERDOC_APIObject) &&
valueVectorWidth != 0)
{
RDCWARN(
"Invalid annotation - for deletion, or setting strings and objects, vector width must be "
"0");
return 3;
}
DeviceOwnedWindow devWnd(device, NULL);
IFrameCapturer *capturer = RenderDoc::Inst().MatchFrameCapturer(devWnd);
if(!capturer)
return 1;
return capturer->SetCommandAnnotation(queueOrCommandBuffer, key, valueType, valueVectorWidth,
value);
}
// defined in capture_options.cpp
int RENDERDOC_CC SetCaptureOptionU32(RENDERDOC_CaptureOption opt, uint32_t val);
int RENDERDOC_CC SetCaptureOptionF32(RENDERDOC_CaptureOption opt, float val);
uint32_t RENDERDOC_CC GetCaptureOptionU32(RENDERDOC_CaptureOption opt);
float RENDERDOC_CC GetCaptureOptionF32(RENDERDOC_CaptureOption opt);
void RENDERDOC_CC GetAPIVersion_1_7_0(int *major, int *minor, int *patch)
{
if(major)
*major = 1;
if(minor)
*minor = 7;
if(patch)
*patch = 0;
}
RENDERDOC_API_1_7_0 api_1_7_0;
void Init_1_7_0()
{
RENDERDOC_API_1_7_0 &api = api_1_7_0;
api.GetAPIVersion = &GetAPIVersion_1_7_0;
api.SetCaptureOptionU32 = &SetCaptureOptionU32;
api.SetCaptureOptionF32 = &SetCaptureOptionF32;
api.GetCaptureOptionU32 = &GetCaptureOptionU32;
api.GetCaptureOptionF32 = &GetCaptureOptionF32;
api.SetFocusToggleKeys = &SetFocusToggleKeys;
api.SetCaptureKeys = &SetCaptureKeys;
api.GetOverlayBits = &GetOverlayBits;
api.MaskOverlayBits = &MaskOverlayBits;
api.RemoveHooks = &RemoveHooks;
api.UnloadCrashHandler = &UnloadCrashHandler;
api.SetCaptureFilePathTemplate = &SetCaptureFilePathTemplate;
api.GetCaptureFilePathTemplate = &GetCaptureFilePathTemplate;
api.GetNumCaptures = &GetNumCaptures;
api.GetCapture = &GetCapture;
api.TriggerCapture = &TriggerCapture;
api.IsTargetControlConnected = &IsTargetControlConnected;
api.LaunchReplayUI = &LaunchReplayUI;
api.SetActiveWindow = &SetActiveWindow;
api.StartFrameCapture = &StartFrameCapture;
api.IsFrameCapturing = &IsFrameCapturing;
api.EndFrameCapture = &EndFrameCapture;
api.TriggerMultiFrameCapture = &TriggerMultiFrameCapture;
api.SetCaptureFileComments = &SetCaptureFileComments;
api.DiscardFrameCapture = &DiscardFrameCapture;
api.ShowReplayUI = &ShowReplayUI;
api.SetCaptureTitle = &SetCaptureTitle;
api.SetObjectAnnotation = &SetObjectAnnotation;
api.SetCommandAnnotation = &SetCommandAnnotation;
}
extern "C" RENDERDOC_API int RENDERDOC_CC RENDERDOC_GetAPI(RENDERDOC_Version version,
void **outAPIPointers)
{
if(outAPIPointers == NULL)
{
RDCERR("Invalid call to RENDERDOC_GetAPI with NULL outAPIPointers");
return 0;
}
int ret = 0;
int major = 0, minor = 0, patch = 0;
rdcstr supportedVersions = "";
#define API_VERSION_HANDLE(enumver, actualver) \
supportedVersions += " " STRINGIZE(CONCAT(API_, enumver)); \
if(version == CONCAT(eRENDERDOC_API_Version_, enumver)) \
{ \
CONCAT(Init_, actualver)(); \
*outAPIPointers = &CONCAT(api_, actualver); \
CONCAT(api_, actualver).GetAPIVersion(&major, &minor, &patch); \
ret = 1; \
}
API_VERSION_HANDLE(1_0_0, 1_7_0);
API_VERSION_HANDLE(1_0_1, 1_7_0);
API_VERSION_HANDLE(1_0_2, 1_7_0);
API_VERSION_HANDLE(1_1_0, 1_7_0);
API_VERSION_HANDLE(1_1_1, 1_7_0);
API_VERSION_HANDLE(1_1_2, 1_7_0);
API_VERSION_HANDLE(1_2_0, 1_7_0);
API_VERSION_HANDLE(1_3_0, 1_7_0);
API_VERSION_HANDLE(1_4_0, 1_7_0);
API_VERSION_HANDLE(1_4_1, 1_7_0);
API_VERSION_HANDLE(1_4_2, 1_7_0);
API_VERSION_HANDLE(1_5_0, 1_7_0);
API_VERSION_HANDLE(1_6_0, 1_7_0);
API_VERSION_HANDLE(1_7_0, 1_7_0);
#undef API_VERSION_HANDLE
if(ret)
{
RDCLOG("Initialising RenderDoc API version %d.%d.%d for requested version %d", major, minor,
patch, version);
return 1;
}
RDCERR("Unrecognised API version '%d'. Supported versions:%s", version, supportedVersions.c_str());
return 0;
}