ID3D11UserDefinedAnnotationX::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 ID3D11UserDefinedAnnotationX interface. For example, the ID3D11UserDefinedAnnotationX::BeginEvent and ID3D11UserDefinedAnnotationX::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.

Library: Use d3d11_x.lib.

See also

Reference

ID3D11UserDefinedAnnotationX

ID3DUserDefinedAnnotation

ID3D11UserDefinedAnnotationX Interface

ID3D11UserDefinedAnnotationX Members