GetPhysicalMonitorsFromIDirect3DDevice9 function (physicalmonitorenumerationapi.h)

Article
02/22/2024

Retrieves the physical monitors associated with a Direct3D device.

Syntax

HRESULT GetPhysicalMonitorsFromIDirect3DDevice9(
  [in]  IDirect3DDevice9   *pDirect3DDevice9,
  [in]  DWORD              dwPhysicalMonitorArraySize,
  [out] LPPHYSICAL_MONITOR pPhysicalMonitorArray
);

Parameters

[in] pDirect3DDevice9

Pointer to the IDirect3DDevice9 interface of the Direct3D device.

[in] dwPhysicalMonitorArraySize

Number of elements in pPhysicalMonitorArray. To get the required size of the array, call GetNumberOfPhysicalMonitorsFromIDirect3DDevice9.

[out] pPhysicalMonitorArray

Pointer to an array of PHYSICAL_MONITOR structures. The caller must allocate the array.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

A single Direct3D device can be associated with more than one physical monitor. This function returns a handle and a text description for each physical monitor.

When you are done using the monitor handles, close them by passing the pPhysicalMonitorArray array to the DestroyPhysicalMonitors function.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	physicalmonitorenumerationapi.h
Library	Dxva2.lib
DLL	Dxva2.dll