RequestBitmapData Class Reference

A class containing a reference to a bitmap created from a request. More...

Inheritance diagram for RequestBitmapData:

Public Member Functions
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Properties
System.Drawing.Bitmap	bitmap [get]
	A reference to the System.Drawing.Bitmap contained in this mv.impact.acquire.RequestBitmapData instance.

Detailed Description

A class containing a reference to a bitmap created from a request.

The main purpose of this class is to serve as a reference counted lock in order to allow an application to access and hold one or multiple references to the image memory. Calling mv.impact.acquire.Request.unlock will raise an InvalidOperationException as long as at least one instance of mv.impact.acquire.RequestBitmapData is active. Therefore, whenever a mv.impact.acquire.RequestBitmapData instance is no longer needed, mv.impact.acquire.RequestBitmapData.Dispose must be called. Encapsulating bitmap access scopes with a using statement is recommended (whenever possible):

using (RequestBitmapData data = pRequest.bitmapData)
{
  // Access the Bitmap here using 'data.bitmap'
}

Attention

The availability of this class and the property mv.impact.acquire.Request.bitmapData depends on the availability of the System.Drawing.Common package for your target environment. For .NET Standard or .NET Core you may need to manually install the System.Drawing.Common package. The support for System.Drawing.Bitmap is limited! Refer to Efficiently create System.Drawing.Bitmap instances for details!

Since

2.5.1

Examples

SingleCaptureStorage.cs.

Member Function Documentation

Dispose()

void Dispose ( )

inline

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

See the frameworks documentation about the System.IDisposable interface for more information.

Property Documentation

bitmap

System.Drawing.Bitmap bitmap

get

A reference to the System.Drawing.Bitmap contained in this mv.impact.acquire.RequestBitmapData instance.

The support for System.Drawing.Bitmap is limited! Refer to Efficiently create System.Drawing.Bitmap instances for details!

Examples

SingleCaptureStorage.cs, and SingleCaptureStorage.vb.