Share via

IDirectDrawSurface5::EnumOverlayZOrders

  • Article

This method enumerates the overlay surfaces on the specified destination. The overlays can be enumerated in front-to-back or back-to-front order.

HRESULT EnumOverlayZOrders(
  DWORD dwFlags, 
  LPVOID lpContext, 
  LPDDENUMSURFACESCALLBACK2 lpfnCallback
);

Parameters

  • dwFlags
    The following table shows the possible flags.
    Flag Description
    DDENUMOVERLAYZ_BACKTOFRONT Enumerates overlays back to front.
    DDENUMOVERLAYZ_FRONTTOBACK Enumerates overlays front to back.
  • lpContext
    Address of the user-defined context that will be passed to the callback function for each overlay surface.
  • lpfnCallback
    Address of the EnumSurfacesCallback2 callback function that will be called for each surface being overlaid on this surface.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

Remarks

This method differs from its counterparts in previous interface versions in that it accepts a pointer to an EnumSurfacesCallback2 function, rather than an EnumSurfacesCallback function.

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.