ID3D11ShaderTrace::GetReadRegister method (d3d11shadertracing.h)

Retrieves information about a register that was read by a step in the trace.

Syntax

HRESULT GetReadRegister(
  [in]  UINT                 stepIndex,
  [in]  UINT                 readRegisterIndex,
  [out] D3D11_TRACE_REGISTER *pRegister,
  [out] D3D11_TRACE_VALUE    *pValue
);

Parameters

[in] stepIndex

The index of the step within the trace. The range of the index is [0...NumTraceSteps-1], where NumTraceSteps is a member of the D3D11_TRACE_STATS structure. You can retrieve information in any step order.

[in] readRegisterIndex

The index of the register within the trace step. The range of the index is [0...NumRegistersRead-1], where NumRegistersRead is a member of the D3D11_TRACE_STEP structure.

[out] pRegister

A pointer to a D3D11_TRACE_REGISTER structure. GetReadRegister fills the members of this structure with information about the register that was read by the step in the trace.

[out] pValue

A pointer to a D3D11_TRACE_VALUE structure. GetReadRegister fills the members of this structure with information about the value that was read from the register.

Return value

GetReadRegister returns:

  • S_OK if the method retrieves the register information.
  • E_FAIL if a trace is not available or if the trace was not created with the D3D11_SHADER_TRACE_FLAG_RECORD_REGISTER_READS flag.
  • E_INVALIDARG if stepIndex or readRegisterIndex is out of range or if pRegister or pValue is NULL.
  • Possibly other error codes that are described in Direct3D 11 Return Codes.

Remarks

This API requires the Windows Software Development Kit (SDK) for Windows 8.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header d3d11shadertracing.h
DLL D3D11SDKLayers.dll; D3D11_1SDKLayers.dll; D3D11_2SDKLayers.dll

See also

ID3D11ShaderTrace