DXGKDDI_MONITORDESCRIPTORSET_ACQUIRENEXTDESCRIPTORINFO callback function (d3dkmddi.h)

2024-02-22

The pfnAcquireNextDescriptorInfo function returns the next descriptor in a monitor descriptor set, given the current descriptor.

Syntax

DXGKDDI_MONITORDESCRIPTORSET_ACQUIRENEXTDESCRIPTORINFO DxgkddiMonitordescriptorsetAcquirenextdescriptorinfo;

NTSTATUS DxgkddiMonitordescriptorsetAcquirenextdescriptorinfo(
  [in]  IN_CONST_D3DKMDT_HMONITORDESCRIPTORSET hMonitorDescriptorSet,
  [in]  IN_CONST_PD3DKMDT_MONITOR_DESCRIPTOR_CONST pMonitorDescriptorInfo,
  [out] DEREF_OUT_CONST_PPD3DKMDT_MONITOR_DESCRIPTOR ppNextMonitorDescriptorInfo
)
{...}

Parameters

[in] hMonitorDescriptorSet

A handle to a monitor descriptor set object. The display miniport driver previously obtained this handle by calling the pfnGetMonitorDescriptorSet function of the Monitor interface.

[in] pMonitorDescriptorInfo

A pointer to a D3DKMDT_MONITOR_DESCRIPTOR structure that is the current descriptor. The display miniport driver previously obtained this pointer by calling pfnAcquireFirstDescriptorInfo or pfnAcquireNextDescriptorInfo.

[out] ppNextMonitorDescriptorInfo

A pointer to a variable that receives a pointer to a D3DKMDT_MONITOR_DESCRIPTOR structure. The structure is the next descriptor in the set.

Return value

The pfnAcquireNextDescriptorInfo function returns one of the following values.

Return code	Description
STATUS_SUCCESS	The function successfully returned the next descriptor in the set.
STATUS_GRAPHICS_NO_MORE_ELEMENTS_IN_DATASET	The function succeeded, but there were no more descriptors in the set.
STATUS_INVALID_PARAMETER	An invalid parameter was supplied.
STATUS_INVALID_MONITOR_DESCRIPTOR	The descriptor supplied in pMonitorDescriptorInfo was invalid.
STATUS_GRAPHICS_INVALID_MONITOR_DESCRIPTORSET	The handle supplied in hMonitorDescriptorSet was invalid.

Remarks

When you have finished using the D3DKMDT_MONITOR_DESCRIPTOR structure, you must release the structure by calling pfnReleaseDescriptorInfo.

You can obtain all the descriptors in a monitor descriptor set by calling pfnAcquireFirstDescriptorInfo and then making a sequence of calls to pfnAcquireNextDescriptorInfo.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Target Platform	Desktop
Header	d3dkmddi.h (include D3dkmddi.h)
IRQL	PASSIVE_LEVEL

Share via