Platform SDK: DirectX

IDirectDrawSurface7::GetOverlayPosition

Given a visible, active overlay surface (DDSCAPS_OVERLAY flag set), the IDirectDrawSurface7::GetOverlayPosition method returns the display coordinates of the surface.

HRESULT GetOverlayPosition(
  LPLONG lplX, 
  LPLONG lplY  
);

Parameters

lplX and lplY
Addresses of the x- and y-display coordinates.

Return Values

If the method succeeds, the return value is DD_OK.

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

DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDPOSITION
DDERR_NOOVERLAYDEST
DDERR_NOTAOVERLAYSURFACE
DDERR_OVERLAYNOTVISIBLE
DDERR_SURFACELOST

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in ddraw.h.

See Also

IDirectDrawSurface7::SetOverlayPosition, IDirectDrawSurface7::UpdateOverlay