.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH USAGE: "1" "June 2021" "gfxrecon-capture" "User Commands"
.SH NAME
gfxrecon-capture \- Create a capture of a Vulkan program
.SH DESCRIPTION
usage: gfxrecon\-capture.py [\-h]
.TP
[\-w dir]
[\-o captureFile]
[\-f captureFrames]
[\-\-no\-file\-timestamp]
[\-\-trigger {F1\-F12,TAB,CTRL}]
[\-\-compression\-type {LZ4,ZLIB,ZSTD,NONE}]
[\-\-file\-flush]
[\-\-log\-level {debug,info,warn,error,fatal}]
[\-\-log\-file <file>]
[\-\-memory\-tracking\-mode {page_guard,assisted,unassisted}]
<program> [<programArgs>]
.PP
Create a capture of a Vulkan program.
.SS "positional arguments:"
.TP
<program> [<program args>]
Program to capture, optionally followed by program
arguments
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-w\fR <dir>, \fB\-\-working\-dir\fR <dir>
Set CWD to this directory before running the program
.TP
\fB\-o\fR <captureFile>, \fB\-\-capture\-file\fR <captureFile>
Name of the capture file, default is
gfxrecon_capture.gfxr
.TP
\fB\-f\fR <captureFrames>, \fB\-\-capture\-frames\fR <captureFrames>
List of frames to capture, default is all frames
.TP
\fB\-\-no\-file\-timestamp\fR
Do not add a timestamp to the capture file name
.TP
\fB\-\-trigger\fR {F1,F2,F3,F4,F5,F6,F7,F8,F9,F10,F11,F12,TAB,CTRL}
Specify a hotkey to start/stop capture
.TP
\fB\-\-compression\-type\fR {LZ4,ZLIB,ZSTD,NONE}
Specify the type of compression to use in the capture
file, default is LZ4
.TP
\fB\-\-file\-flush\fR
Flush output stream after each packet is written to
capture file
.TP
\fB\-\-log\-level\fR {debug,info,warn,error,fatal}
Specify highest level message to log, default is info
.TP
\fB\-\-log\-file\fR logFile
Name of the log file (disable logging with empty
string), default is stdout/stderr
.TP
\fB\-\-memory\-tracking\-mode\fR {page_guard,assisted,unassisted}
Method to use to track changes to memory mapped objects:
.TP
page_guard: use pageguard to track changes (default)
assisted: application will call vkFlushMappedMemoryRanges
.TP
for memory to be written to the capture file
unassisted: all mapped memory will be written to the
.IP
capture file during VkQueueSubmit and VkUnmapMemory
.TP
[\-w dir]
[\-o captureFile]
[\-f captureFrames]
[\-\-no\-file\-timestamp]
[\-\-trigger {F1\-F12,TAB,CTRL}]
[\-\-compression\-type {LZ4,ZLIB,ZSTD,NONE}]
[\-\-file\-flush]
[\-\-log\-level {debug,info,warn,error,fatal}]
[\-\-log\-file <file>]
[\-\-memory\-tracking\-mode {page_guard,assisted,unassisted}]
<program> [<programArgs>]
.SH "SEE ALSO"
The full documentation for
.B usage:
is maintained as a Texinfo manual.  If the
.B info
and
.B usage:
programs are properly installed at your site, the command
.IP
.B info usage:
.PP
should give you access to the complete manual.