# Persistant Config

Contents

- Persistant Config
  - Config
  - Remote Host

## Config

class `qrenderdoc.``PersistantConfig`

  A persistant config file that is automatically loaded and saved, which contains any settings and information that needs to be preserved from one run to the next.

  For more information about some of these settings that are user-facing see the documentation for the settings window.

  `UIStyle`

    The style to load for the UI. Possible values include ‘Native’, ‘RDLight’, ‘RDDark’. If empty, the closest of RDLight and RDDark will be chosen, based on the overall light-on-dark or dark-on-light theme of the application native style.

  `LastCaptureFilePath`

    The path to the last capture to be opened, which is useful as a default location for browsing.

  `LastFileBrowsePath`

    The path to the last file browsed to in any dialog. Used as a default location for all file browsers without another explicit default directory (such as opening capture files - see `LastCaptureFilePath`).

  `RecentCaptureFiles`

    A `list` of `str` with the recently opened capture files.

  `LastCapturePath`

    The path containing the last executable that was captured, which is useful as a default location for browsing.

  `LastCaptureExe`

    The path to the last executable that was captured, inside `LastCapturePath`.

  `RecentCaptureSettings`

    A `list` of `str` with the recently opened capture settings files.

  `TemporaryCaptureDirectory`

    The path to where temporary capture files should be stored until they’re saved permanently.

  `DefaultCaptureSaveDirectory`

    The default path to save captures in, when browsing to save a temporary capture somewhere.

  `TextureViewer_ResetRange`

    `True` if the `TextureViewer` should reset the visible range when a new texture is selected.

    Defaults to `False`.

  `TextureViewer_PerTexSettings`

    `True` if the `TextureViewer` should store most visualisation settings on a per-texture basis instead of keeping it persistent across different textures.

    Defaults to `True`.

  `ShaderViewer_FriendlyNaming`

    `True` if the `ShaderViewer` should replace register names with the high-level language variable names where possible.

    Defaults to `True`.

  `AlwaysReplayLocally`

    `True` if when loading a capture that was originally captured on a remote device but uses an API that can be supported locally, should be loaded locally without prompting to switch to a remote context.

    Defaults to `False`.

  `LocalProxyAPI`

    The index of the local proxy API to use when using remote context replay. `-1` if the default proxy should be used.

    Defaults to `-1`.

  `EventBrowser_TimeUnit`

    The `TimeUnit` to use to display the duration column in the `EventBrowser`.

    Defaults to microseconds.

  `EventBrowser_AddFake`

    `True` if fake drawcall marker regions should be added to captures that don’t have any markers, for easier browsing. The regions are identified by grouping drawcalls that write to the same targets together.

    Defaults to `True`.

  `EventBrowser_HideEmpty`

    `True` if the `EventBrowser` should hide marker regions that don’t contain any actual non-marker events.

    Defaults to `False`.

  `EventBrowser_HideAPICalls`

    `True` if the `EventBrowser` should hide marker regions that don’t contain any events that aren’t just drawcalls (this will hide events under “API Events” faux-markers).

    Defaults to `False`.

  `EventBrowser_ApplyColors`

    `True` if the `EventBrowser` should apply any colors specified with API marker regions.

    Defaults to `True`.

  `EventBrowser_ColorEventRow`

    `True` if when coloring marker regions in the `EventBrowser`, the whole row should be colored instead of just a side-bar.

    Defaults to `True`.

  `Comments_ShowOnLoad`

    `True` if when loading a new capture that contains a comments section, the comment viewer will be opened and focussed.

    Defaults to `False`.

  `Formatter_MinFigures`

    The minimum number of significant figures to show in formatted floating point values.

    Defaults to `2`.

  `Formatter_MaxFigures`

    The maximum number of significant figures to show in formatted floating point values.

    Defaults to `5`.

  `Formatter_NegExp`

    The cut-off on negative exponents of a normalised values to display using scientific notation.

    E.g. for a value of 5, anything below 1.0e-5 will be displayed using scientific notation.

    Defaults to `5`.

  `Formatter_PosExp`

    The cut-off on the exponent of a normalised values to display using scientific notation.

    E.g. for a value of 7, anything above 1.0e+7 will be displayed using scientific notation.

    Defaults to `7`.

  `Font_PreferMonospaced`

    `True` if a monospaced font should be used in all places where data is displayed, even if the data is not tabular such as names.

    Defaults to `False`.

  `Android_SDKPath`

    The path to the root of the android SDK, to locate android tools to use for android remote hosts.

    Defaults to using the tools distributed with RenderDoc.

  `Android_JDKPath`

    The path to the root of the Java JDK, to locate java for running android java tools.

    Defaults to using the JAVA_HOME environment variable, if set.

  `Android_MaxConnectTimeout`

    The maximum timeout in seconds to wait when launching an Android package.

    Defaults to `30`.

  `CheckUpdate_AllowChecks`

    `True` if when coloring marker regions in the `EventBrowser`, the whole row should be colored instead of just a side-bar.

    Defaults to `True`.

  `CheckUpdate_UpdateAvailable`

    `True` if an update to a newer version is currently available.

    Defaults to `False`.

  `CheckUpdate_UpdateResponse`

    Contains the response from the update server from the last update check, with any release notes for the new version.

  `CheckUpdate_LastUpdate`

    A date containing the last time that update checks happened.

  `DegradedCapture_LastUpdate`

    A date containing the last time that the user was warned about captures being loaded in degraded support. This prevents the user being spammed if their hardware is low spec.

  `ExternalTool_RadeonGPUProfiler`

    The path to the executable of the external Radeon GPU Profiler tool.

  `Tips_HasSeenFirst`

    `True` if the user has seen the first tip, which should always be shown first before randomising.

    Defaults to `False`.

  `AllowGlobalHook`

    `True` if global hooking is enabled. Since it has potentially problematic side-effects and is dangerous, it requires explicit opt-in.

    Defaults to `False`.

  `SPIRVDisassemblers`

    A list of `SPIRVDisassembler` detailing the potential disassembler programs. The first one in the list is the default.

  `Analytics_TotalOptOut`

    `True` if the user has selected to completely opt-out from and disable all analytics collection and reporting.

    Defaults to `False`.

  `Analytics_ManualCheck`

    `True` if the user has remained with analytics turned on, but has chosen to manually check each report that is sent out.

    Defaults to `False`.

  `CrashReport_EmailNagged`

    `True` if the user has been prompted to enter their email address on a crash report. This really helps find fixes for bugs, so we prompt the user once only if they didn’t enter an email. Once the prompt has happened, regardless of the answer this is set to true and remains there forever.

    Defaults to `False`.

  `CrashReport_ShouldRememberEmail`

    `True` if the email address entered in the crash reporter should be remembered for next time. If no email is entered then nothing happens (any previous saved email is kept).

    Defaults to `True`.

  `CrashReport_EmailAddress`

    The saved email address for pre-filling out in crash reports.

  `CrashReport_LastOpenedCapture`

    The last opened capture, to send if any crash is encountered. This is different to the most recent opened file, because it’s set before any processing happens (recent files are only added to the list when they successfully open), and it’s cleared again when the capture is closed.

  `CrashReport_ReportedBugs`

    A list of `BugReport` detailing previously submitted bugs that we’re watching for updates.

