Additional methods to extend the functionality of the mv.impact.acquire.TImageBufferPixelFormat enumeration. More...

Static Public Member Functions
static TImageDestinationPixelFormat	asImageDestinationPixelFormat (this TImageBufferPixelFormat imageBufferPixelFormat)
	Converts a mv.impact.acquire.TImageBufferPixelFormat to a mv.impact.acquire.TImageDestinationPixelFormat value.
static System.Drawing.Imaging.PixelFormat	asSystemDrawingImagingPixelFormat (this TImageBufferPixelFormat imageBufferPixelFormat)
	Converts a mv.impact.acquire.TImageBufferPixelFormat to a System.Drawing.Imaging.PixelFormat value.

Detailed Description

Additional methods to extend the functionality of the mv.impact.acquire.TImageBufferPixelFormat enumeration.

Member Function Documentation

◆ asImageDestinationPixelFormat()

TImageDestinationPixelFormat asImageDestinationPixelFormat ( this TImageBufferPixelFormat imageBufferPixelFormat )

inlinestatic

Converts a mv.impact.acquire.TImageBufferPixelFormat to a mv.impact.acquire.TImageDestinationPixelFormat value.

Returns: The converted mv.impact.acquire.TImageDestinationPixelFormat value

Parameters

[in] imageBufferPixelFormat The mv.impact.acquire.TImageBufferPixelFormat to convert

◆ asSystemDrawingImagingPixelFormat()

System.Drawing.Imaging.PixelFormat asSystemDrawingImagingPixelFormat ( this TImageBufferPixelFormat imageBufferPixelFormat )

inlinestatic

Converts a mv.impact.acquire.TImageBufferPixelFormat to a System.Drawing.Imaging.PixelFormat value.

This extension function will allow mv.impact.acquire.TImageBufferPixelFormat values to be converted into the corresponding System.Drawing.Imaging.PixelFormat values that can e.g. be used to create instances of System.Drawing.Bitmap if the target platform supports this. See Efficiently create System.Drawing.Bitmap instances as well.

Attention: The outcome of this function mainly depends on the capabilities of your target environment. E.g. for .NET Standard without an installed System.Drawing.Common library as well as for some pixel formats when running with Mono, this function will throw a System.ArgumentException.; When working with System.Drawing.Imaging.PixelFormat.Format8bppIndexed a custom palette needs to be defined when working with grey-scale images.

Valid values for mv.impact.acquire.TImageBufferPixelFormat that can be converted into a into System.Drawing.Imaging.PixelFormat types and their corresponding values are:

mv.impact.acquire.TImageBufferPixelFormat.ibpfMono8 (becomes System.Drawing.Imaging.PixelFormat.Format8bppIndexed)(Requires a grey-scale palette to be associated with the bitmap when the image shall be displayed as typically coming from a device)
mv.impact.acquire.TImageBufferPixelFormat.ibpfRGBx888Packed (becomes System.Drawing.Imaging.PixelFormat.Format32bppRgb)
mv.impact.acquire.TImageBufferPixelFormat.ibpfMono16 (becomes System.Drawing.Imaging.PixelFormat.Format16bppGrayScale) (
Note
This format is NOT supported when running with Mono)
mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB888Packed (becomes System.Drawing.Imaging.PixelFormat.Format24bppRgb)
mv.impact.acquire.TImageBufferPixelFormat.ibpfRGB161616Packed (becomes System.Drawing.Imaging.PixelFormat.Format48bppRgb) (
Note
This format is NOT supported when running with Mono)

This function is also used internally when an application reads the property mv.impact.acquire.Request.bitmapData.

Since
2.5.1

Returns
The converted System.Drawing.Imaging.PixelFormat value