Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
rs_option.h
Go to the documentation of this file.
1 /* License: Apache 2.0. See LICENSE file in root directory.
2 Copyright(c) 2017 Intel Corporation. All Rights Reserved. */
3 
10 #ifndef LIBREALSENSE_RS2_OPTION_H
11 #define LIBREALSENSE_RS2_OPTION_H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #include "rs_types.h"
18 
22  typedef enum rs2_option
23  {
101 
102  // This function is being deprecated. For existing options it will return option name, but for future API additions the user should call rs2_get_option_name instead.
103  const char* rs2_option_to_string(rs2_option option);
104 
107  {
122 
125  {
136 
139  {
149 
151  typedef enum rs2_sensor_mode
152  {
159 
161  typedef enum rs2_ambient_light
162  {
167 
169  typedef enum rs2_cah_trigger
170  {
177 
185  int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
186 
194  float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
195 
203  void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
204 
211 
218 
226  const char* rs2_get_option_name(const rs2_options* options, rs2_option option, rs2_error** error);
227 
234 
240 
248  int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
249 
260  void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
261 
269  const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
270 
279  const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
280 
281 #ifdef __cplusplus
282 }
283 #endif
284 #endif
RS2_OPTION_AMBIENT_LIGHT
@ RS2_OPTION_AMBIENT_LIGHT
Definition: rs_option.h:93
RS2_OPTION_STREAM_FORMAT_FILTER
@ RS2_OPTION_STREAM_FORMAT_FILTER
Definition: rs_option.h:68
RS2_OPTION_CONFIDENCE_THRESHOLD
@ RS2_OPTION_CONFIDENCE_THRESHOLD
Definition: rs_option.h:41
RS2_AMBIENT_LIGHT_NO_AMBIENT
@ RS2_AMBIENT_LIGHT_NO_AMBIENT
Definition: rs_option.h:163
RS2_OPTION_MA_TEMPERATURE
@ RS2_OPTION_MA_TEMPERATURE
Definition: rs_option.h:75
RS2_OPTION_ACCURACY
@ RS2_OPTION_ACCURACY
Definition: rs_option.h:38
RS2_OPTION_ENABLE_AUTO_EXPOSURE
@ RS2_OPTION_ENABLE_AUTO_EXPOSURE
Definition: rs_option.h:34
RS2_OPTION_CONTRAST
@ RS2_OPTION_CONTRAST
Definition: rs_option.h:26
RS2_OPTION_SENSOR_MODE
@ RS2_OPTION_SENSOR_MODE
Definition: rs_option.h:94
RS2_RS400_VISUAL_PRESET_CUSTOM
@ RS2_RS400_VISUAL_PRESET_CUSTOM
Definition: rs_option.h:126
RS2_OPTION_NOISE_FILTERING
@ RS2_OPTION_NOISE_FILTERING
Definition: rs_option.h:91
RS2_OPTION_APD_TEMPERATURE
@ RS2_OPTION_APD_TEMPERATURE
Definition: rs_option.h:78
RS2_RS400_VISUAL_PRESET_HIGH_DENSITY
@ RS2_RS400_VISUAL_PRESET_HIGH_DENSITY
Definition: rs_option.h:130
RS2_OPTION_TOTAL_FRAME_DROPS
@ RS2_OPTION_TOTAL_FRAME_DROPS
Definition: rs_option.h:44
RS2_OPTION_BACKLIGHT_COMPENSATION
@ RS2_OPTION_BACKLIGHT_COMPENSATION
Definition: rs_option.h:24
RS2_OPTION_GLOBAL_TIME_ENABLED
@ RS2_OPTION_GLOBAL_TIME_ENABLED
Definition: rs_option.h:77
RS2_OPTION_TEXTURE_SOURCE
@ RS2_OPTION_TEXTURE_SOURCE
Definition: rs_option.h:59
RS2_OPTION_INTER_CAM_SYNC_MODE
@ RS2_OPTION_INTER_CAM_SYNC_MODE
Definition: rs_option.h:66
rs2_option_to_string
const char * rs2_option_to_string(rs2_option option)
rs2_sr300_visual_preset
rs2_sr300_visual_preset
For SR300 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:107
RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING
@ RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING
Definition: rs_option.h:112
RS2_OPTION_ZERO_ORDER_ENABLED
@ RS2_OPTION_ZERO_ORDER_ENABLED
Definition: rs_option.h:85
rs2_get_option_value_description
const char * rs2_get_option_value_description(const rs2_options *options, rs2_option option, float value, rs2_error **error)
RS2_SR300_VISUAL_PRESET_DEFAULT
@ RS2_SR300_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:116
rs2_sensor_mode
rs2_sensor_mode
For setting the camera_mode option.
Definition: rs_option.h:152
RS2_OPTION_WHITE_BALANCE
@ RS2_OPTION_WHITE_BALANCE
Definition: rs_option.h:33
RS2_L500_VISUAL_PRESET_CUSTOM
@ RS2_L500_VISUAL_PRESET_CUSTOM
Definition: rs_option.h:140
RS2_OPTION_FILTER_SMOOTH_DELTA
@ RS2_OPTION_FILTER_SMOOTH_DELTA
Definition: rs_option.h:62
RS2_L500_VISUAL_PRESET_DEFAULT
@ RS2_L500_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:141
RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS
@ RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS
Definition: rs_option.h:113
RS2_SR300_VISUAL_PRESET_SHORT_RANGE
@ RS2_SR300_VISUAL_PRESET_SHORT_RANGE
Definition: rs_option.h:108
rs2_cah_trigger_to_string
const char * rs2_cah_trigger_to_string(rs2_cah_trigger preset)
RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN
@ RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN
Definition: rs_option.h:132
RS2_SR300_VISUAL_PRESET_MID_RANGE
@ RS2_SR300_VISUAL_PRESET_MID_RANGE
Definition: rs_option.h:117
RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY
@ RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY
Definition: rs_option.h:131
RS2_OPTION_ENABLE_MAPPING
@ RS2_OPTION_ENABLE_MAPPING
Definition: rs_option.h:79
rs2_sr300_visual_preset_to_string
const char * rs2_sr300_visual_preset_to_string(rs2_sr300_visual_preset preset)
RS2_L500_VISUAL_PRESET_COUNT
@ RS2_L500_VISUAL_PRESET_COUNT
Definition: rs_option.h:146
RS2_OPTION_ENABLE_POSE_JUMPING
@ RS2_OPTION_ENABLE_POSE_JUMPING
Definition: rs_option.h:81
rs2_set_option
void rs2_set_option(const rs2_options *options, rs2_option option, float value, rs2_error **error)
RS2_OPTION_AUTO_EXPOSURE_MODE
@ RS2_OPTION_AUTO_EXPOSURE_MODE
Definition: rs_option.h:45
RS2_OPTION_FREEFALL_DETECTION_ENABLED
@ RS2_OPTION_FREEFALL_DETECTION_ENABLED
Definition: rs_option.h:87
rs2_rs400_visual_preset_to_string
const char * rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset)
RS2_OPTION_GAIN
@ RS2_OPTION_GAIN
Definition: rs_option.h:28
rs2_get_option_name
const char * rs2_get_option_name(const rs2_options *options, rs2_option option, rs2_error **error)
RS2_RS400_VISUAL_PRESET_HAND
@ RS2_RS400_VISUAL_PRESET_HAND
Definition: rs_option.h:128
RS2_SR300_VISUAL_PRESET_FACE_LOGIN
@ RS2_SR300_VISUAL_PRESET_FACE_LOGIN
Definition: rs_option.h:114
rs2_l500_visual_preset
rs2_l500_visual_preset
For L500 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:139
RS2_SENSOR_MODE_VGA
@ RS2_SENSOR_MODE_VGA
Definition: rs_option.h:153
RS2_OPTION_FRAMES_QUEUE_SIZE
@ RS2_OPTION_FRAMES_QUEUE_SIZE
Definition: rs_option.h:43
RS2_OPTION_ENABLE_MAP_PRESERVATION
@ RS2_OPTION_ENABLE_MAP_PRESERVATION
Definition: rs_option.h:86
RS2_CAH_TRIGGER_MANUAL
@ RS2_CAH_TRIGGER_MANUAL
Definition: rs_option.h:171
rs2_sensor_mode_to_string
const char * rs2_sensor_mode_to_string(rs2_sensor_mode preset)
RS2_RS400_VISUAL_PRESET_COUNT
@ RS2_RS400_VISUAL_PRESET_COUNT
Definition: rs_option.h:133
RS2_OPTION_THERMAL_COMPENSATION
@ RS2_OPTION_THERMAL_COMPENSATION
Definition: rs_option.h:96
rs_types.h
Exposes RealSense structs.
RS2_OPTION_LED_POWER
@ RS2_OPTION_LED_POWER
Definition: rs_option.h:84
RS2_OPTION_HARDWARE_PRESET
@ RS2_OPTION_HARDWARE_PRESET
Definition: rs_option.h:76
rs2_supports_option
int rs2_supports_option(const rs2_options *options, rs2_option option, rs2_error **error)
rs2_l500_visual_preset_to_string
const char * rs2_l500_visual_preset_to_string(rs2_l500_visual_preset preset)
RS2_OPTION_OUTPUT_TRIGGER_ENABLED
@ RS2_OPTION_OUTPUT_TRIGGER_ENABLED
Definition: rs_option.h:50
RS2_OPTION_STEREO_BASELINE
@ RS2_OPTION_STEREO_BASELINE
Definition: rs_option.h:64
RS2_OPTION_ENABLE_RELOCALIZATION
@ RS2_OPTION_ENABLE_RELOCALIZATION
Definition: rs_option.h:80
rs2_options
struct rs2_options rs2_options
Definition: rs_types.h:272
RS2_OPTION_HUE
@ RS2_OPTION_HUE
Definition: rs_option.h:30
RS2_OPTION_DEPTH_OFFSET
@ RS2_OPTION_DEPTH_OFFSET
Definition: rs_option.h:83
RS2_CAH_TRIGGER_NOW
@ RS2_CAH_TRIGGER_NOW
Definition: rs_option.h:172
RS2_OPTION_SATURATION
@ RS2_OPTION_SATURATION
Definition: rs_option.h:31
RS2_OPTION_DEPTH_UNITS
@ RS2_OPTION_DEPTH_UNITS
Definition: rs_option.h:52
RS2_OPTION_ASIC_TEMPERATURE
@ RS2_OPTION_ASIC_TEMPERATURE
Definition: rs_option.h:47
RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION
@ RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION
Definition: rs_option.h:110
rs2_get_options_list
rs2_options_list * rs2_get_options_list(const rs2_options *options, rs2_error **error)
RS2_OPTION_AVALANCHE_PHOTO_DIODE
@ RS2_OPTION_AVALANCHE_PHOTO_DIODE
Definition: rs_option.h:88
RS2_SR300_VISUAL_PRESET_IR_ONLY
@ RS2_SR300_VISUAL_PRESET_IR_ONLY
Definition: rs_option.h:118
rs2_get_option_range
void rs2_get_option_range(const rs2_options *sensor, rs2_option option, float *min, float *max, float *step, float *def, rs2_error **error)
rs2_option
rs2_option
Defines general configuration controls. These can generally be mapped to camera UVC controls,...
Definition: rs_option.h:23
RS2_OPTION_FILTER_MAGNITUDE
@ RS2_OPTION_FILTER_MAGNITUDE
Definition: rs_option.h:60
rs2_get_options_list_size
int rs2_get_options_list_size(const rs2_options_list *options, rs2_error **error)
RS2_L500_VISUAL_PRESET_SHORT_RANGE
@ RS2_L500_VISUAL_PRESET_SHORT_RANGE
Definition: rs_option.h:145
RS2_OPTION_MAX_DISTANCE
@ RS2_OPTION_MAX_DISTANCE
Definition: rs_option.h:58
RS2_OPTION_ZERO_ORDER_POINT_X
@ RS2_OPTION_ZERO_ORDER_POINT_X
Definition: rs_option.h:71
RS2_CAH_TRIGGER_AUTO
@ RS2_CAH_TRIGGER_AUTO
Definition: rs_option.h:173
RS2_OPTION_EXPOSURE
@ RS2_OPTION_EXPOSURE
Definition: rs_option.h:27
RS2_OPTION_RESET_CAMERA_ACCURACY_HEALTH
@ RS2_OPTION_RESET_CAMERA_ACCURACY_HEALTH
Definition: rs_option.h:98
RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION
@ RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION
Definition: rs_option.h:111
RS2_CAH_TRIGGER_COUNT
@ RS2_CAH_TRIGGER_COUNT
Definition: rs_option.h:174
RS2_OPTION_FILTER_SMOOTH_ALPHA
@ RS2_OPTION_FILTER_SMOOTH_ALPHA
Definition: rs_option.h:61
RS2_SENSOR_MODE_QVGA
@ RS2_SENSOR_MODE_QVGA
Definition: rs_option.h:155
RS2_OPTION_LASER_POWER
@ RS2_OPTION_LASER_POWER
Definition: rs_option.h:37
RS2_OPTION_EMITTER_ALWAYS_ON
@ RS2_OPTION_EMITTER_ALWAYS_ON
Definition: rs_option.h:95
RS2_OPTION_POWER_LINE_FREQUENCY
@ RS2_OPTION_POWER_LINE_FREQUENCY
Definition: rs_option.h:46
RS2_OPTION_GAMMA
@ RS2_OPTION_GAMMA
Definition: rs_option.h:29
RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED
@ RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED
Definition: rs_option.h:56
RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP
@ RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP
Definition: rs_option.h:65
RS2_SR300_VISUAL_PRESET_COUNT
@ RS2_SR300_VISUAL_PRESET_COUNT
Definition: rs_option.h:119
RS2_OPTION_STREAM_FILTER
@ RS2_OPTION_STREAM_FILTER
Definition: rs_option.h:67
RS2_OPTION_BRIGHTNESS
@ RS2_OPTION_BRIGHTNESS
Definition: rs_option.h:25
RS2_OPTION_ERROR_POLLING_ENABLED
@ RS2_OPTION_ERROR_POLLING_ENABLED
Definition: rs_option.h:48
RS2_RS400_VISUAL_PRESET_DEFAULT
@ RS2_RS400_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:127
rs2_rs400_visual_preset
rs2_rs400_visual_preset
For RS400 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:125
RS2_OPTION_ZERO_ORDER_POINT_Y
@ RS2_OPTION_ZERO_ORDER_POINT_Y
Definition: rs_option.h:72
RS2_OPTION_VISUAL_PRESET
@ RS2_OPTION_VISUAL_PRESET
Definition: rs_option.h:36
rs2_delete_options_list
void rs2_delete_options_list(rs2_options_list *list)
rs2_ambient_light
rs2_ambient_light
ambient light for RS2_OPTION_AMBIENT_LIGHT option.
Definition: rs_option.h:162
RS2_OPTION_EMITTER_ENABLED
@ RS2_OPTION_EMITTER_ENABLED
Definition: rs_option.h:42
RS2_OPTION_AUTO_EXPOSURE_PRIORITY
@ RS2_OPTION_AUTO_EXPOSURE_PRIORITY
Definition: rs_option.h:54
rs2_cah_trigger
rs2_cah_trigger
values for RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH option.
Definition: rs_option.h:170
RS2_SENSOR_MODE_COUNT
@ RS2_SENSOR_MODE_COUNT
Definition: rs_option.h:156
RS2_OPTION_COUNT
@ RS2_OPTION_COUNT
Definition: rs_option.h:99
RS2_OPTION_SHARPNESS
@ RS2_OPTION_SHARPNESS
Definition: rs_option.h:32
RS2_SR300_VISUAL_PRESET_LONG_RANGE
@ RS2_SR300_VISUAL_PRESET_LONG_RANGE
Definition: rs_option.h:109
RS2_OPTION_FILTER_OPTION
@ RS2_OPTION_FILTER_OPTION
Definition: rs_option.h:40
RS2_OPTION_MC_TEMPERATURE
@ RS2_OPTION_MC_TEMPERATURE
Definition: rs_option.h:74
RS2_OPTION_POST_PROCESSING_SHARPENING
@ RS2_OPTION_POST_PROCESSING_SHARPENING
Definition: rs_option.h:89
RS2_OPTION_INVALIDATION_BYPASS
@ RS2_OPTION_INVALIDATION_BYPASS
Definition: rs_option.h:92
RS2_OPTION_EMITTER_ON_OFF
@ RS2_OPTION_EMITTER_ON_OFF
Definition: rs_option.h:70
rs2_get_option_description
const char * rs2_get_option_description(const rs2_options *options, rs2_option option, rs2_error **error)
RS2_OPTION_MIN_DISTANCE
@ RS2_OPTION_MIN_DISTANCE
Definition: rs_option.h:57
RS2_L500_VISUAL_PRESET_NO_AMBIENT
@ RS2_L500_VISUAL_PRESET_NO_AMBIENT
Definition: rs_option.h:142
RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH
@ RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH
Definition: rs_option.h:97
RS2_OPTION_HOLES_FILL
@ RS2_OPTION_HOLES_FILL
Definition: rs_option.h:63
rs2_is_option_read_only
int rs2_is_option_read_only(const rs2_options *options, rs2_option option, rs2_error **error)
RS2_SR300_VISUAL_PRESET_GR_CURSOR
@ RS2_SR300_VISUAL_PRESET_GR_CURSOR
Definition: rs_option.h:115
RS2_OPTION_STREAM_INDEX_FILTER
@ RS2_OPTION_STREAM_INDEX_FILTER
Definition: rs_option.h:69
rs2_ambient_light_to_string
const char * rs2_ambient_light_to_string(rs2_ambient_light preset)
RS2_L500_VISUAL_PRESET_LOW_AMBIENT
@ RS2_L500_VISUAL_PRESET_LOW_AMBIENT
Definition: rs_option.h:143
RS2_OPTION_PROJECTOR_TEMPERATURE
@ RS2_OPTION_PROJECTOR_TEMPERATURE
Definition: rs_option.h:49
RS2_SENSOR_MODE_XGA
@ RS2_SENSOR_MODE_XGA
Definition: rs_option.h:154
RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY
@ RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY
Definition: rs_option.h:129
RS2_AMBIENT_LIGHT_LOW_AMBIENT
@ RS2_AMBIENT_LIGHT_LOW_AMBIENT
Definition: rs_option.h:164
RS2_OPTION_MOTION_MODULE_TEMPERATURE
@ RS2_OPTION_MOTION_MODULE_TEMPERATURE
Definition: rs_option.h:51
RS2_L500_VISUAL_PRESET_MAX_RANGE
@ RS2_L500_VISUAL_PRESET_MAX_RANGE
Definition: rs_option.h:144
RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION
@ RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION
Definition: rs_option.h:82
rs2_options_list
struct rs2_options_list rs2_options_list
Definition: rs_types.h:273
RS2_OPTION_COLOR_SCHEME
@ RS2_OPTION_COLOR_SCHEME
Definition: rs_option.h:55
rs2_get_option
float rs2_get_option(const rs2_options *options, rs2_option option, rs2_error **error)
rs2_error
struct rs2_error rs2_error
Definition: rs_types.h:247
RS2_OPTION_MOTION_RANGE
@ RS2_OPTION_MOTION_RANGE
Definition: rs_option.h:39
rs2_get_option_from_list
rs2_option rs2_get_option_from_list(const rs2_options_list *options, int i, rs2_error **error)
RS2_OPTION_PRE_PROCESSING_SHARPENING
@ RS2_OPTION_PRE_PROCESSING_SHARPENING
Definition: rs_option.h:90
RS2_OPTION_LLD_TEMPERATURE
@ RS2_OPTION_LLD_TEMPERATURE
Definition: rs_option.h:73
RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE
@ RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE
Definition: rs_option.h:35
RS2_OPTION_ENABLE_MOTION_CORRECTION
@ RS2_OPTION_ENABLE_MOTION_CORRECTION
Definition: rs_option.h:53