IVPBaseConfig::GetOverlaySurface

This method determines whether the overlay mixer should use the driver's overlay surface and if so retrieves a pointer to the surface.

HRESULT GetOverlaySurface(
  LPDIRECTDRAWSURFACE* ppddOverlaySurface
);

Parameters

  • ppddOverlaySurface
    [out] Address of a pointer to the retrieved DirectDraw overlay surface object.

Return Values

Returns NOERROR if the overlay surface object was returned. (Default implementation sets the surface to NULL and returns NOERROR.)

Remarks

The Overlay Mixer uses this function to determine if the driver requires the Overlay Mixer to use its overlay surface and if so to get a pointer to it. If this function returns NULL, then the Overlay Mixer allocates its own surface.

Requirements

DirectShow applications and DirectShow filters have different include file and link library requirements. See Setting Up the Build Environment for more information.

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.

See Also

IVPBaseConfig Interface

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.