PFND3DDDI_CREATESYNCHRONIZATIONOBJECTCB callback function (d3dumddi.h)

Article
02/22/2024

The pfnCreateSynchronizationObjectCb function creates a synchronization object that a device context can signal and wait for.

Syntax

PFND3DDDI_CREATESYNCHRONIZATIONOBJECTCB Pfnd3dddiCreatesynchronizationobjectcb;

HRESULT Pfnd3dddiCreatesynchronizationobjectcb(
  HANDLE hDevice,
  D3DDDICB_CREATESYNCHRONIZATIONOBJECT *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (that is, the graphics context) that will own the synchronization object that pfnCreateSynchronizationObjectCb creates.

unnamedParam2

pData [in, out]

A pointer to a D3DDDICB_CREATESYNCHRONIZATIONOBJECT structure that describes the synchronization object to create.

Return value

pfnCreateSynchronizationObjectCb returns one of the following values:

Return code	Description
S_OK	The synchronization object was successfully created.
E_OUTOFMEMORY	pfnCreateSynchronizationObjectCb could not allocate memory that was required for it to complete.
E_INVALIDARG	Parameters were validated and determined to be incorrect.

This function might also return other HRESULT values.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)