GFXRECON-REPLAY(1)

💖 NAME 💖

okay so bestie, gather round — gfxrecon-replay is the Unix manual page for gfxrecon-replay, and what it does is literally this: it's a tool to replay GFXReconstruct capture files. that's it, that's the whole job. iconic behavior honestly 💅

✨ DESCRIPTION ✨

gfxrecon-replay — a tool to replay GFXReconstruct capture files. yes we're saying it twice, it's that important 🫶

🌸 Usage 🌸

gfxrecon-replay
       [-h | --help] [--version] [--gpu <index>] [--pause-frame <N>]
       [--paused] [--sync] [--screenshot-all] [--screenshots
       <N1(-N2),...>] [--screenshot-format <format>] [--screenshot-dir
       <dir>] [--screenshot-prefix <file-prefix>] [--sfa |
       --skip-failed-allocations] [--replace-shaders <dir>] [--opcd |
       --omit-pipeline-cache-data] [--wsi <platform>] [--surface-index
       <N>] [--remove-unsupported] [-m <mode> | --memory-translation
       <mode>] <file>

🎀 Required arguments 🎀

• <file> — the path to the capture file you're replaying. you literally cannot skip this one bestie, it's the whole point 🌟

🦋 Optional arguments 🦋

• -h — print the usage info and dip out (same thing as --help).
• --version — print the version info and exit. short and sweet.
• --gpu <index> — use the specified device for replay, where index is the zero-based index into the array of physical devices that vkEnumeratePhysicalDevices hands back. ⚠️ heads up: replay may fail if the device you picked isn't compatible with the original capture devices. choose wisely bestie.
• --pause-frame <N> — pause after replaying frame number N.
• --paused — pause after replaying the first frame (same as --pause-frame 1).
• --screenshot-all — generate screenshots for all the frames. and when you turn this on, --screenshots just gets ignored, no hard feelings 💀
• --screenshots <N1[-N2][,...]> — generate screenshots for specific frames. you give target frames as a comma separated list of frame ranges. a range can be a single value (one single frame) or two hyphenated values (first and last frames to process). ranges should be in ascending order and they cannot overlap. also frame numbering is 1-based, so the first frame is frame 1. example: 200,301-305 gets you six screenshots. math girlies rise 👑
• --screenshot-format <format> — the image file format for screenshot generation. available formats are:
  • bmp — Bitmap file format. this is the default format.
• --screenshot-dir <dir> — directory to write screenshots into. default is the current working directory.
• --screenshot-prefix <file-prefix> — prefix to slap onto the screenshot file name. default is "screenshot", which gives you file names like "screenshot_frame8049.bmp". cute.
• --sfa — skip vkAllocateMemory, vkAllocateCommandBuffers, and vkAllocateDescriptorSets calls that failed during capture (same as --skip-failed-allocations).
• --replace-shaders <dir> — replace the shader code in each CreateShaderModule with the contents of the file <dir>/sh<handle_id> if it's found, where <handle_id> is the handle id of the CreateShaderModule call. see gfxrecon-extract.
• --opcd — omit pipeline cache data from calls to vkCreatePipelineCache and skip calls to vkGetPipelineCacheData (same as --omit-pipeline-cache-data).
• --wsi <platform> — force replay to use the specified wsi platform. available platforms are: auto,xlib,xcb,wayland.
• --surface-index <N> — restrict rendering to the *N*th surface object created. used with captures that include multiple surfaces. default is -1 (which means render to all surfaces).
• --sync — synchronize after each queue submission with vkQueueWaitIdle. very demure, very mindful, very synchronous ✨
• --remove-unsupported — remove unsupported extensions and features from instance and device creation parameters.
• -m <mode> — enable memory translation so you can replay on GPUs with memory types that aren't compatible with the capture GPU's memory types. available modes are:
  • none — no memory translation is performed. this is the default behavior.
  • remap — attempt to map capture memory types to compatible replay memory types, without altering memory allocation behavior.
  • realign — adjust memory allocation sizes and resource binding offsets based on replay memory properties.
  • 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.

💜 little version moment, no cap: GFXReconstruct Version 0.9.4-unknown (unknown-build-source) and Vulkan Header Version 1.2.162. that's the whole vibe check right there.

🌈 SEE ALSO 🌈

the full documentation for gfxrecon-replay lives as a Texinfo manual. if the info and gfxrecon-replay programs are properly installed at your site, this command:

info gfxrecon-replay

should give you access to the complete manual. go get that lore bestie 🧚

gfxrecon-replay version info: June 2021 — GFXRECON-REPLAY(1) 🎀 that's a wrap, mwah, bye bestie 💖🌸