AddMessage

  • Article

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

Adds a custom message to the graphics diagnostics HUD (Head-Up Display).

Syntax

void AddMessage(
  wchar_t const * szMessage
);

Parameters

szMessage The message to be added to the HUD.

Remarks

The graphics diagnostics HUD is displayed in the upper-left corner of the app that's running under graphics diagnostics. It displays run-time information about the app and about graphics information capture, and messages that are added by calling this function.

To add a message to the HUD, you don't have to be actively capturing graphics information—that is, a message can be added through an instance of the VsgDbg class, but the Init member function does not to be called first. Messages are only displayed in the HUD, they are not recorded in the graphics log file.