File size: 13,848 Bytes
f864a1e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
{
    "file_format_version": "1.2.0",
    "layer": {
        "name": "VK_LAYER_LUNARG_api_dump",
        "type": "GLOBAL",
        "library_path": ".\\VkLayer_api_dump.dll",
        "api_version": "1.4.341",
        "implementation_version": "2",
        "description": "LunarG API dump layer",
        "introduction": "The API Dump utility layer prints API calls, parameters, and values to the identified output stream.",
        "url": "https://vulkan.lunarg.com/doc/sdk/latest/windows/api_dump_layer.html",
        "platforms": [
            "WINDOWS",
            "LINUX",
            "MACOS",
            "ANDROID"
        ],
        "instance_extensions": [
            {
                "name": "VK_EXT_layer_settings",
                "spec_version": "2"
            }
        ],
        "device_extensions": [
            {
                "name": "VK_EXT_tooling_info",
                "spec_version": "1",
                "entrypoints": [
                    "vkGetPhysicalDeviceToolPropertiesEXT"
                ]
            }
        ],
        "features": {
            "presets": [
                {
                    "label": "Console Output",
                    "description": "Output API dump to stdout",
                    "platforms": [
                        "WINDOWS",
                        "LINUX",
                        "MACOS",
                        "ANDROID"
                    ],
                    "status": "STABLE",
                    "settings": [
                        {
                            "key": "output_format",
                            "value": "text"
                        },
                        {
                            "key": "log_filename",
                            "value": "stdout"
                        },
                        {
                            "key": "file",
                            "value": false
                        }
                    ]
                },
                {
                    "label": "Text Output",
                    "description": "Output API dump to a text file",
                    "platforms": [
                        "WINDOWS",
                        "LINUX",
                        "MACOS",
                        "ANDROID"
                    ],
                    "status": "STABLE",
                    "settings": [
                        {
                            "key": "output_format",
                            "value": "text"
                        },
                        {
                            "key": "log_filename",
                            "value": "${VK_LOCAL}/vk_apidump.txt"
                        },
                        {
                            "key": "file",
                            "value": true
                        }
                    ]
                },
                {
                    "label": "HTML Output",
                    "description": "Output API dump to a HTML file",
                    "platforms": [
                        "WINDOWS",
                        "LINUX",
                        "MACOS",
                        "ANDROID"
                    ],
                    "status": "STABLE",
                    "settings": [
                        {
                            "key": "output_format",
                            "value": "html"
                        },
                        {
                            "key": "log_filename",
                            "value": "${VK_LOCAL}/vk_apidump.html"
                        },
                        {
                            "key": "file",
                            "value": true
                        }
                    ]
                },
                {
                    "label": "JSON Output",
                    "description": "Output API dump to a JSON file",
                    "platforms": [
                        "WINDOWS",
                        "LINUX",
                        "MACOS",
                        "ANDROID"
                    ],
                    "status": "STABLE",
                    "settings": [
                        {
                            "key": "output_format",
                            "value": "json"
                        },
                        {
                            "key": "log_filename",
                            "value": "${VK_LOCAL}/vk_apidump.json"
                        },
                        {
                            "key": "file",
                            "value": true
                        }
                    ]
                }
            ],
            "settings": [
                {
                    "key": "output_range",
                    "env": "VK_APIDUMP_OUTPUT_RANGE",
                    "label": "Output Range",
                    "description": "Comma separated list of frames to output or a range of frames with a start, count, and optional interval separated by a dash. A count of 0 will output every frame after the start of the range. Example: \"5-8-2\" will output frame 5, continue until frame 13, dumping every other frame. Example: \"3,8-2\" will output frames 3, 8, and 9.",
                    "type": "STRING",
                    "default": "0-0"
                },
                {
                    "key": "output_format",
                    "env": "VK_APIDUMP_OUTPUT_FORMAT",
                    "label": "Output Format",
                    "description": "Specifies the format used for output; can be HTML, JSON, or  Text (default -- outputs plain text)",
                    "type": "ENUM",
                    "flags": [
                        {
                            "key": "text",
                            "label": "Text",
                            "description": "Plain text"
                        },
                        {
                            "key": "html",
                            "label": "HTML",
                            "description": "HTML"
                        },
                        {
                            "key": "json",
                            "label": "JSON",
                            "description": "Json"
                        }
                    ],
                    "default": "text",
                    "settings": [
                        {
                            "key": "pre_dump",
                            "env": "VK_APIDUMP_PRE_DUMP",
                            "label": "Pre-dump the parameters.",
                            "description": "Setting this to true causes parameters to calls be logged before the function as well as after the function.",
                            "type": "BOOL",
                            "default": false,
                            "dependence": {
                                "mode": "ALL",
                                "settings": [
                                    {
                                        "key": "output_format",
                                        "value": "text"
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "key": "file",
                    "label": "Output to File",
                    "description": "Setting this to true indicates that output should be written to file instead of stdout",
                    "type": "BOOL",
                    "default": false,
                    "settings": [
                        {
                            "key": "log_filename",
                            "env": "VK_APIDUMP_LOG_FILENAME",
                            "label": "Log Filename",
                            "description": "Specifies the file to dump to when output files are enabled",
                            "type": "SAVE_FILE",
                            "filter": "*.txt,*.html,*.json",
                            "default": "stdout",
                            "dependence": {
                                "mode": "ALL",
                                "settings": [
                                    {
                                        "key": "file",
                                        "value": true
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "key": "flush",
                    "env": "VK_APIDUMP_FLUSH",
                    "label": "Log Flush After Write",
                    "description": "Setting this to true causes IO to be flushed after each API call that is written",
                    "type": "BOOL",
                    "default": true
                },
                {
                    "key": "name_size",
                    "label": "Name Size",
                    "description": "The number of characters the name of a variable should consume, assuming more are not required",
                    "type": "INT",
                    "default": 32,
                    "range": {
                        "min": 1
                    },
                    "unit": "chars"
                },
                {
                    "key": "show_types",
                    "label": "Show Types",
                    "description": "Dump types in addition to values",
                    "type": "BOOL",
                    "default": true,
                    "settings": [
                        {
                            "key": "type_size",
                            "label": "Type Size",
                            "description": "The number of characters the name of a type should consume, assuming more are not required",
                            "type": "INT",
                            "default": 0,
                            "range": {
                                "min": 0
                            },
                            "dependence": {
                                "mode": "ALL",
                                "settings": [
                                    {
                                        "key": "show_types",
                                        "value": true
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "key": "timestamp",
                    "env": "VK_APIDUMP_TIMESTAMP",
                    "label": "Show Timestamp",
                    "description": "Show the timestamp of function calls since start in microseconds",
                    "type": "BOOL",
                    "default": false
                },
                {
                    "key": "show_shader",
                    "label": "Show Shader",
                    "description": "Dump the shader binary code in pCode as an hex array which can be viewed in https://www.khronos.org/spir/visualizer/",
                    "type": "BOOL",
                    "default": false
                },
                {
                    "key": "detailed",
                    "env": "VK_APIDUMP_DETAILED",
                    "label": "Show Parameter Details",
                    "description": "Dump parameter details in addition to API calls",
                    "type": "BOOL",
                    "default": true
                },
                {
                    "key": "no_addr",
                    "env": "VK_APIDUMP_NO_ADDR",
                    "label": "Hide Addresses",
                    "description": "Dump \"address\" in place of hex addresses",
                    "type": "BOOL",
                    "default": false
                },
                {
                    "key": "use_spaces",
                    "label": "Use Spaces",
                    "description": "Setting this to true causes all tab characters to be replaced with spaces",
                    "type": "BOOL",
                    "default": true,
                    "settings": [
                        {
                            "key": "indent_size",
                            "label": "Indent Size",
                            "description": "Specifies the number of spaces that a tab is equal to",
                            "type": "INT",
                            "default": 4,
                            "range": {
                                "min": 1,
                                "max": 16
                            },
                            "unit": "chars",
                            "dependence": {
                                "mode": "ALL",
                                "settings": [
                                    {
                                        "key": "use_spaces",
                                        "value": true
                                    }
                                ]
                            }
                        }
                    ]
                },
                {
                    "key": "show_thread_and_frame",
                    "label": "Show Thread and Frame",
                    "description": "Show the thread and frame of each function called",
                    "type": "BOOL",
                    "default": true
                }
            ]
        }
    }
}