VsgDbg Class

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

class VsgDbg;

Members

The VsgDbg class supports the following members.

Public Constructors

Name	Description
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

Name	Description
AddMessage	Adds a custom message to the graphics diagnostics HUD (Head-Up Display).
BeginCapture	Begins a capture interval that will end with EndCapture.
CaptureCurrentFrame	Captures 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.
EndCapture	Ends a capture interval that was started with BeginCapture.
Init	Prepares the in-app component of graphics diagnostics to actively capture and record graphics information.
ToggleHUD	Toggles the graphics diagnostics HUD overlay on or off.
UnInit	Finalizes the graphics log file, closes it, and frees resources that were used while the app was actively recording graphics information.

Remarks

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.