BFModule.Display.clsDispSurf

class BFModule.Display.clsDispSurf

Bases: pybind11_object

A Windows Form GUI widget used to display bitmap images.

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: BFModule.Display.clsDispSurf) -> None

2. __init__(self: BFModule.Display.clsDispSurf, xsize: int, ysize: int, pixDepthDisp: int, pixDepthImage: int) -> None

   param int xsize:

   Width of the display surface

   param int ysize:

   Height of the display surface

   param int pixDepthDisp:

   Pixel depth of the display surface

   param int pixDepthImage:

   Pixel depth of the image

Methods

Close(self)	Close the display surface.
Open(self)	Open a display surface.
__init__(*args, **kwargs)	Overloaded function.
getBitmap(self)	Gets a pointer to the memory buffer of the bitmap behind a display surface.
isOpen(self)	Check if the display is open.
updateDisplay(self, pyBuff, index, options)	Update the display surface.

Close(self: BFModule.Display.clsDispSurf) → None

Close the display surface.

Raises:

RuntimeError – Error closing the display surface.

Open(self: BFModule.Display.clsDispSurf) → None

Open a display surface. :raises RuntimeError: Error opening display surface.

getBitmap(self: BFModule.Display.clsDispSurf) → None

Gets a pointer to the memory buffer of the bitmap behind a display surface.

Raises:

RuntimeError – Cannot get the bitmap, or display surface handle is invalid.

isOpen(self: BFModule.Display.clsDispSurf) → int

Check if the display is open.

Return type:

bool

Retruns:

True if display is open, False otherwise.

updateDisplay(self: BFModule.Display.clsDispSurf, pyBuff: BFModule.BufferAcquisition.pyBufferArray, index: int, options: DispOptions) → None

Update the display surface. Copies the data from the image buffers to the display surfaces.

Parameters:

• pyBuff (PyBufferArray) – The buffer array.

• index (int) – Buffer number to display

• options (DispOptions) – Options for formatting the image data.

Return type:

void

Raises:

RuntimeError – Error updating display surface.