Microsoft DirectX 9.0

IDirectDrawSurface::UpdateOverlayDisplay

The UpdateOverlayDisplay method repaints the rectangles in the dirty rectangle lists of all active overlays. The dirty rectangle list is cleared. This function is for software emulation only; it does nothing if the hardware supports overlays.

Syntax

HRESULT UpdateOverlayDisplay(
  DWORD dwFlags
  );

Parameters

dwFlags

Specify type of update to perform.

Value Description
DDOVER_REFRESHDIRTYRECTS Update the overlay display using the list of dirty rectangles previously constructed for this destination. The dirty rectangle list is cleared after this.
DDOVER_REFRESHALL Ignore the dirty rectangle list and update the overlay display completely. The dirty rectangle list is cleared after this.

Return Values

Value Description
DD_OK The method succeeded.
DDERR_INVALIDPARAMS One or more of the input parameters is invalid.
DDERR_INVALIDOBJECT DirectDraw received a pointer that was an invalid DirectDraw object.
DDERR_UNSUPPORTED Action not supported.

See Also