IVMRMixerBitmap::GetAlphaBitmapParameters method (strmif.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetAlphaBitmapParameters method retrieves a copy of the current image and related blending parameters.

Syntax

HRESULT GetAlphaBitmapParameters(
  [out] PVMRALPHABITMAP pBmpParms
);

Parameters

[out] pBmpParms

A pointer to a VMRALPHABITMAP structure that receives the bitmap, information about the blending values, and the location to blend it.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Return code	Description
E_POINTER	pBmpParms is invalid.
VFW_E_WRONG_STATE	The mixer has not been loaded.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib

See also

Error and Success Codes

IVMRMixerBitmap Interface

IVMRMixerBitmap::SetAlphaBitmap

Using the Video Mixing Renderer

Video Mixing Renderer Filter 7