A class that can be used for displaying images within existing windows or GUI elements that can provide a window handle. More...

Inheritance diagram for ImageDisplay:

[legend]

Public Member Functions
void	Clear ()
	Clears the display.

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

	ImageDisplay (IntPtr hwnd)
	Create a new object that can be used for displaying images.

void	RemoveImage ()
	Removes the current image from the display.

void	SetBitmapRectangle (int left, int top, int width, int height)
	Sets the position and dimension of bitmap data region.

void	SetDisplayRectangle (int left, int top, int width, int height)
	Defines the rectangle used for drawing within the window associated with the display structure.

void	SetImage (IntPtr pData, int width, int height, int bipp, int pitch)
	Sets the next image to display.

unsafe void	SetImage (IntPtr[] ppData, TFormatFlags format, int width, int height, int bipp, int pitch)
	Sets the next image to display.

void	Update ()
	Immediately redraws the current image.

Properties
int	appliedShift `[get]`
	Contains the current shift value that has been applied to the last image that has been displayed.

TDisplayMode	displayMode `[get, set]`
	Gets/Sets the current display mode.

TInterpolationMode	interpolationMode `[get, set]`
	Gets/Sets the current interpolation mode that will be used for scaling if display window rectangle is different to input image rectangle.

TImageDisplayError	lastError `[get]`
	Returns the last error and clears it.

int	shift `[get, set]`
	Gets/Sets the shift value that shall be subtracted from the shift value needed to display the 8 msb of a pixel.

IntPtr	windowHandle `[get, set]`
	Get/Set the current window handle associated with the display object.

Detailed Description

A class that can be used for displaying images within existing windows or GUI elements that can provide a window handle.

This group contains classes and functions that can be used to display images. Instances of this class can be associated with an existing window object of which the window handle is known and can be passed to the constructor of this class.

The full client area of a window will be consumed by a display object. Where the actual image shall be display relative to the upper left corner of the windows client area can be defined by calling mv.impact.acquire.display.ImageDisplay.SetDisplayRectangle(). This function will also limit the area where image data will be displayed.

If the actual image size differs from the area defined by mv.impact.acquire.display.ImageDisplay.SetDisplayRectangle(), it depends on the display mode if the complete image is scaled, cropped of just drawn in the top left corner of the display rectangle. The display mode can be modified by calling mv.impact.acquire.display.ImageDisplay.displayMode.

In addition to that only a part of the actual image can be selected for drawing by the function mv.impact.acquire.display.ImageDisplay.SetBitmapRectangle(). For this region the same scaling and cropping regions will be applied then.

See also: mv.impact.acquire.display.ImageDisplay.SetDisplayRectangle(),
mv.impact.acquire.display.ImageDisplay.SetBitmapRectangle(),
mv.impact.acquire.display.ImageDisplay.displayMode

Examples: ContinuousCaptureAllDevices.cs.

Constructor & Destructor Documentation

◆ ImageDisplay()

ImageDisplay ( IntPtr hwnd )

inline

Create a new object that can be used for displaying images.

Parameters

[in] hwnd A handle to the window which should be used for the displaying.

Member Function Documentation

◆ Clear()

void Clear ( )

inline

Clears the display.

Either the windows default background will be displayed afterwards or if a background brush has been defined the background brush will be used to fill the complete client area.

◆ Dispose()

void Dispose ( )

inline

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

◆ RemoveImage()

void RemoveImage ( )

inline

Removes the current image from the display.

This function will remove the current image attached to the display from the display again. This is mainly meant to be able to free the memory associated with the image buffer without the risk that a later call to an update function or a repaint message would cause another redraw of then freed memory. As only one buffer can be attached to a display at any given time calling mvIMPACT::acquire::display::ImageDisplay::SetImage will effectively remove the previous image as well so this function usually is only needed when ending e.g. a live display.

Examples: ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, GenICamCommonSettingsUsage.cs, and GenICamInterfaceLayout.cs.

◆ SetBitmapRectangle()

void SetBitmapRectangle	(	int	left,
		int	top,
		int	width,
		int	height )

inline

Sets the position and dimension of bitmap data region.

This defines the area relative within the area consumed by the window associated with the window handle that is bound to this display. See mv.impact.acquire.display.ImageDisplay for a detailed description on how to define the different rectangles and areas for drawing.

See also: mv.impact.acquire.display.ImageDisplay
mv.impact.acquire.display.ImageDisplay.SetDisplayRectangle()

Parameters

[in]	left	The left offset of the rectangle.
[in]	top	The top offset of the rectangle.
[in]	width	The width of the bitmap rectangle.
[in]	height	The height of the rectangle.

◆ SetDisplayRectangle()

void SetDisplayRectangle	(	int	left,
		int	top,
		int	width,
		int	height )

inline

Defines the rectangle used for drawing within the window associated with the display structure.

This function can be used to define a rectangle within the defined window Only this then will be used for drawing. This window can be smaller than the image defined by mv.impact.acquire.display.ImageDisplay.SetImage(). Then just a part of the image will be displayed when in mv.impact.acquire.display.TDisplayMode.DM_Fastest or the whole image will be scaled down to fit into the rectangle when in mv.impact.acquire.display.TDisplayMode.DM_Default mode.

When the the display rectangle is larger than the image the image will be placed in the lower left corner of the display rectangle (either scaled or unscaled). See ImageDisplay for a detailed description on how to define the different rectangles and areas for drawing.

See also: mv.impact.acquire.display.ImageDisplay,
mv.impact.acquire.display.ImageDisplay.SetBitmapRectangle

