Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_ScenePreset

uEye Camera Manual Version 3.80

is_ScenePreset

Windows_Logo

Linux_Logo

USB uEye XS

USB uEye XS

Syntax

INT is_ScenePreset (HIDS hCam, UINT nCommand,
void *pParam,
UINT nSizeOfParam)

Description

is_ScenePreset() adjusts a number of camera parameters – e.g. color and exposure settings – to suit specific image capture situations (for a list of supported modes, see SCENE_MODE). Depending on the selected mode, the feature changes the settings for several of the following parameters:

Exposure time
Gain
Sharpness
Color temperature
Fields of view for measuring auto focus and exposure time

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam receives a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam input parameter.

Hinweis

This function is currently only supported by the USB uEye XS camera model.

Hinweis

Additional functions that have an influence on the above parameters should be called after is_ScenePreset(). Otherwise some of these settings might be overwritten by calling is_ScenePreset().

Input Parameters

hCam

Camera handle

nCommand

 

SCENE_CMD_GET_SUPPORTED_PRESETS

Returns the scene modes supported by the camera.

More details

pParam: Pointer to bit mask of type UINT
In the bit mask, the status flags from SCENE_MODE are returned.

nSizeOfParam: 4

SCENE_CMD_SET_PRESET

Enables a scene mode.

More details

pParam: Pointer to variable of type UINT with

the SCENE_MODE to be set.

nSizeOfParam: 0

SCENE_CMD_GET_PRESET

Returns the set scene mode.

More details

pParam: Pointer to variable of type UINT
The bit mask returns the SCENE_MODE.

nSizeOfParam: 4

SCENE_CMD_GET_DEFAULT_PRESET

Returns the default setting for the scene mode.

More details

pParam: Pointer to variable of type UINT
The bit mask returns the SCENE_MODE.

nSizeOfParam: 4

pParam

Pointer to a function parameter; which function parameter is referred to here depends on nCommand.

nSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Status Flags from SCENE_MODE

SCENE_INVALID

The camera does not support scene modes

SCENE_SENSOR_AUTOMATIC

Mode for automatic adjustment

SCENE_SENSOR_PORTRAIT

Mode for capturing portraits

SCENE_SENSOR_SUNNY

Mode for image capture in direct sunlight

SCENE_SENSOR_ENTERTAINMENT

Mode for image capture in artificial light environments

SCENE_SENSOR_NIGHT

Mode for image capture with little light

SCENE_SENSOR_SPORTS

Mode for capturing fast moving objects

SCENE_SENSOR_LANDSCAPE

Mode for capturing landscapes

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

Related Functions

is_SetAutoParameter()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com