IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
Syntax
INT is_SetDisplayMode (HIDS hCam, INT Mode)
Description
Using is_SetDisplayMode(), you can set the way in which images will be displayed on the screen.
For live videos including overlays, you can use the Direct3D or OpenGL mode. These modes are not supported by all graphics cards. The graphics card must have sufficient extended memory because the overlay mode requires additional memory up to the size needed for the current screen resolution.
For further information on the display modes of the uEye camera, see the How to proceed: Image display section.
|
The Direct3D display mode is not available on Linux operating systems. |
|
Thread safety We recommend that you call the following function exclusively from a single thread in order to avoid unpredictable behavior of the application. See also General: Thread programming. |
Input parameters
hCam |
Camera handle |
||||||||||||||||
Mode
|
|||||||||||||||||
|
The new Direct3D mode completely replaces the "BackBuffer" and "Overlay Surface" display modes from DirectDraw. It is advisable not to use these modes any longer (see also Obsolete functions). To activate the obsolete modes, do the following:
|
Return values
When used with |
Current setting |
IS_CANT_ADD_TO_SEQUENCE |
The image memory is already included in the sequence and cannot be added again. |
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CANT_OPEN_DEVICE |
An attempt to initialize or select the camera failed (no camera connected or initialization error). |
IS_CAPTURE_RUNNING |
A capturing operation is in progress and must be terminated first. |
IS_DR_CANNOT_CREATE_SURFACE |
The image surface or overlay surface could not be created. |
IS_DR_CANNOT_CREATE_TEXTURE |
The texture could not be created. |
IS_DR_CANNOT_CREATE_VERTEX_BUFFER |
The vertex buffer could not be created. |
IS_DR_DEVICE_OUT_OF_MEMORY |
Not enough graphics memory available. |
IS_DR_LIBRARY_NOT_FOUND |
The DirectRenderer library could not be found. |
IS_INVALID_CAMERA_TYPE |
The camera type defined in the .ini file does not match the current camera model. |
IS_INVALID_COLOR_FORMAT |
Invalid color format |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_MEMORY_POINTER |
Invalid pointer or invalid memory ID |
IS_INVALID_MODE |
Camera is in standby mode, function not allowed |
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_IR_FILTER |
No IR filter available |
IS_NO_SUCCESS |
General error message |
IS_NOT_CALIBRATED |
The camera does not contain any calibration data. |
IS_NOT_SUPPORTED |
The setting is not supported. |
IS_NULL_POINTER |
Invalid array |
IS_OUT_OF_MEMORY |
No memory could be allocated. |
IS_SEQUENCE_BUF_ALREADY_LOCKED |
The memory could not be locked. The pointer to the buffer is invalid. |
IS_SUCCESS |
Function executed successfully |
IS_TIMED_OUT |
A timeout occurred. An image capturing process could not be terminated within the allowable period. |
Related functions
Example
is_SetDisplayMode (hCam, Mode);
//Bitmap mode (images are digitized and stored in system memory):
Mode = IS_SET_DM_DIB
//Direct3D mode
Mode = IS_SET_DM_DIRECT3D
