ID3D11DeviceContext2::IsAnnotationEnabled method (d3d11_2.h)

Allows apps to determine when either a capture or profiling request is enabled.

Syntax

BOOL IsAnnotationEnabled();

Return value

Returns TRUE if capture or profiling is enabled and FALSE otherwise.

Remarks

Returns TRUE if the capture tool is present and capturing or the app is being profiled such that SetMarkerInt or BeginEventInt will be logged to ETW. Otherwise, it returns FALSE. Apps can use this to turn off self-throttling mechanisms in order to accurately capture what is currently being seen as app output. Apps can also avoid generating event markers and the associated overhead it may entail when there is no benefit to do so.

If apps detect that capture is being performed, they can prevent the Direct3D debugging tools, such as Microsoft Visual Studio 2013, from capturing them. The purpose of the D3D11_CREATE_DEVICE_PREVENT_ALTERING_LAYER_SETTINGS_FROM_REGISTRY flag prior to Windows 8.1 was to allow the Direct3D runtime to prevent debugging tools from capturing apps.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d3d11_2.h

See also

ID3D11DeviceContext2