File: gfxrecon-replay.1

package info (click to toggle)
gfxreconstruct 1.0.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 33,252 kB
  • sloc: cpp: 498,756; python: 21,953; xml: 296; sh: 250; makefile: 6
file content (148 lines) | stat: -rw-r--r-- 4,810 bytes parent folder | download | duplicates (2)
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
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH GFXRECON-REPLAY "1" "June 2021" "gfxrecon-replay version info:" "User Commands"
.SH NAME
gfxrecon\-replay \- A tool to replay GFXReconstruct capture files.
.SH DESCRIPTION
gfxrecon\-replay \- A tool to replay GFXReconstruct capture files.
.SS "Usage:"
.TP
gfxrecon\-replay
[\-h | \fB\-\-help]\fR [\-\-version] [\-\-gpu <index>]
[\-\-pause\-frame <N>] [\-\-paused] [\-\-sync] [\-\-screenshot\-all]
[\-\-screenshots <N1(\fB\-N2\fR),...>] [\-\-screenshot\-format <format>]
[\-\-screenshot\-dir <dir>] [\-\-screenshot\-prefix <file\-prefix>]
[\-\-sfa | \fB\-\-skip\-failed\-allocations]\fR [\-\-replace\-shaders <dir>]
[\-\-opcd | \fB\-\-omit\-pipeline\-cache\-data]\fR [\-\-wsi <platform>]
[\-\-surface\-index <N>] [\-\-remove\-unsupported]
[\-m <mode> | \fB\-\-memory\-translation\fR <mode>]
<file>
.SS "Required arguments:"
.TP
<file>
Path to the capture file to replay.
.SS "Optional arguments:"
.TP
\fB\-h\fR
Print usage information and exit (same as \fB\-\-help\fR).
.TP
\fB\-\-version\fR
Print version information and exit.
.TP
\fB\-\-gpu\fR <index>
Use the specified device for replay, where index
is the zero\-based index to the array of physical devices
returned by vkEnumeratePhysicalDevices.  Replay may fail
if the specified device is not compatible with the
original capture devices.
.TP
\fB\-\-pause\-frame\fR <N>
Pause after replaying frame number N.
.TP
\fB\-\-paused\fR
Pause after replaying the first frame (same
as \fB\-\-pause\-frame\fR 1).
.TP
\fB\-\-screenshot\-all\fR
Generate screenshots for all frames.  When this
option is specified, \fB\-\-screenshots\fR is ignored.
.TP
\fB\-\-screenshots\fR <N1[\-N2][,...]>
Generate screenshots for the specified frames.
Target frames are specified as a comma separated
list of frame ranges.  A frame range can be specified
as a single value, to specify a single frame, or as
two hyphenated values, to specify the first and last
frames to process.  Frame ranges should be specified in
ascending order and cannot overlap.  Note that frame
numbering is 1\-based (i.e. the first frame is frame 1).
Example: 200,301\-305 will generate six screenshots.
.TP
\fB\-\-screenshot\-format\fR <format>
Image file format to use for screenshot generation.
Available formats are:
.TP
bmp
Bitmap file format.  This is the default format.
.TP
\fB\-\-screenshot\-dir\fR <dir>
Directory to write screenshots.  Default is the current
working directory.
.TP
\fB\-\-screenshot\-prefix\fR <file\-prefix>
Prefix to apply to the screenshot file name.  Default is
"screenshot", producing file names similar to
"screenshot_frame8049.bmp".
.TP
\fB\-\-sfa\fR
Skip vkAllocateMemory, vkAllocateCommandBuffers, and
vkAllocateDescriptorSets calls that failed during
capture (same as \fB\-\-skip\-failed\-allocations\fR).
.TP
\fB\-\-replace\-shaders\fR <dir> Replace the shader code in each CreateShaderModule
with the contents of the file <dir>/sh<handle_id> if found, where
<handle_id> is the handle id of the CreateShaderModule call.
See gfxrecon\-extract.
.TP
\fB\-\-opcd\fR
Omit pipeline cache data from calls to
vkCreatePipelineCache and skip calls to
vkGetPipelineCacheData (same as
\fB\-\-omit\-pipeline\-cache\-data\fR).
.TP
\fB\-\-wsi\fR <platform>
Force replay to use the specified wsi platform.
Available platforms are: auto,xlib,xcb,wayland
.TP
\fB\-\-surface\-index\fR <N>
Restrict rendering to the Nth surface object created.
Used with captures that include multiple surfaces.  Default
is \fB\-1\fR (render to all surfaces).
.TP
\fB\-\-sync\fR
Synchronize after each queue submission with vkQueueWaitIdle.
.TP
\fB\-\-remove\-unsupported\fR
Remove unsupported extensions and features from instance
and device creation parameters.
.TP
\fB\-m\fR <mode>
Enable memory translation for replay on GPUs with memory
types that are not compatible with the capture GPU's
memory types.  Available modes are:
.TP
none
No memory translation is performed.  This
is the default behavior.
.TP
remap
Attempt to map capture memory types to
compatible replay memory types, without
altering memory allocation behavior.
.TP
realign
Adjust memory allocation sizes and
resource binding offsets based on
replay memory properties.
.TP
rebind
Change memory allocation behavior based
on resource usage and replay memory
properties.  Resources may be bound
to different allocations with different
offsets.  Uses VMA to manage allocations
and suballocations.
.IP
GFXReconstruct Version 0.9.4\-unknown (unknown\-build\-source)
Vulkan Header Version 1.2.162
.SH "SEE ALSO"
The full documentation for
.B gfxrecon-replay
is maintained as a Texinfo manual.  If the
.B info
and
.B gfxrecon-replay
programs are properly installed at your site, the command
.IP
.B info gfxrecon-replay
.PP
should give you access to the complete manual.