ID3DUserDefinedAnnotation::GetStatus Method

Determines whether the calling application is running under a Microsoft Direct3D profiling tool.

Syntax

public:
BOOL GetStatus()  

Return value

Type: BOOL 

The return value is nonzero if the calling application is running under a Microsoft Direct3D profiling tool, and zero otherwise.

Remarks

You can call GetStatus to determine whether your application is running under a Microsoft Direct3D profiling tool before you make further calls to other methods of the ID3DUserDefinedAnnotation interface. For example, the ID3DUserDefinedAnnotation::BeginEvent and ID3DUserDefinedAnnotation::EndEvent methods have no effect if the calling application is not running under an enabled Microsoft Direct3D profiling tool. Therefore, you do not need to call these methods unless your application is running under a Microsoft Direct3D profiling tool.

Requirements

Header: Declared in d3d11_x.h (d3d11_1.h on other Windows platforms).

Library: Use d3d11_x.lib (d3d11.lib on other Windows platforms).

See also

ID3DUserDefinedAnnotation Members

ID3DUserDefinedAnnotation

ID3D11UserDefinedAnnotationX