IDCompositionVisualDebug::EnableHeatMap method (dcomp.h)

Article
02/22/2024

Enables a visual heatmap that represents overdraw regions.

Syntax

HRESULT EnableHeatMap(
  [in] const D2D1_COLOR_F & color
);

Parameters

[in] color

Return value

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

Heatmaps can be enabled by calling EnableHeatMap. The heatmaps are drawn on the source of the VisualDebug visual and child visuals. The heatmaps are represented in a specified color for all visual content. The heatmap color must have a transparency in order to see the overlaying overdraw regions. The colored surfaces are blended together to visually show all overdraw regions in a single view.

Requirements

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps only]
Minimum supported server	Windows Server 2012 R2 [desktop apps only]
Target Platform	Windows
Header	dcomp.h
Library	Dcomp.lib
DLL	Dcomp.dll

Share via