Persistant Config¶
Contents
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.
-
LastLogPath
¶ The path to the last capture to be opened, which is useful as a default location for browsing.
-
RecentLogFiles
¶ A
list
ofstr
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
ofstr
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 theTextureViewer
should reset the visible range when a new texture is selected.Defaults to
False
.
-
TextureViewer_PerTexSettings
¶ True
if theTextureViewer
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 theShaderViewer
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 theEventBrowser
.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 theEventBrowser
should hide marker regions that don’t contain any actual non-marker events.Defaults to
False
.
-
EventBrowser_HideAPICalls
¶ True
if theEventBrowser
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 theEventBrowser
should apply any colours specified with API marker regions.Defaults to
True
.
-
EventBrowser_ColorEventRow
¶ True
if when colouring marker regions in theEventBrowser
, the whole row should be coloured instead of just a side-bar.Defaults to
True
.
-
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_AdbExecutablePath
¶ The path to the
adb
executable to use for Android interaction.
-
Android_MaxConnectTimeout
¶ The maximum timeout in seconds to wait when launching an Android package.
Defaults to
30
.
-
CheckUpdate_AllowChecks
¶ True
if when colouring marker regions in theEventBrowser
, the whole row should be coloured 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.
-
DegradedLog_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.
-
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.
-
RemoteHosts
¶ A
list
ofRemoteHost
handles to the currently configured remote hosts.
-
Remote Host¶
-
class
qrenderdoc.
RemoteHost
¶ A handle for interacting with a remote servers on a given host.
-
Busy
¶ True
if someone else is currently connected to this server.
-
CheckStatus
()¶ Ping the host to check current status - if the server is running, connection status, etc.
-
Connected
¶ True
if an active connection exists to this remote server.
-
Hostname
¶ The hostname of this host.
-
Launch
()¶ Runs the command specified in
RunCommand
.
-
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.
-