Parameters

[in]	left	The left offset within the window.
[in]	top	The top offset within the window.
[in]	width	The width of the rectangle to use for drawing.
[in]	height	The height of the rectangle to use for drawing.

◆ SetImage() [1/2]

void SetImage	(	IntPtr	pData,
		int	width,
		int	height,
		int	bipp,
		int	pitch )

inline

Sets the next image to display.

This function can deal with RGB888x packed images, 8 bit grey-scale images and 16 bit Packed RGB images. For other formats overloaded versions of this function must be used.

Parameters

[in]	pData	A pointer to the address of the pixel data.
[in]	width	The width of the image.
[in]	height	The height of the image.
[in]	bipp	The number of bits per pixel.
[in]	pitch	The pitch in bytes of one line of pixel data (bytes per pixel * width in pixel per line).

Examples: ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

◆ SetImage() [2/2]

unsafe void SetImage	(	IntPtr[]	ppData,
		TFormatFlags	format,
		int	width,
		int	height,
		int	bipp,
		int	pitch )

inline

Sets the next image to display.

Parameters

[in]	ppData	An array of pointers that point to the actual image data For planar RGB images e.g. this can be 3 pointers each pointing to one color plane.
[in]	format	The pixel format as defined by mv.impact.acquire.display.TFormatFlags.
[in]	width	The width of the image.
[in]	height	The height of the image.
[in]	bipp	The number of bits per pixel.
[in]	pitch	The pitch in bytes of one line of pixel data (bytes per pixel * width in pixel per line).

◆ Update()

void Update ( )

inline

Immediately redraws the current image.

Examples: ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

Property Documentation

◆ appliedShift

int appliedShift

get

Contains the current shift value that has been applied to the last image that has been displayed.

This function returns the shift value that has been applied to the last image that has been displayed. See mv.impact.acquire.display.ImageDisplay.shift for a detailed explanation about the display behaviour when applying custom shift values.

See also: mv.impact.acquire.display.ImageDisplay.shift

Since: 2.4.0

Returns: The current shift value that has been applied to the last image that has been displayed.

◆ displayMode

TDisplayMode displayMode

getset

Gets/Sets the current display mode.

Valid display modes are defined by mv.impact.acquire.display.TDisplayMode.

◆ interpolationMode

TInterpolationMode interpolationMode

getset

Gets/Sets the current interpolation mode that will be used for scaling if display window rectangle is different to input image rectangle.

Valid interpolation modes are defined by mv.impact.acquire.display.TInterpolationMode.

◆ lastError

TImageDisplayError lastError

get

Returns the last error and clears it.

If an error has occurred it will not be overwritten by subsequent errors till the error is queried and cleared. After calling this function a second call would return mv.impact.acquire.display.TImageDisplayError.IDE_NoError until another error occurs.

Returns: The last error

◆ shift

int shift

getset

Gets/Sets the shift value that shall be subtracted from the shift value needed to display the 8 msb of a pixel.

This property will allow to select which 8 bits out of a multi-byte pixel format shall be displayed the next time mv.impact.acquire.display.ImageDisplay.Update is called. When the shift value is 0 the 8 msb of each pixel will be displayed so e.g. for a 12 bit format bits 11 to 4 will be displayed by default.

Consider the typical layout of 12 mono pixel data in memory:

So with an application defined shift value of 0 (the default), the display module will shift each 2 byte pixel by 4 positions to the right. This will remove the 4 lsb from the data. Afterwards the now empty upper byte of each pixel is removed from the data resulting in the following memory layout which is then displayed on the canvas:

Now sometimes it is required to display other bits from the image e.g. for analysis purposes. As most operating systems only support to display 8 bits per color component this requires to select a different range of pixels to be sent to the canvas. This can be done by calling this function and passing a custom shift value to it. The custom shift value will be subtracted from the value that would be needed to display the 8 msb for a given format.

So to display the 8 lsb for a 12 bit mono format, shift must be set to 4. This then results in the display module to use a actual shift value of 4(required to display the 8 msb) - 4 (defined by calling this function) = 0. Then removing the upper byte from each pixel results in only the 8 lsb of each pixel being displayed.

When e.g. setting shift to 3 for a 12 bit mono for would result in bits 8 - 1 to be displayed:

The shift value that has actually been applied the last time an image has been displayed (thus '1' when taking the example in the image above (4(required) - 3(defined))) can be queried by reading the property mv.impact.acquire.display.ImageDisplay.appliedShift.

Note: During the conversion from a multi-byte to a single byte format the pixel data will be clipped to 255 if a pixel value is larger than what can be stored in a single byte after the shift operation. Furthermore It is NOT possible to shift pixel data in such a way that less than 8 bits contain valid data, thus e.g. a shift value of 2 applied to 8 bit mono data will be ignored.

See also: mv.impact.acquire.display.ImageDisplay.appliedShift

Since: 2.4.0

Returns: The current shift value.

◆ windowHandle

IntPtr windowHandle

getset

Get/Set the current window handle associated with the display object.

Returns: The current window handle associated with the display object.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ImageDisplay()

Member Function Documentation

◆ Clear()

◆ Dispose()

◆ RemoveImage()

◆ SetBitmapRectangle()

◆ SetDisplayRectangle()

◆ SetImage() [1/2]

◆ SetImage() [2/2]

◆ Update()

Property Documentation

◆ appliedShift

◆ displayMode

◆ interpolationMode

◆ lastError

◆ shift

◆ windowHandle