FrameExtensions.CreateBitmapWrap Method

Creates a System.Drawing.Bitmap object which internally points to the same memory as the IFrame.
Syntax:
[C#]
public static System.Drawing.Bitmap CreateBitmapWrap( this IFrame frm );
Parameter Description
frm

The IFrame to use for the Bitmap object.

Returns:

Either a pointer to a valid System.Drawing.Bitmap object or a nullptr if the IFrame parameter could not be converted to a Bitmap.

Remarks:

The Bitmap object created points to the same memory as the IFrame and so when you free the IFrame (or change its contents) this will effect the returned Bitmap by either changing the contents of Bitmap or leading to spurious crashes when unsing the Bitmap object.

The FrameType of the IFrame passed in must contain something that a Bitmap may handle. When FrameType.PixelFormat returns something undefined this method returns nullptr.

Note: FrameExtensions.CreateBitmapCopy copies the full image data, so it is slower then FrameExtensions.CreateBitmapWrap on the other hand, you cannot use a Bitmap created by FrameExtensions.CreateBitmapWrap without meticulous tracking its lifetime.

Information:

Introduced in version 3.5

See also: FrameExtensions, IFrame, IFrame.FrameType, FrameType.PixelFormat, FrameExtensions.CreateBitmapCopy

<< FrameExtensions