Basler Logo

Basler Frame Grabber SDK: 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.
int CreateDisplay (int nDepth, const unsigned int nWidth, const unsigned int nHeight)
 Create Display.
void DrawBuffer (int nId, const void *ulpBuf, const int nNr, const char *cpStr)
 Draw buffer.
void SetBufferWidth (int nId, const unsigned int nWidth, const unsigned int nHeight)
 Sets a buffer width.
int SetDisplayDepth (int nId, const unsigned int depth)
 Sets a display depth.

Detailed Description

Header file for all display lib public functions.

SisoDisplay.h

Copyright (c) 2002-2014 Basler AG, All Rights Reserved.

Author:
Basler AG

Function Documentation

void CloseDisplay ( int  nId  ) 

Closes a display.

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

Parameters:
nId ID of the display.
int CreateDisplay ( int  nDepth,
const unsigned int  nWidth,
const unsigned int  nHeight 
)

Create Display.

The function CreateDisplay() creates a display window. I can display gray and color images.

Parameters:
nDepth Color depth b/w: 1bit gray: 8bit, 16bit color: 24bit, 48bit Use the value 565 for 16Bit RGB 565
nWidth Width of window in pixels.
nHeight Height of window in pixels.
Returns:
Display ID.
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:
nId ID of the created window.
ulpBuf Pointer to the frame buffer, which is to be displayed.
nNr Number of the image.
cpStr A string, which is displayed in the windows bar.
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:
nId ID of the display.
nWidth Width of the window in pixels.
nHeight Height of the window in pixels.
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:
nId ID of the display.
depth 32bit, if neccessary.
Return values:
Not Documented!!