IDirectDrawSurface3::UpdateOverlayZOrder
The IDirectDrawSurface3::UpdateOverlayZOrder method sets the z-order of an overlay.
HRESULT UpdateOverlayZOrder(
DWORD dwFlags,
LPDIRECTDRAWSURFACE3 lpDDSReference
);
Parameters
dwFlags
One of the following flags:
| DDOVERZ_INSERTINBACKOF | ||
| Inserts this overlay in the overlay chain behind the reference overlay. | ||
| DDOVERZ_INSERTINFRONTOF | ||
| Inserts this overlay in the overlay chain in front of the reference overlay. | ||
| DDOVERZ_MOVEBACKWARD | ||
| Moves this overlay one position backward in the overlay chain. | ||
| DDOVERZ_MOVEFORWARD | ||
| Moves this overlay one position forward in the overlay chain. | ||
| DDOVERZ_SENDTOBACK | ||
| Moves this overlay to the back of the overlay chain. | ||
| DDOVERZ_SENDTOFRONT | ||
| Moves this overlay to the front of the overlay chain. | ||
lpDDSReference
Address of the DirectDraw surface to be used as a relative position in the overlay chain. This parameter is needed only for DDOVERZ_INSERTINBACKOF and DDOVERZ_INSERTINFRONTOF.
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 |
| DDERR_NOTAOVERLAYSURFACE |
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in ddraw.h.
Import Library: Use ddraw.lib.
See Also