D3DDDICB_LOCK structure (d3dumddi.h)

The D3DDDICB_LOCK structure describes parameters for locking an allocation.

Syntax

typedef struct _D3DDDICB_LOCK {
  [in/out] D3DKMT_HANDLE          hAllocation;
  [in]     UINT                   PrivateDriverData;
  [in]     UINT                   NumPages;
  [in]     const UINT             *pPages;
  [out]    VOID                   *pData;
  [in]     D3DDDICB_LOCKFLAGS     Flags;
           D3DGPU_VIRTUAL_ADDRESS GpuVirtualAddress;
} D3DDDICB_LOCK;

Members

[in/out] hAllocation

A D3DKMT_HANDLE data type that represents a kernel-mode handle to the allocation. The Microsoft Direct3D runtime's pfnAllocateCb function returns this handle. Therefore, the user-mode display driver should use this handle to lock the allocation.

If the Discard bit-field flag is set in the Flags member, the video memory manager creates a new instance of the allocation and returns a new handle that represents the new instance.

[in] PrivateDriverData

Private data (for example, MIP level) that is sent from the user-mode display driver to the display miniport driver's DxgkDdiAcquireSwizzlingRange function.

[in] NumPages

The number of pages in the page list that is pointed to by pPages.

[in] pPages

An array of pages to lock. Each page in the array is described by an integer offset. Zero means the first page in the surface, one means the second, and so on.

[out] pData

A pointer to the memory that is returned from the display miniport driver and memory manager. When locking a memory page list, the pointer that is returned is a pointer to the first memory page.

[in] Flags

A D3DDDICB_LOCKFLAGS structure that identifies, in bit-field flags, how to lock the allocation.

Note that specifying some flags together is invalid and that some flags depend on other flags. For more information about specifying these flags, see the Remarks section of D3DDDICB_LOCKFLAGS.

GpuVirtualAddress

This member is reserved and should be set to zero.

This member is available beginning with Windows 7.

Requirements

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

See also

D3DDDICB_LOCKFLAGS

DxgkDdiAcquireSwizzlingRange

pfnLockCb