class `qrenderdoc.``SPIRVDisassembler`

  Describes an external program that can be used to disassemble SPIR-V.

  `DisassembleShader`(window, reflection)

    Runs this disassembler for a given shader reflection.

    Parameters: | window (QWidget) – A handle to the window to use when showing a progress bar or error messages. shader (ShaderReflection) – The shader to disassemble.
    Returns: | The disassembly, or an empty string if something went wrong.
    Return type: | `str`

  `args`

    The command line argmuents to pass to the program.

  `executable`

    The path to the executable to run for this program.

  `name`

    The human-readable name of the program.

  `tool`

    The `KnownSPIRVTool` identifying which known tool this disassembler is.

class `qrenderdoc.``BugReport`

  Describes a submitted bug report.

  `URL`()

    Gets the URL for this report.

    Returns: | The URL to the report.
    Return type: | `str`

  `checkDate`

    The last date that we checked for updates.

  `reportId`

    The private ID of the bug report.

  `submitDate`

    The original date when this bug was submitted.

  `unreadUpdates`

    Unread updates to the bug exist

class `qrenderdoc.``TimeUnit`

  The unit that GPU durations are displayed in.

  `Seconds`

    The durations are displayed as seconds (s).

  `Milliseconds`

    The durations are displayed as milliseconds (ms).

  `Microseconds`

    The durations are displayed as microseconds (µs).

  `Nanoseconds`

    The durations are displayed as nanoseconds (ns).

## Remote Host

class `qrenderdoc.``RemoteHost`

  A handle for interacting with a remote servers on a given host.

  `CheckStatus`()

    Ping the host to check current status - if the server is running, connection status, etc.

  `IsADB`()

    Returns `True` if this host represents a connected ADB (Android) device.

  `IsLocalhost`()

    Returns `True` if this host represents the special localhost device.

  `Launch`()

    Runs the command specified in `runCommand`.

  `Name`()

    Returns the name to display for this host in the UI, either `friendlyName` or `hostname`

  `busy`

    `True` if someone else is currently connected to this server.

  `connected`

    `True` if an active connection exists to this remote server.

  `friendlyName`

    The friendly name for this host, if available (if empty, the Hostname is used).

  `hostname`

    The hostname of this host.

  `runCommand`

    The command to run locally to try to launch the server remotely.

  `serverRunning`

    `True` if a remote server is currently running on this host.

  `versionMismatch`

    `True` if there is a code version mismatch with this server.