VsgDbg Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at VsgDbg Class.

Represents an interface for programmatic control of the in-app component of graphics diagnostics.

class VsgDbg;  

The VsgDbg class supports the following members.

Public Constructors

NameDescription
VsgDbg::VsgDbg (Constructor)Constructs an instance of the VsgDbg class and optionally prepares the in-app component of graphics diagnostics to actively capture and record graphics information.
VsgDbg::~VsgDbg (Destructor)Destroys an instance of the VsgDbg class.

Public Methods

NameDescription
AddMessageAdds a custom message to the graphics diagnostics HUD (Head-Up Display).
BeginCaptureBegins a capture interval that will end with EndCapture.
CaptureCurrentFrameCaptures the remainder of the current frame to the graphics log file.
Copy (Programmatic Capture)Copies the contents of the active graphics log (.vsglog) file into a new file.
EndCaptureEnds a capture interval that was started with BeginCapture.
InitPrepares the in-app component of graphics diagnostics to actively capture and record graphics information.
ToggleHUDToggles the graphics diagnostics HUD overlay on or off.
UnInitFinalizes the graphics log file, closes it, and frees resources that were used while the app was actively recording graphics information.

The VsgDbg class represents an interface that you can use to control graphics diagnostics features programmatically. You can use some features even when you're not actively capturing and recording graphics information; this includes the AddMessage member function and ToggleHUD member function. The other member functions either prepare the in-app component of graphics diagnostics to start or stop the active capture of graphics information, or must be called while the app is actively capturing and recording graphics information to a graphics log file.

Show: