The pipeline stage view allows you quickly load a layout that is customized to show data specific to a given stage of the graphics pipeline.
The pipeline stage view also allows you do to the following:
- customize the layout associated with any pipeline stage
- create and manage user-defined layouts
- set a particular layout as the default layout to load when the Frame Debugger is first opened
- clone existing layouts
- export a layout to a file and import a layout from a file
- rename custom layouts
The pipeline stage view supports a set of layouts for each graphics API supported by GPU PerfStudio. There is one layout for each stage of the graphics pipeline, as well as four user-defined layouts.
When you first open the Frame Debugger, the default layout for the current API is automatically loaded. You can load the layout for any pipeline stage by clicking on that stage. When you select a stage, the existing layout is closed and the layout associated with the selected stage is loaded. The pipeline stage view indicates which stage is loaded by highlighting the background of the stage. When a layout is loaded, the windows contained in the layout are fixed -- you can not close or move a window, nor can you open additional windows. You must choose to edit a layout before you can modify it.
The following image shows the pipeline stage view with the DX11 PS stage selected, and the frame debugger with the DX11 PS layout loaded:
You can manage the layouts using the context menu that appears when right clicking on a particular stage. The context menu is slightly different depending on whether you right click on a pipeline stage or a user-defined layout. The following image shows the context menu that appears when right clicking on a pipeline stage:
- Edit - Places the selected layout in Edit mode, allowing you to open additional windows, close any open windows, drag and dock any open windows to change where they appear in the layout, resize windows, etc.
- Revert to Default Layout - Reverts the layout for the selected stage back to the default layout for that stage. This command is useful if you've made changes to a layout and you later decide that you want to revert back to the version of the layout that comes with GPU PerfStudio.
- Set as Default Layout - Sets the layout associated with the selected stage to be the default layout loaded automatically when the Frame Debugger is first opened.
- Export Layout to File... - Exports the layout for the selected stage to an .xml file that can later be imported.
- Import Layout from File... - Imports a previously exported layout as the layout associated with the selected stage.
The following image shows the context menu that appears when right clicking on a user layout:
- Edit - Places the selected layout in Edit mode, allowing you to open additional windows, close any open windows, drag and dock any open windows to change where they appear in the layout, resize windows, etc.
- Set as Default Layout - Sets the selected user layout to be the default layout loaded automatically when the Frame Debugger is first opened.
- Clone - Allows you to clone an existing layout into the selected user layout. A submenu is displayed showing the available layouts that can be cloned.
- Rename... - Allows you to rename the selected user layout to a more descriptive name.
- Export Layout to File... - Exports the selected user layout to an .xml file that can later be imported.
- Import Layout from File... - Imports a previously exported layout as the selected user layout.
When you choose to edit a layout, the selected layout is placed in Edit mode. This following image shows a layout in Edit mode:
In Edit mode, you can open additional windows using the command tree on the left hand side. You can also close, resize, or reposition any open windows within the layout. To save changes made to a layout, click the "Save Layout" button located above the command tree. To discard any changes made and exit Edit mode, click the "Cancel" button located above the command tree.
The Resources Viewer allows the user to select a set of image resources that they want to display in a thumbnail viewer. The user can select which images to include in the viewer by clicking on the "Select Resources" button. A dialog window is presented allowing the user to select image data from the various pipeline stages. The resources viewer contains a larger image viewer in which the individual thumbnails can be displayed at higher resolution. A single click on a thumbnail image will open it in the larger window. A double click on the thumbnail image or the larger image will open the image in an even larger modal dialog. NOTE: the user can undock the larger image window and dock it separately from the thumbnail view.
The "Show Descriptions" checkbox controls if basic information about the resource is shown alongside each thumbnail image.
GPU PerfStudio ships with default layouts that include a properties window to display text based data. The properties window in each layout has been customized to show data from the stage that the layout is associated with. For example, clicking on the DX11 PS stage will show a properties window that contains sampler information, shader linkage, and the output merger render states.
Each of the data items can be displayed by using the pull down menu at the top of the property window.
The contents of the properties window can be edited to show data items from any stage of the pipeline if the user requires this. To customize the properties data selection right click on the stage you wish to edit to go into edit mode. A new button called "Select Properties" will appear at the top of the properties window. Click this button to bring up the "Select Properties" dialog and select the data items you want to appear. Click the Save Layout button in the stage tree to save your edits and go back to user mode.