MFCopyImage

Copies an image or image plane from one buffer to another.

Syntax

HRESULT MFCopyImage(
         BYTE *pDest,
         LONG lDestStride,
         const BYTE *pSrc,
         LONG lSrcStride,
         DWORD dwWidthInBytes,
         DWORD dwLines
)  

Parameters

pDest
Type: BYTE *

[out] Pointer to the start of the first row of pixels in the destination buffer.

lDestStride
Type: LONG 

Stride of the destination buffer, in bytes.

pSrc
Type: BYTE *

[in] Pointer to the start of the first row of pixels in the source image.

lSrcStride
Type: LONG 

Stride of the source image, in bytes.

dwWidthInBytes
Type: DWORD 

Width of the image, in bytes.

dwLines
Type: DWORD 

Number of rows of pixels to copy.

Return value

Type: HRESULT 

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Refer to Media Foundation return codes.

Remarks

This function copies a single plane of the image. For planar YUV formats, you must call the function once for each plane. In this case, pDest and pSrc must point to the start of each plane.

This function is optimized if the MMX, SSE, or SSE2 instruction sets are available on the processor. The function performs a non-temporal store (the data is written to memory directly without polluting the cache).

Note

Prior to Windows 7, this function was exported from evr.dll. Starting in Windows 7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows 7.

Requirements

Header: Declared in mfapi.h.

Library: Use Evr.lib.