Reference (Programmatic Capture)

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Graphics Diagnostics supports programmatic control over its capture features, through the programmatic capture API. You can use this API to toggle and add messages to the graphics diagnostics HUD (Head-Up Display), initialize and create graphics log files, and capture graphics information.

Programmatic Capture APIs

Classes

Name Description
VsgDbg Class Represents the interface through which the in-app component of graphics diagnostics is controlled programmatically.

Preprocessor Symbols

Name Description
DONT_SAVE_VSGLOG_TO_TEMP Defines by its presence whether the graphics log file is saved to the user's temporary files directory.
VSG_DEFAULT_RUN_FILENAME Defines the default file name of the graphics log file.
VSG_NODEFAULT_INSTANCE Defines by its presence whether a default instance of the VsgDbg class is provided.
Title Description
Capturing Graphics Information Shows how to capture graphics information from your DirectX-based app so that you can use Visual Studio Graphics Diagnostics tools to diagnose rendering problems.
Overview Shows how Graphics Diagnostics can help you debug rendering errors in DirectX games and apps.