CBaseControlVideo::CopyImage

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Creates a memory copy of an image.

Syntax

HRESULT CopyImage(
  IMediaSample* pMediaSample,
  VIDEOINFOHEADER* pVideoInfo,
  LONG* pBufferSize,
  BYTE* pVideoImage,
  RECT* pSourceRect
);

Parameters

• pMediaSample
  Sample containing the video image.

• pVideoInfo
  Format representing the video image.

• pBufferSize
  Size of the output buffer.

• pVideoImage
  Pointer to the output buffer.

• pSourceRect
  Source video rectangle.

Return Value

If the pVideoImage parameter is NULL, the pBufferSize parameter is filled in with the number of bytes the output buffer requires to store the image.

If the buffer passed in is too small or the member function fails to allocate sufficient memory, the member function returns E_OUTOFMEMORY.

Remarks

The member function retrieves the image from the sample and copies it into the output buffer.

The section of video copied into the output buffer reflects the source rectangle that is set through the IBasicVideo interface (although it does not reflect the destination rectangle).

Requirements