Silicon Software Logo

SisoDisplay.h File Reference

SisoDisplay.h File Reference

Header file for all display lib public functions. More...

Go to the source code of this file.

Functions

void CloseDisplay (int nId)
 Closes a display. More...
 
int CreateDisplay (const unsigned int nDepth, const unsigned int nWidth, const unsigned int nHeight)
 Create Display. More...
 
void DrawBuffer (int nId, const void *ulpBuf, const int nNr, const char *cpStr)
 Draw buffer. More...
 
void SetBufferWidth (int nId, const unsigned int nWidth, const unsigned int nHeight)
 Sets a buffer width. More...
 
int SetDisplayDepth (int nId, const unsigned int depth)
 Sets a display depth. More...
 

Detailed Description

Header file for all display lib public functions.

SisoDisplay.h

Copyright (c) 2021 Basler AG, All Rights Reserved.

Author
Basler AG

Function Documentation

◆ CloseDisplay()

void CloseDisplay ( int  nId)

Closes a display.

The function CloseDisplay() closes the window and releases the allocated resources.

Parameters
nIdID of the display.

◆ CreateDisplay()

int CreateDisplay ( const unsigned int  nDepth,
const unsigned int  nWidth,
const unsigned int  nHeight 
)

Create Display.

The function CreateDisplay() creates a display window. It can display gray and color images up to 2GB of size.

Parameters
nDepthColor depth b/w: 1bit gray: 8bit, 16bit color: 24bit, 48bit Use the value 565 for 16Bit RGB 565
nWidthWidth of window in pixels.
nHeightHeight of window in pixels.
Returns
Display ID on success, or negative value in case of an error.
Return values
0..ndisplay ID
FG_NOT_ENOUGH_MEMout of memory
FG_INVALID_PARAMETERinvalid depth
FG_INVALID_IMAGE_DIMENSIONSimage is larger than 2GB

◆ DrawBuffer()

void DrawBuffer ( int  nId,
const void *  ulpBuf,
const int  nNr,
const char *  cpStr 
)

Draw buffer.

The function DrawBuffer() displays an image. The current pointer of an image will be returned by the function Fg_getImagePtr().

Parameters
nIdID of the created window.
ulpBufPointer to the frame buffer, which is to be displayed.
nNrNumber of the image.
cpStrA string, which is displayed in the windows bar.

◆ SetBufferWidth()

void SetBufferWidth ( int  nId,
const unsigned int  nWidth,
const unsigned int  nHeight 
)

Sets a buffer width.

The function SetBufferWidth() configures the size of the frame buffer. Hereby a window can be displayed, which is smaller than the frame buffer.

Parameters
nIdID of the display.
nWidthWidth of the window in pixels.
nHeightHeight of the window in pixels.

◆ SetDisplayDepth()

int SetDisplayDepth ( int  nId,
const unsigned int  depth 
)

Sets a display depth.

SetDisplayDepth() has been added for Linux systems. It enables a user specific setting (at RGB 24bit to use 32bit).

Parameters
nIdID of the display.
depth32bit, if neccessary.
Return values
NotDocumented!!