GetADLXGPUFromAdlAdapterIndex

Gets the reference counted IADLXGPU interface corresponding to the GPU with the specified ADL adapter index.

Syntax

Copied!

ADLX_RESULT     GetADLXGPUFromAdlAdapterIndex (adlx_int adlAdapterIndex, IADLXGPU ** ppGPU)

Parameters

  1. [in] adlAdapterIndex adlx_int The ADL adapter index for the requested GPU.

  2. [out] ppGPU IADLXGPU ** The address of the pointer to the returned interface. If the GPU was not found, the method sets the dereferenced address *ppGPU to nullptr.

Return Value

If the IADLXGPU is successfully returned, ADLX_OK is returned.

If the IADLXGPU is not returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes

Remarks

GetADLXGPUFromAdlAdapterIndex is used when an ADLX method must be called for a GPU obtained from ADL for which an ADL adapter index is available.

The returned interface must be discarded with Release when it is no longer needed.

Additional Info

In C++ when using a smart pointer for the returned interface there is no need to call Release because the smart pointer calls it internally.

Requirements

Header

include “ADLXDefines.h”

Minimum version

1.0