ID3DUserDefinedAnnotation::GetStatus method

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

Syntax


BOOL GetStatus();

Parameters

This method has no parameters.

Return value

The return value is nonzero if the calling application is running under a Direct3D profiling tool such as Visual Studio Ultimate 2012, and zero otherwise.

Remarks

You can call GetStatus to determine whether your application is running under a 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 Direct3D profiling tool. Therefore, you do not need to call these methods unless your application is running under a Direct3D profiling tool.

Examples

The following code shows how to use GetStatus.



#ifdef DEVELOPMENT_BUILD
    if ( pPerf->GetStatus() )
        m_MakeD3DAnnotationCalls = true;
#endif

…

   if ( m_ MakeD3DAnnotationCalls )
        pPerf->BeginEvent(L“Drawing Ocean”);
   MyDrawOceanRoutine();

          

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

D3D11_1.h

Library

D3D11.lib

See also

ID3DUserDefinedAnnotation

 

 

Community Additions

ADD
Show:
© 2014 Microsoft