LPDDHALSURFCB_LOCK (Compact 2013)

  • Article

3/26/2014

This callback function locks a specified area of surface memory.

Syntax

DWORD (* LPDDHALSURFCB_LOCK)(
  LPDDHAL_LOCKDATA lpld
);

Parameters

  • lpld
    [in, out] Pointer to a DDHAL_LOCKDATA structure that the driver uses to lock the specified area.

Return Value

Returns one of the following values:

  • DDHAL_DRIVER_HANDLED
    The request was handled although a specific action may not have been taken.
  • DDHAL_DRIVER_NOTHANDLED
    The request was not handled or processed in any way.

Note

For a complete list of the DDHAL callback return values, see DDHAL Callback Return Values.

Remarks

An emulated blit is a blit performed by the DirectDraw hardware emulation layer (HEL), not the hardware abstraction layer (HAL). During the setup for an emulated blit, the HAL's Lock function is called to obtain a pointer to any display memory surfaces involved in the blit. For such blits, drivers may pass DDLOCK_READONLY or DDLOCK_WRITEONLY to the Lock function. These flags indicate that the host processor only reads from or writes to the surface for the duration of this Lock operation. If neither flag is specified, then the driver should assume that read/write access is required.

Requirements

Header

ddrawi.h

Library

Developer Implemented

See Also

Reference

DirectDrawSurface Callback Functions
DDHAL_LOCKDATA
DDHAL Callback Return Values