IVPBaseConfig::GetOverlaySurface

  • Article
 
Microsoft DirectShow 9.0

IVPBaseConfig::GetOverlaySurface

The GetOverlaySurface method queries whether the caller should use the driver's overlay surface. If so, the method returns a pointer to the surface.

Syntax

  HRESULT GetOverlaySurface(
  LPDIRECTDRAWSURFACE *ppddOverlaySurface
);

Parameters

ppddOverlaySurface

[out] Address of a pointer to the IDirectDrawSurface interface. If the caller should use the driver's overlay surface, it sets this variable equal to the IDirectDrawSurface interface for the overlay surface.

Return Values

Returns S_OK if the overlay surface object was returned.

Remarks

The Overlay Mixer uses this function to determine if the driver requires the Overlay Mixer to use the driver's overlay surface. If this function returns NULL, then the Overlay Mixer allocates its own surface.

Requirements

Header: Include Dvp.h, Vptype.h, Vpconfig.h.

Library: None.

See Also