Microsoft DirectX 8.1 (C++)

IDDrawExclModeVideo::GetDDrawObject

The GetDDrawObject method retrieves the DirectDraw object being used by the Overlay Mixer filter.

Syntax

HRESULT GetDDrawObject(
  LPDIRECTDRAW *pDDrawObject,
  BOOL *pbUsingExternal
);

Parameters

pDDrawObject

[out] Address of a pointer to the IDirectDraw interface that the Overlay Mixer is using.

pbUsingExternal

[out] Pointer to a variable that receives a Boolean value. It receives the value TRUE if the Overlay Mixer is using a DirectDraw object specified by IDDrawExclModeVideo::SetDDrawObject, 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 object and the Overlay Mixer has not yet allocated one, then pDDrawObject will be set to NULL and pbUsingExternal will be set to FALSE.

See Also