D3DDDIARG_LOCK structure (d3dumddi.h)

The D3DDDIARG_LOCK structure describes a resource or a surface within the resource to lock.

Syntax

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;

Members

[in] hResource

A handle to the resource to be locked.

[in] SubResourceIndex

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.

[in] Range

A D3DDDIRANGE structure that describes the subrange of the linear resource to lock.

[in] Area

A RECT structure that describes the subrectangle of the surface to lock.

[in] Box

A D3DDDIBOX structure that describes the subvolume of the volume to lock.

[out] pSurfData

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.

[out] Pitch

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.

[out] SlicePitch

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.

[in] Flags

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.

Remarks

The members of the structure that is specified by the Flags member must adhere to the following rules:

• The ReadOnly and WriteOnly bit-field flags must not be set simultaneously.
• The NoOverwrite bit-field flag must not be simultaneously set with the Discard bit-field flag.
• Only one of the RangeValid, AreaValid, and BoxValid bit-field flags must be set at any time.
• The ReadOnly bit-field flag must not be simultaneously set with the Discard bit-field flag.

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

D3DDDI_LOCKFLAGS

Lock