IVMRMixerBitmap::SetAlphaBitmap method (strmif.h)

The SetAlphaBitmap method specifies a new bitmap image and the source location of the bitmap and how and where it should be rendered on the destination rectangle.

Syntax

HRESULT SetAlphaBitmap(
  const VMRALPHABITMAP *pBmpParms
);

Parameters

pBmpParms

A oointer to a VMRALPHABITMAP structure that contains information about the bitmap.

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 NULL.
E_INVALIDARG
Invalid argument. See Remarks.
E_OUTOFMEMORY
Could not create a destination DC or DIBSection for the bitmap.
E_FAIL
BitBlt to bitmap surface failed.

Remarks

To remove the bitmap, set the VMRALPHABITMAP structure and call SetAlphaBitmap again.

The method might return E_INVALIDARG for several reasons:

    [VMRALPHABITMAP](/windows/desktop/api/strmif/ns-strmif-vmralphabitmap) structure contains an invalid combination of flags. [VMRALPHABITMAP](/windows/desktop/api/strmif/ns-strmif-vmralphabitmap) structure does not specify a valid HDC or DirectDraw surface.
  • The value of fAlpha is invalid.

Requirements

   
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::GetAlphaBitmapParameters

Using the Video Mixing Renderer

Video Mixing Renderer Filter 7