ID3D12CommandList::BeginEventInt method

[This documentation is preliminary and is subject to change.]

Starts a user-defined event for a timing capture of command list activity.

Syntax

void BeginEventInt(
  [in]  LPCWSTR pLabel,
  [in]  INT Data
);

Parameters

  • pLabel [in]
    Type: LPCWSTR

    A string that labels the event.

  • Data [in]
    Type: INT

    An integer that holds data for the event.

Return value

This method does not return a value.

Remarks

Starts a CPU timing capture that must be ended with a call to ID3D12CommandList::EndEvent. Calls to BeginEventInt and EndEvent can be nested, but can't overlap, and there must be an exact match for each call.

Each call to BeginEventInt must have a matching call to EndEvent. There is a low overhead to using this function, so up to several hundred thousand calls to PIXBeginEvent can be made per second. BeginEventInt and EndEvent pairs can be nested to any depth.

Requirements

Header

D3D12.h

Library

D3D12.lib

DLL

D3D12.dll

See also

ID3D12CommandList