ID3DUserDefinedAnnotation ::BeginEvent, méthode (d3d11_1.h)

Marque le début d’une section du code d’événement.

Syntaxe

INT BeginEvent(
  [in] LPCWSTR Name
);

Paramètres

[in] Name

Chaîne UNICODE terminée par NULL qui contient le nom de l’événement. Le nom n’est pas pertinent pour le système d’exploitation. Vous pouvez choisir un nom significatif lorsque l’application appelante s’exécute sous l’outil de profilage Direct3D. Un pointeur NULL produit des résultats non définis.

Valeur retournée

Retourne le nombre d’appels précédents à BeginEvent qui n’ont pas encore été finalisés par les appels à la méthode ID3DUserDefinedAnnotation ::EndEvent .

La valeur de retour est -1 si l’application appelante ne s’exécute pas sous un outil de profilage Direct3D.

Remarques

Vous appelez la méthode EndEvent pour marquer la fin de la section du code d’événement.

Un utilisateur peut visualiser l’événement lorsque l’application appelante s’exécute sous un outil de profilage Direct3D activé tel que Microsoft Visual Studio Ultimate 2012.

BeginEvent n’a aucun effet si l’application appelante ne s’exécute pas sous un outil de profilage Direct3D activé.

Exemples

Le code suivant montre comment utiliser une paire d’appels aux méthodes BeginEvent et EndEvent . Il utilise également le type de pointeur intelligent CComPtr .

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( );
          

Configuration requise

Voir aussi

ID3DUserDefinedAnnotation