IDirectDrawSurface7::UpdateOverlayZOrder method (ddraw.h)
Sets the z-order of an overlay.
Syntax
HRESULT UpdateOverlayZOrder(
[in] DWORD unnamedParam1,
[in] LPDIRECTDRAWSURFACE7 unnamedParam2
);
Parameters
[in] unnamedParam1
One of the following flags that determines the z-order of the overlay:
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.
[in] unnamedParam2
A pointer to the IDirectDrawSurface7 interface for the DirectDraw surface to be used as a relative position in the overlay chain. This parameter is needed only for the DDOVERZ_INSERTINBACKOF and DDOVERZ_INSERTINFRONTOF flags.
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
- DDERR_NOTAOVERLAYSURFACE
Requirements
Requirement | Value |
---|---|
Target Platform | Windows |
Header | ddraw.h |
Library | Ddraw.lib |
DLL | Ddraw.dll |