ID3DUserDefinedAnnotation::BeginEvent method (d3d11_1.h)

Marks the beginning of a section of event code.

Syntax

INT BeginEvent(
  [in] LPCWSTR Name
);

Parameters

[in] Name

A NULL-terminated UNICODE string that contains the name of the event. The name is not relevant to the operating system. You can choose a name that is meaningful when the calling application is running under the Direct3D profiling tool. A NULL pointer produces undefined results.

Return value

Returns the number of previous calls to BeginEvent that have not yet been finalized by calls to the ID3DUserDefinedAnnotation::EndEvent method.

The return value is –1 if the calling application is not running under a Direct3D profiling tool.

Remarks

You call the EndEvent method to mark the end of the section of event code.

A user can visualize the event when the calling application is running under an enabled Direct3D profiling tool such as Microsoft Visual Studio Ultimate 2012.

BeginEvent has no effect if the calling application is not running under an enabled Direct3D profiling tool.

Examples

The following code shows how to use a pair of calls to the BeginEvent and EndEvent methods. It also uses the CComPtr smart pointer type.

CComPtr< ID3D11DeviceContext > pContext;

HRESULT hrCreateDevice = (*pfnD3D11CreateDevice)( 
        0,
        D3D_DRIVER_TYPE_NULL,
        0,
        0,
        NULL,
        0,
        D3D11_SDK_VERSION,
        NULL,
        0,
        & pContext );
VERIFY_SUCCEEDED(hrCreateDevice);
CComPtr<ID3DUserDefinedAnnotation> pPerf;
HRESULT hr = pContext->QueryInterface( __uuidof(pPerf), reinterpret_cast<void**>(&pPerf) );
if ( FAILED( hr ) ) 
    return;
pPerf->BeginEvent( L”Now entering ocean rendering code” );
MyDrawOceanRoutine( );
pPerf->EndEvent( );
          

Requirements

See also

ID3DUserDefinedAnnotation