PVRCarbon Player Command Line Options

A summary of all available command line options when using PVRCarbon Player

Option Description
-h, --help Display help and then exit.
--version Print version information and then exit.
-d, --delay=<NUM> Wait <NUM> milliseconds between rendering frames.
-e, --skip-failed-calls Skip calls that failed during recording.
-w, --show-windows=<WINDOWS> Only show windows in the numbered list specified by <WINDOWS>

Example: --show-windows=0,2,3

--offscreen Render all windows offscreen. This is equivalent to defining --show-windows with an empty list.
--log-level=<LEVEL> Define the level of logging, for example: --log-level=warning, error

Supported levels are: warning, error, info, verbose, critical, debug, silent

--print-mappings Output recorded vs playback mappings.
--wireframe Set the playback's polygon mode to line.
--disable-vsync Disable vsync if this is possible.
--ignore-errors PVRCarbon will stop playing if certain errors occur. These errors can be ignored by enabling this option, but it will make PVRCarbon unstable.
--enable-api-debug-report If supported, enable the API's debug reporting extension.
--allow-recorded-layers By default, the layers enabled at record time are ignored for instance/device creation. This option disables this.
--layers=<LAYERS> Set the layers to enable during playback.

Example: --layers=LAYER0,LAYER1

--add-instance-extensions=<EXTENSIONS> Set the extra extensions to enable at instance creation.

Example: --add-instance-extensions=EXT0,EXT1

--add-device-extensions=<EXTENSIONS> Set extra device extensions to enable at device creation.

Example: --add-device-extensions=EXT0, EXT1

--ignore-instance-extensions=<EXTENSIONS> Set the extensions to ignore at instance creation.

Example: --ignore-instance-extensions=EXT0,EXT1

--ignore-device-extensions=<EXTENSIONS> Set the extensions to ignore at device creation.

Example: --ignore-device-extensions=EXT0, EXT1

--capture-frames=<FRAMES> Select the frames to capture.

Example: --capture-writes=0,-8,10,34

--timestamp-calls=<UIDs> Print a timestamp before each mentioned call is played.

Example: --timestamp-calls=10.34.65

--renderdoc-capture=<FRAMES> If RenderDoc is present, trigger a capture on the passed list of frames.
Note: The frame number reported in the RenderDoc capture's filename will be 2 greater than PVRCarbon's.
--renderdoc-path=<STRING> Set the path to the renderdoc.dll/librenderdoc.so library to use for capturing. If undefined, the player will attempt to locate it.
--renderdoc-log-path-template=<STRING> Define the filename template for the RenderDoc output.

Example: --renderdoc-log-path-template="my_captures/example" will cause the RenderDoc output to save as "my_captures/example_frame1.rdc" or "my_captures/example_frame123.rdc"

--preload Preload all the calls before playing.
--large-data-memory-hint A hint (in mb) at how much large data, such as buffer and textures, should be resident in memory.
--ws=<VALUE>

Choose the windowing system to use.

Recognised values: Win32, NullWS

--display=<VALUE> Choose the display to render to. This may not be supported by the chosen window system.

Additional Information

If PVRTC is not supported on the host, the player will convert it to R8G8B8A8.

If ETC2 is not supported on the host, image data is converted to R8G8B8A8.