GetADLXDisplayFromADLIds

Gets the reference counted IADLXDisplay interface corresponding to the display with the specified ADL adapter index, display index, PCI bus number, device number, and function number.

Syntax

Copied!

ADLX_RESULT     GetADLXDisplayFromADLIds (adlx_int adapterIndex, adlx_int displayIndex, adlx_int bus, adlx_int device, adlx_int function, IADLXDisplay ** ppDisplay)

Parameters

  1. [in] adapterIndex adlx_int The ADL adapter index of the GPU where the requested display is connected.

  2. [in] displayIndex adlx_int The ADL logical display index of the requested display.

  3. [in] bus adlx_int The unique PCIE bus number of the GPU where the requested display is connected.

  4. [in] device adlx_int The device number of the GPU where the requested display is connected.

  5. [in] function adlx_int The device number of the GPU where the requested display is connected.

  6. [out] ppDisplay IADLXDisplay ** The address of the pointer to the returned interface. If the display was not found, the method sets the dereferenced address *ppDisplay to nullptr.

Return Value

If the IADLXDisplay interface is successfully returned, ADLX_OK is returned.

If the IADLXDisplay interface is not returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Remarks

GetADLXDisplayFromADLIds is used when an ADLX method must be called for a display obtained from ADL. The ADL adapter index corresponds to the GPU to which the display is connected.

The display index corresponds to the ADLDisplayID.iDisplayLogicalIndex field for the display.

The PCI bus number, device number, and function number parameters correspond to ADL AdapterInfo.iBusNumber, AdapterInfo.iDeviceNumber, and AdapterInfo.iFunctionNumber for the GPU where that display is connected.

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

Related pages

  • Visit the Adlx product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNA™ 2 GPUs, AMD Ryzen™ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!