Windows

MainWindow

class qrenderdoc.MainWindow

The main parent window of the application.

Widget()

Retrieves the QWidget for this MainWindow if PySide2 is available, or None.

EventBrowser

class qrenderdoc.EventBrowser

The event browser window.

UpdateDurationColumn()

Updates the duration column if the selected time unit changes.

Widget()

Retrieves the QWidget for this EventBrowser if PySide2 is available, or None.

APIInspector

class qrenderdoc.APIInspector

The API inspector window.

Refresh()

Refresh the current API view - useful if callstacks are now available.

Widget()

Retrieves the QWidget for this APIInspector if PySide2 is available, or None.

PipelineStateViewer

class qrenderdoc.PipelineStateViewer

The pipeline state viewer window.

SaveShaderFile(shader)

Prompt the user to save the binary form of the given shader to disk.

Parameters:shader (ShaderReflection) – The shader reflection data to save.
Widget()

Retrieves the QWidget for this PipelineStateViewer if PySide2 is available, or None.

TextureViewer

class qrenderdoc.TextureViewer

The texture viewer window.

GotoLocation(x, y)

Highlights the given pixel location in the current texture.

Parameters:
  • x (int) – The X co-ordinate.
  • y (int) – The Y co-ordinate.
ViewTexture(ID, focus)

Open a texture view, optionally raising this window to the foreground.

Parameters:
Widget()

Retrieves the QWidget for this TextureViewer if PySide2 is available, or None.

BufferViewer

class qrenderdoc.BufferViewer

The buffer viewer window, either a raw buffer or the geometry pipeline.

ScrollToRow(row, stage)

ScrollToRow(row)

Scroll to the given row in the given stage’s data.

Parameters:
  • row (int) – the row to scroll to.
  • stage (MeshDataStage) – The stage of the geometry pipeline to scroll within.
ViewBuffer(byteOffset, byteSize, id, format)

ViewBuffer(byteOffset, byteSize, id)

In a raw buffer viewer, load the contents from a particular buffer resource.

Parameters:
  • byteOffset (int) – The offset in bytes to the start of the data.
  • byteSize (int) – The number of bytes to read out.
  • id (ResourceId) – The ID of the buffer itself.
  • format (str) – Optionally a HLSL/GLSL style formatting string.
ViewTexture(arrayIdx, mip, id, format)

ViewTexture(arrayIdx, mip, id)

In a raw buffer viewer, load the contents from a particular texture resource.

Parameters:
  • arrayIdx (int) – The array slice to load from.
  • mip (int) – The mip level to load from.
  • id (ResourceId) – The ID of the texture itself.
  • format (str) – Optionally a HLSL/GLSL style formatting string.
Widget()

Retrieves the QWidget for this BufferViewer if PySide2 is available, or None.

CaptureDialog

class qrenderdoc.CaptureDialog

The executable capture window.

IsInjectMode()

Determines if the window is in inject or launch mode.

Returns:True if the window is set up for injecting.
Return type:bool
LoadSettings(filename)

Loads settings from a file and applies them. See SetSettings().

Parameters:filename (str) – The filename to load the settings from.
SaveSettings(filename)

Saves the current settings to a file. See Settings().

Parameters:filename (str) – The filename to save the settings to.
SetCommandLine(cmd)

Sets the command line string to use when launching an executable.

Parameters:cmd (str) – The command line to use.
SetEnvironmentModifications(modifications)

Sets the list of environment modifications to apply when launching.

Parameters:modifications (list) – The list of EnvironmentModification to apply.
SetExecutableFilename(filename)

Sets the executable filename to capture.

Parameters:filename (str) – The filename to execute.
SetInjectMode(inject)

Switches the window to or from inject mode.

Parameters:inject (bool) – True if the window should configure for injecting into processes.
SetSettings(settings)

Configures the window based on a bulk structure of settings.

Parameters:settings (CaptureSettings) – The settings to apply.
SetWorkingDirectory(dir)

Sets the working directory for capture.

Parameters:dir (str) – The directory to use.
Settings()

Retrieves the current state of the window as a structure of settings.

Returns:The settings describing the current window state.
Return type:CaptureSettings
TriggerCapture()

Launches a capture of the current executable.

UpdateGlobalHook()

Update the current state of the global hook, e.g. if it has been enabled.

Widget()

Retrieves the QWidget for this CaptureDialog if PySide2 is available, or None.

DebugMessageView

class qrenderdoc.DebugMessageView

The debug warnings and errors window.

Widget()

Retrieves the QWidget for this DebugMessageView if PySide2 is available, or None.

StatisticsViewer

class qrenderdoc.StatisticsViewer

The statistics window.

Widget()

Retrieves the QWidget for this StatisticsViewer if PySide2 is available, or None.

ShaderViewer

class qrenderdoc.ShaderViewer

A shader window used for viewing, editing, or debugging.

SaveCallback(context, viewer, files)

Not a member function - the signature for any SaveCallback callbacks.

Called whenever a shader viewer that was open for editing triggers a save/update.

Parameters:
  • context (CaptureContext) – The current capture context.
  • viewer (ShaderViewer) – The open shader viewer.
  • files (dict) – A dictionary with str filename keys and str file contents values.
CloseCallback(context)

Not a member function - the signature for any CloseCallback callbacks.

Called whenever a shader viewer that was open for editing is closed.

Parameters:context (CaptureContext) – The current capture context.
CurrentStep()

Retrieves the current step in the debugging.

Returns:The current step.
Return type:int
SetCurrentStep(step)

Sets the current step in the debugging.

Parameters:step (int) – The current step to jump to.
ShowErrors(errors)

Show a list of shader compilation errors or warnings.

Parameters:errors (str) – The string of errors or warnings to display.
ToggleBreakpoint(instruction=-1)

ToggleBreakpoint()

Toggles a breakpoint at a given instruction.

Parameters:instruction (int) – The instruction to toggle breakpoint at. If this is -1 the nearest instruction after the current caret position is used.
Widget()

Retrieves the QWidget for this ShaderViewer if PySide2 is available, or None.

ConstantBufferPreviewer

class qrenderdoc.ConstantBufferPreviewer

A constant buffer preview window.

Widget()

Retrieves the QWidget for this ConstantBufferPreviewer if PySide2 is available, or None.

PixelHistoryView

class qrenderdoc.PixelHistoryView

A pixel history window.

SetHistory(history)

Set the history displayed in this window.

Parameters:history (list) – A list of PixelModification events to display.
Widget()

Retrieves the QWidget for this PixelHistoryView if PySide2 is available, or None.