Microsoft DirectX 8.1 (C++)

IDDrawExclModeVideo::GetDDrawSurface

The GetDDrawSurface method retrieves the DirectDraw surface being used by the Overlay Mixer.

Syntax

HRESULT GetDDrawSurface(
  LPDIRECTDRAWSURFACE *pDDrawSurface,
  BOOL *pdUsingExternal
);

Parameters

pDDrawSurface

[out] Address of a pointer to the IDirectDrawSurface interface that is being used by the Overlay Mixer.

pdUsingExternal

[out] Pointer to a variable that receives a Boolean value. It receives the value TRUE if the Overlay Mixer is using a DirectDraw surface specified by IDDrawExclModeVideo::SetDDrawSurface, or FALSE otherwise.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK Success.
E_INVALIDARG Argument is invalid.
A DirectDraw error code A DirectDraw error is encountered when trying to set the specified surface on the Overlay Mixer.

Remarks

If the filter graph has not set a DirectDraw surface and the Overlay Mixer has not yet allocated one, then pDDrawSurface will be set to NULL and pdUsingExternal will be set to FALSE.

See Also