Edit

D3DKMTSharedPrimaryLockNotification function (d3dkmthk.h)

  • Article

The D3DKMTSharedPrimaryLockNotification function notifies the operating system about an upcoming lock to a shared primary surface.

Syntax

NTSTATUS D3DKMTSharedPrimaryLockNotification(
  [in] const D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION *unnamedParam1
);

Parameters

[in] unnamedParam1

A pointer to a D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION structure that describes the shared primary surface that an application will lock.

Return value

D3DKMTSharedPrimaryLockNotification returns one of the following values:

Return code Description
STATUS_SUCCESS Notification about an upcoming lock to a shared primary surface was successfully performed.
STATUS_NO_MEMORY D3DKMTSharedPrimaryLockNotification could not complete because of insufficient memory.
STATUS_INVALID_PARAMETER Parameters were validated and determined to be incorrect.

This function might also return other NTSTATUS values that are defined in Ntstatus.h.

Remarks

The OpenGL ICD calls the D3DKMTSharedPrimaryLockNotification function to inform the operating system that an application is about to lock the GDI shared primary surface that exists on the graphics adapter and video present source that the AdapterLuid and VidPnSourceId members of the D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION structure specify. The OpenGL ICD must call D3DKMTSharedPrimaryLockNotification before it calls the D3DKMTLock function for the GDI shared primary surface to ensure that the operating system disables all sprites that intersect with the lock region that the LockRect member of D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION specifies.

Requirements

Requirement Value
Minimum supported client Windows Vista
Target Platform Universal
Header d3dkmthk.h (include D3dkmthk.h)
Library Gdi32.lib
DLL Gdi32.dll

See also

D3DKMTLock

D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION