Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Imaging.CreateBitmapSourceFromHBitmap Method

.NET Framework 4

Returns a managed BitmapSource, based on the provided pointer to an unmanaged bitmap and palette information.

Namespace:  System.Windows.Interop
Assembly:  PresentationCore (in PresentationCore.dll)
C#
C++
F#
VB
Copy 
public static BitmapSource CreateBitmapSourceFromHBitmap(
	IntPtr bitmap,
	IntPtr palette,
	Int32Rect sourceRect,
	BitmapSizeOptions sizeOptions
)

Parameters

bitmap
Type: System.IntPtr
A pointer to the unmanaged bitmap.
palette
Type: System.IntPtr
A pointer to the bitmap's palette map.
sourceRect
Type: System.Windows.Int32Rect
The size of the source image.
sizeOptions
Type: System.Windows.Media.Imaging.BitmapSizeOptions
A value of the enumeration that specifies how to handle conversions.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
No, you don't have to figure out the bitmap size yourself.
The documentation is not too clear, but from experiment it looks like the 'sourceRect' designates the part of the HBITMAP to copy into a BitmapSource, and BitmapSizeOptions determines the size of the resulting bitmap (in WPF display pixels).

You can pass Int32Rect.Empty for 'sourceRect', and it will actually copy the entire source bitmap, not 0 pixels of it. I sure hope that is intentional, because it is crazy handy.

You can also pass BitmapSizeOptions.FromEmptyOptions as the 'sizeOptions'; this seems to make the result come out at the same size as 'sourceRect'.
History