DXGKDDI_GETNODEMETADATA callback function (d3dkmddi.h)
From a provided adapter handle, returns the engine type and friendly name of an engine on a specified GPU node. Must be implemented by Windows Display Driver Model (WDDM) 1.3 and later display miniport drivers.
Syntax
DXGKDDI_GETNODEMETADATA DxgkddiGetnodemetadata;
NTSTATUS DxgkddiGetnodemetadata(
IN_CONST_HANDLE hAdapter,
UINT NodeOrdinalAndAdapterIndex,
OUT_PDXGKARG_GETNODEMETADATA pGetNodeMetadata
)
{...}
Parameters
hAdapter
[in] A handle that identifies a display adapter. The DirectX graphics kernel subsystem previously provided this handle to the display miniport driver in the DxgkInterface parameter of the DxgkDdiStartDevice function.
NodeOrdinalAndAdapterIndex
An index of a node for which engine information will be obtained. This node is within the physical adapter defined by the hAdapter parameter.
pGetNodeMetadata
A pointer to a DXGKARG_GETNODEMETADATA structure that contains the engine type and friendly name of the engine specified by the NodeOrdinal parameter.
Note that the DXGKARG_GETNODEMETADATA structure is declared as a DXGK_NODEMETADATA structure.
Return value
Returns one of the following values:
Return code | Description |
---|---|
STATUS_SUCCESS | DxgkDdiGetNodeMetadata successfully retrieved the engine information. |
STATUS_INVALID_PARAMETER | The caller-provided hAdapter or pGetNodeMetadata parameters are invalid, or the caller-provided value of NodeOrdinal is greater than or equal to the number of nodes on the adapter. |
If the hAdapter and pGetNodeMetadata parameters are valid, and NodeOrdinal has a value in the range of 0 to (number of nodes - 1), all calls to this function must be successful.
Remarks
For more information on how to implement this function, see Enumerating GPU engine capabilities.
Requirements
Minimum supported client | Windows 8.1 |
Minimum supported server | Windows Server 2012 R2 |
Target Platform | Desktop |
Header | d3dkmddi.h (include D3dkmddi.h) |
IRQL | PASSIVE_LEVEL |