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  {
88  } rs2_option;
89 
90  // 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.
91  const char* rs2_option_to_string(rs2_option option);
92 
95  {
110 
113  {
124 
132  int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
133 
141  float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
142 
150  void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
151 
158 
164  int rs2_get_options_list_size(const rs2_options_list* options, rs2_error** error);
165 
173  const char* rs2_get_option_name(const rs2_options* options, rs2_option option, rs2_error** error);
174 
180  rs2_option rs2_get_option_from_list(const rs2_options_list* options, int i, rs2_error** error);
181 
187 
195  int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
196 
207  void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
208 
216  const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
217 
226  const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif
RS2_OPTION_STREAM_FORMAT_FILTER
Definition: rs_option.h:68
RS2_OPTION_CONFIDENCE_THRESHOLD
Definition: rs_option.h:41
RS2_OPTION_MA_TEMPERATURE
Definition: rs_option.h:75
RS2_OPTION_ACCURACY
Definition: rs_option.h:38
RS2_OPTION_ENABLE_AUTO_EXPOSURE
Definition: rs_option.h:34
RS2_OPTION_CONTRAST
Definition: rs_option.h:26
RS2_RS400_VISUAL_PRESET_CUSTOM
Definition: rs_option.h:114
RS2_OPTION_APD_TEMPERATURE
Definition: rs_option.h:78
RS2_RS400_VISUAL_PRESET_HIGH_DENSITY
Definition: rs_option.h:118
RS2_OPTION_TOTAL_FRAME_DROPS
Definition: rs_option.h:44
RS2_OPTION_BACKLIGHT_COMPENSATION
Definition: rs_option.h:24
RS2_OPTION_GLOBAL_TIME_ENABLED
Definition: rs_option.h:77
RS2_OPTION_TEXTURE_SOURCE
Definition: rs_option.h:59
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:94
RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING
Definition: rs_option.h:100
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
Definition: rs_option.h:104
RS2_OPTION_WHITE_BALANCE
Definition: rs_option.h:33
RS2_OPTION_FILTER_SMOOTH_DELTA
Definition: rs_option.h:62
RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS
Definition: rs_option.h:101
RS2_SR300_VISUAL_PRESET_SHORT_RANGE
Definition: rs_option.h:96
RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN
Definition: rs_option.h:120
RS2_SR300_VISUAL_PRESET_MID_RANGE
Definition: rs_option.h:105
RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY
Definition: rs_option.h:119
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_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
Definition: rs_option.h:45
rs2_rs400_visual_preset_to_string
const char * rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset)
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
Definition: rs_option.h:116
RS2_SR300_VISUAL_PRESET_FACE_LOGIN
Definition: rs_option.h:102
RS2_OPTION_FRAMES_QUEUE_SIZE
Definition: rs_option.h:43
RS2_OPTION_ENABLE_MAP_PRESERVATION
Definition: rs_option.h:86
RS2_RS400_VISUAL_PRESET_COUNT
Definition: rs_option.h:121
rs_types.h
Exposes RealSense structs.
RS2_OPTION_LED_POWER
Definition: rs_option.h:84
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_OPTION_OUTPUT_TRIGGER_ENABLED
Definition: rs_option.h:50
RS2_OPTION_STEREO_BASELINE
Definition: rs_option.h:64
RS2_OPTION_ENABLE_RELOCALIZATION
Definition: rs_option.h:80
rs2_options
struct rs2_options rs2_options
Definition: rs_types.h:235
RS2_OPTION_HUE
Definition: rs_option.h:30
RS2_OPTION_DEPTH_OFFSET
Definition: rs_option.h:83
RS2_OPTION_SATURATION
Definition: rs_option.h:31
RS2_OPTION_DEPTH_UNITS
Definition: rs_option.h:52
RS2_OPTION_ASIC_TEMPERATURE
Definition: rs_option.h:47
RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION
Definition: rs_option.h:98
rs2_get_options_list
rs2_options_list * rs2_get_options_list(const rs2_options *options, rs2_error **error)
RS2_SR300_VISUAL_PRESET_IR_ONLY
Definition: rs_option.h:106
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:22
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_OPTION_MAX_DISTANCE
Definition: rs_option.h:58
RS2_OPTION_ZERO_ORDER_POINT_X
Definition: rs_option.h:71
RS2_OPTION_EXPOSURE
Definition: rs_option.h:27
RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION
Definition: rs_option.h:99
RS2_OPTION_FILTER_SMOOTH_ALPHA
Definition: rs_option.h:61
RS2_OPTION_LASER_POWER
Definition: rs_option.h:37
RS2_OPTION_POWER_LINE_FREQUENCY
Definition: rs_option.h:46
RS2_OPTION_GAMMA
Definition: rs_option.h:29
RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED
Definition: rs_option.h:56
RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP
Definition: rs_option.h:65
RS2_SR300_VISUAL_PRESET_COUNT
Definition: rs_option.h:107
RS2_OPTION_STREAM_FILTER
Definition: rs_option.h:67
RS2_OPTION_BRIGHTNESS
Definition: rs_option.h:25
RS2_OPTION_ERROR_POLLING_ENABLED
Definition: rs_option.h:48
RS2_RS400_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:115
rs2_rs400_visual_preset
rs2_rs400_visual_preset
For RS400 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:112
RS2_OPTION_ZERO_ORDER_POINT_Y
Definition: rs_option.h:72
RS2_OPTION_VISUAL_PRESET
Definition: rs_option.h:36
rs2_delete_options_list
void rs2_delete_options_list(rs2_options_list *list)
RS2_OPTION_EMITTER_ENABLED
Definition: rs_option.h:42
RS2_OPTION_AUTO_EXPOSURE_PRIORITY
Definition: rs_option.h:54
RS2_OPTION_COUNT
Definition: rs_option.h:87
RS2_OPTION_SHARPNESS
Definition: rs_option.h:32
RS2_SR300_VISUAL_PRESET_LONG_RANGE
Definition: rs_option.h:97
RS2_OPTION_FILTER_OPTION
Definition: rs_option.h:40
RS2_OPTION_MC_TEMPERATURE
Definition: rs_option.h:74
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
Definition: rs_option.h:57
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
Definition: rs_option.h:103
RS2_OPTION_STREAM_INDEX_FILTER
Definition: rs_option.h:69
RS2_OPTION_PROJECTOR_TEMPERATURE
Definition: rs_option.h:49
RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY
Definition: rs_option.h:117
RS2_OPTION_MOTION_MODULE_TEMPERATURE
Definition: rs_option.h:51
RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION
Definition: rs_option.h:82
rs2_options_list
struct rs2_options_list rs2_options_list
Definition: rs_types.h:236
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:211
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_LLD_TEMPERATURE
Definition: rs_option.h:73
RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE
Definition: rs_option.h:35
RS2_OPTION_ENABLE_MOTION_CORRECTION
Definition: rs_option.h:53