IBitmapData::GetSourceBitmapDescription method (xamlom.h)

Gets a BitmapDescription that describes the original format of the bitmap data stored in the IBitmapData.

Syntax

HRESULT GetSourceBitmapDescription(
  [out] BitmapDescription *pBitmapDescription
);

Parameters

[out] pBitmapDescription

Information about the original format of the bitmap stored in the IBitmapData.

Return value

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

Remarks

This will have the same value as the BitmapDescription returned by GetBitmapDescription unless the bitmap data was format converted or scaled. Format conversion and scaling will occur as necessary to meet the contract of the method that returned the IBitmapData.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1607 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header xamlom.h

See also

IBitmapData