IDirectDrawSurface7::EnumOverlayZOrders method (ddraw.h)

Enumerates the overlay surfaces on the specified destination. You can enumerate the overlays in front-to-back or back-to-front order.

Syntax

HRESULT EnumOverlayZOrders(
  [in] DWORD                     unnamedParam1,
  [in] LPVOID                    unnamedParam2,
  [in] LPDDENUMSURFACESCALLBACK7 unnamedParam3
);

Parameters

[in] unnamedParam1

A value that can be set to one of the following flags:

DDENUMOVERLAYZ_BACKTOFRONT

Enumerates overlays back to front.

DDENUMOVERLAYZ_FRONTTOBACK

Enumerates overlays front to back.

[in] unnamedParam2

Address of the user-defined structure to be passed to the callback function for each overlay surface.

[in] unnamedParam3

Address of the EnumSurfacesCallback7 callback function to be called for each surface to be overlaid on this surface.

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return one of the following error values:

• DDERR_INVALIDOBJECT
• DDERR_INVALIDPARAMS

Remarks

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

Requirements

See also

IDirectDrawSurface7