MFGetPlaneSize function (mfapi.h)

Article
07/27/2022

Retrieves the image size, in bytes, for an uncompressed video format.

Syntax

HRESULT MFGetPlaneSize(
  [in]  DWORD format,
  [in]  DWORD dwWidth,
  [in]  DWORD dwHeight,
  [out] DWORD *pdwPlaneSize
);

Parameters

[in] format

FOURCC code or D3DFORMAT value that specifies the video format.

[in] dwWidth

Width of the image, in pixels.

[in] dwHeight

Height of the image, in pixels.

[out] pdwPlaneSize

Receives the size of one frame, in bytes. If the format is compressed or is not recognized, this value is zero.

Return value

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The function succeeded.

Remarks

This function is equivalent to the MFCalculateImageSize function.

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	mfapi.h
Library	Evr.lib
DLL	Mfplat.dll