PFND3DDDI_WAITFORSYNCHRONIZATIONOBJECT2CB callback function (d3dumddi.h)

Article
02/22/2024

Inserts a wait command for the specified synchronization objects in the specified context command stream. Used by Windows Display Driver Model (WDDM) 1.2 and later user-mode display drivers.

Syntax

PFND3DDDI_WAITFORSYNCHRONIZATIONOBJECT2CB Pfnd3dddiWaitforsynchronizationobject2cb;

HRESULT Pfnd3dddiWaitforsynchronizationobject2cb(
  HANDLE hDevice,
  const D3DDDICB_WAITFORSYNCHRONIZATIONOBJECT2 *unnamedParam2
)
{...}

Parameters

hDevice

A handle to a display device (that is, the graphics context).

unnamedParam2

pData [in]

A pointer to a D3DDDICB_WAITFORSYNCHRONIZATIONOBJECT2 structure that describes the synchronization objects and context DMA stream that are required to set up the wait.

Return value

Returns one of the following values:

Return code	Description
S_OK	The wait was successfully set up.
E_INVALIDARG	Parameters were validated and determined to be incorrect.

This function might also return other HRESULT values.

Remarks

The pfnCreateSynchronizationObject2Cb function returns a kernel-mode handle to the newly created synchronization object in the hSyncObject member of the D3DDDICB_CREATESYNCHRONIZATIONOBJECT2 structure that the pData parameter points to. The user-mode display driver passes this handle in calls to the following functions:

Do not call this function if the synchronization object is of type D3DDDI_CPU_NOTIFICATION—namely, the Type member of the D3DDDI_SYNCHRONIZATIONOBJECTINFO2 structure has a value of D3DDDI_CPU_NOTIFICATION.pfnDestroySynchronizationObjectCb

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)