D3DDDIARG_LOCK - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// d3dumddi.h
typedef struct _D3DDDIARG_LOCK {
[in] HANDLE hResource;
[in] UINT SubResourceIndex;
union {
[in] D3DDDIRANGE Range;
[in] RECT Area;
[in] D3DDDIBOX Box;
};
[out] VOID *pSurfData;
[out] UINT Pitch;
[out] UINT SlicePitch;
[in] D3DDDI_LOCKFLAGS Flags;
} D3DDDIARG_LOCK;
View the official Windows Driver Kit DDI referenceNo description available.
The D3DDDIARG_LOCK structure describes a resource or a surface within the resource to lock.
hResource [in]A handle to the resource to be locked.
SubResourceIndex [in]The zero-based index into the resource, which is specified by the handle that is specified by hResource. This index indicates the subresource or surface to be locked.
Range [in]A D3DDDIRANGE structure that describes the subrange of the linear resource to lock.
Area [in]A RECT structure that describes the subrectangle of the surface to lock.
Box [in]A D3DDDIBOX structure that describes the subvolume of the volume to lock.
pSurfData [out]A pointer to the memory region for the resource that was locked. The user-mode display driver's Lock function returns this pointer to the Microsoft Direct3D runtime.
Pitch [out]The pitch, in bytes, of the surface that was locked. The user-mode display driver's Lock function returns this pitch value to the Direct3D runtime.
SlicePitch [out]The slice pitch, in bytes, of the surface that was locked. The user-mode display driver's Lock function returns this slice pitch value to the Direct3D runtime.
Flags [in]A D3DDDI_LOCKFLAGS structure that indicates, in bit-field flags, how to lock the resource. Note that some flags are mutually exclusive with other flags. For more information, see the following Remarks section.
The members of the structure that is specified by the Flags member must adhere to the following rules: