DDHAL_LOCKDATA (Compact 2013)

3/26/2014

This structure contains information necessary to do a Lock operation as defined by DirectDraw's parameter structures. This structure passes the information to the DirectDraw hardware abstraction layer (DDHAL) Lock callback function.

Syntax

typedef struct _DDHAL_LOCKDATA {
  LPDDRAWI_DIRECTDRAW_GBL lpDD;
  LPDDRAWI_DDRAWSURFACE_LCL lpDDSurface;
  BOOL bHasRect;
  RECT rArea;
  LPVOID lpSurfData;
  HRESULT ddRVal;
  DWORD dwFlags;
} DDHAL_LOCKDATA;

Members

• lpDD
  Pointer to the DDRAWI_DIRECTDRAW_GBL structure that represents the DirectDraw object.

• lpDDSurface
  Pointer to the DDRAWI_DDRAWSURFACE_LCL structure that represents the DirectDrawSurface object.

• bHasRect
  Specifies whether the area (rArea) is valid or not.

• rArea
  Specifies the area being locked.

• lpSurfData
  Pointer to a surface memory.

• ddRVal
  Passes the DirectDraw return values.

• dwFlags
  DDLOCK flags.

  The following table shows the possible flags.

  Flag	Description
  DDLOCK_DISCARD	Indicates that every location within a locked surface will be overwritten (with a write-only operation).
  DDLOCK_READONLY	Specifies the surface being locked will only be read.
  DDLOCK_WAITNOTBUSY	Waits for a previously initiated drawing operation to complete instead of returning immediately with the DDERR_WASSTILLDRAWING return value. If a previous drawing operation is in progress at the time of the call, this flag defers returning from the call until the surface is locked or an error occurs.
  DDLOCK_WRITEONLY	Indicates that the surface being locked will be write-enabled.

Requirements

See Also

Reference

DirectDrawSurface Structures
LPDDHALSURFCB_LOCK
DDRAWI_DIRECTDRAW_GBL
DDRAWI_DDRAWSURFACE_LCL