Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Loading...
Searching...
No Matches
rs_option.h
Go to the documentation of this file.
1/* License: Apache 2.0. See LICENSE file in root directory.
2Copyright(c) 2017 Intel Corporation. All Rights Reserved. */
3
10#ifndef LIBREALSENSE_RS2_OPTION_H
11#define LIBREALSENSE_RS2_OPTION_H
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
17#include "rs_types.h"
18
22 typedef enum rs2_option
23 {
121
122 // 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.
123 const char* rs2_option_to_string(rs2_option option);
124
127 {
142
145 {
156
159 {
170
172 typedef enum rs2_sensor_mode
173 {
180
182 typedef enum rs2_ambient_light
183 {
188
190 typedef enum rs2_digital_gain
191 {
197
200 {
207
210 {
216
224 int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
225
233 float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
234
242 void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
243
250
257
265 const char* rs2_get_option_name(const rs2_options* options, rs2_option option, rs2_error** error);
266
273
279
287 int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
288
299 void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
300
308 const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
309
318 const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
319
320#ifdef __cplusplus
321}
322#endif
323#endif
const char * rs2_l500_visual_preset_to_string(rs2_l500_visual_preset preset)
rs2_sr300_visual_preset
For SR300 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:127
@ RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS
Definition: rs_option.h:133
@ RS2_SR300_VISUAL_PRESET_LONG_RANGE
Definition: rs_option.h:129
@ RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION
Definition: rs_option.h:130
@ RS2_SR300_VISUAL_PRESET_GR_CURSOR
Definition: rs_option.h:135
@ RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING
Definition: rs_option.h:132
@ RS2_SR300_VISUAL_PRESET_COUNT
Definition: rs_option.h:139
@ RS2_SR300_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:136
@ RS2_SR300_VISUAL_PRESET_FACE_LOGIN
Definition: rs_option.h:134
@ RS2_SR300_VISUAL_PRESET_SHORT_RANGE
Definition: rs_option.h:128
@ RS2_SR300_VISUAL_PRESET_IR_ONLY
Definition: rs_option.h:138
@ RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION
Definition: rs_option.h:131
@ RS2_SR300_VISUAL_PRESET_MID_RANGE
Definition: rs_option.h:137
rs2_l500_visual_preset
For L500 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:159
@ RS2_L500_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:161
@ RS2_L500_VISUAL_PRESET_NO_AMBIENT
Definition: rs_option.h:162
@ RS2_L500_VISUAL_PRESET_CUSTOM
Definition: rs_option.h:160
@ RS2_L500_VISUAL_PRESET_MAX_RANGE
Definition: rs_option.h:164
@ RS2_L500_VISUAL_PRESET_COUNT
Definition: rs_option.h:167
@ RS2_L500_VISUAL_PRESET_AUTOMATIC
Definition: rs_option.h:166
@ RS2_L500_VISUAL_PRESET_SHORT_RANGE
Definition: rs_option.h:165
@ RS2_L500_VISUAL_PRESET_LOW_AMBIENT
Definition: rs_option.h:163
const char * rs2_get_option_name(const rs2_options *options, rs2_option option, rs2_error **error)
const char * rs2_ambient_light_to_string(rs2_ambient_light preset)
const char * rs2_digital_gain_to_string(rs2_digital_gain preset)
const char * rs2_option_to_string(rs2_option option)
const char * rs2_emitter_frequency_mode_to_string(rs2_emitter_frequency_mode mode)
const char * rs2_sensor_mode_to_string(rs2_sensor_mode preset)
const char * rs2_host_perf_mode_to_string(rs2_host_perf_mode perf)
void rs2_set_option(const rs2_options *options, rs2_option option, float value, rs2_error **error)
rs2_sensor_mode
For setting the camera_mode option.
Definition: rs_option.h:173
@ RS2_SENSOR_MODE_XGA
Definition: rs_option.h:175
@ RS2_SENSOR_MODE_COUNT
Definition: rs_option.h:177
@ RS2_SENSOR_MODE_QVGA
Definition: rs_option.h:176
@ RS2_SENSOR_MODE_VGA
Definition: rs_option.h:174
rs2_ambient_light
DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead.
Definition: rs_option.h:183
@ RS2_AMBIENT_LIGHT_LOW_AMBIENT
Definition: rs_option.h:185
@ RS2_AMBIENT_LIGHT_NO_AMBIENT
Definition: rs_option.h:184
rs2_host_perf_mode
values for RS2_OPTION_HOST_PERFORMANCE option.
Definition: rs_option.h:200
@ RS2_HOST_PERF_LOW
Definition: rs_option.h:202
@ RS2_HOST_PERF_DEFAULT
Definition: rs_option.h:201
@ RS2_HOST_PERF_COUNT
Definition: rs_option.h:204
@ RS2_HOST_PERF_HIGH
Definition: rs_option.h:203
int rs2_get_options_list_size(const rs2_options_list *options, rs2_error **error)
rs2_option
Defines general configuration controls. These can generally be mapped to camera UVC controls,...
Definition: rs_option.h:23
@ RS2_OPTION_FILTER_OPTION
Definition: rs_option.h:40
@ RS2_OPTION_FILTER_SMOOTH_ALPHA
Definition: rs_option.h:61
@ RS2_OPTION_EMITTER_FREQUENCY
Definition: rs_option.h:118
@ RS2_OPTION_SEQUENCE_NAME
Definition: rs_option.h:102
@ RS2_OPTION_THERMAL_COMPENSATION
Definition: rs_option.h:97
@ RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION
Definition: rs_option.h:82
@ RS2_OPTION_STREAM_FILTER
Definition: rs_option.h:67
@ RS2_OPTION_SATURATION
Definition: rs_option.h:31
@ RS2_OPTION_GLOBAL_TIME_ENABLED
Definition: rs_option.h:77
@ RS2_OPTION_BACKLIGHT_COMPENSATION
Definition: rs_option.h:24
@ RS2_OPTION_LLD_TEMPERATURE
Definition: rs_option.h:73
@ RS2_OPTION_RECEIVER_SENSITIVITY
Definition: rs_option.h:115
@ RS2_OPTION_ZERO_ORDER_POINT_X
Definition: rs_option.h:71
@ RS2_OPTION_HOST_PERFORMANCE
Definition: rs_option.h:100
@ RS2_OPTION_MOTION_RANGE
Definition: rs_option.h:39
@ RS2_OPTION_HDR_ENABLED
Definition: rs_option.h:101
@ RS2_OPTION_AMBIENT_LIGHT
Definition: rs_option.h:93
@ RS2_OPTION_AUTO_EXPOSURE_MODE
Definition: rs_option.h:45
@ RS2_OPTION_FRAMES_QUEUE_SIZE
Definition: rs_option.h:43
@ RS2_OPTION_INVALIDATION_BYPASS
Definition: rs_option.h:92
@ RS2_OPTION_ENABLE_POSE_JUMPING
Definition: rs_option.h:81
@ RS2_OPTION_TOTAL_FRAME_DROPS
Definition: rs_option.h:44
@ RS2_OPTION_COUNT
Definition: rs_option.h:119
@ RS2_OPTION_CONTRAST
Definition: rs_option.h:26
@ RS2_OPTION_HOLES_FILL
Definition: rs_option.h:63
@ RS2_OPTION_LASER_POWER
Definition: rs_option.h:37
@ RS2_OPTION_PROJECTOR_TEMPERATURE
Definition: rs_option.h:49
@ RS2_OPTION_HUMIDITY_TEMPERATURE
Definition: rs_option.h:105
@ RS2_OPTION_SENSOR_MODE
Definition: rs_option.h:95
@ RS2_OPTION_NOISE_FILTERING
Definition: rs_option.h:91
@ RS2_OPTION_MA_TEMPERATURE
Definition: rs_option.h:75
@ RS2_OPTION_ENABLE_AUTO_EXPOSURE
Definition: rs_option.h:34
@ RS2_OPTION_AUTO_EXPOSURE_PRIORITY
Definition: rs_option.h:54
@ RS2_OPTION_AUTO_RX_SENSITIVITY
Definition: rs_option.h:112
@ RS2_OPTION_EMITTER_ON_OFF
Definition: rs_option.h:70
@ RS2_OPTION_ZERO_ORDER_ENABLED
Definition: rs_option.h:85
@ RS2_OPTION_SHARPNESS
Definition: rs_option.h:32
@ RS2_OPTION_CONFIDENCE_THRESHOLD
Definition: rs_option.h:41
@ RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE
Definition: rs_option.h:35
@ RS2_OPTION_HUE
Definition: rs_option.h:30
@ RS2_OPTION_DEPTH_OFFSET
Definition: rs_option.h:83
@ RS2_OPTION_GAIN
Definition: rs_option.h:28
@ RS2_OPTION_AUTO_EXPOSURE_LIMIT_TOGGLE
Definition: rs_option.h:116
@ RS2_OPTION_WHITE_BALANCE
Definition: rs_option.h:33
@ RS2_OPTION_SEQUENCE_ID
Definition: rs_option.h:104
@ RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP
Definition: rs_option.h:65
@ RS2_OPTION_MAX_DISTANCE
Definition: rs_option.h:58
@ RS2_OPTION_EMITTER_ALWAYS_ON
Definition: rs_option.h:96
@ RS2_OPTION_TRANSMITTER_FREQUENCY
Definition: rs_option.h:113
@ RS2_OPTION_COLOR_SCHEME
Definition: rs_option.h:55
@ RS2_OPTION_STREAM_INDEX_FILTER
Definition: rs_option.h:69
@ RS2_OPTION_FREEFALL_DETECTION_ENABLED
Definition: rs_option.h:87
@ RS2_OPTION_AVALANCHE_PHOTO_DIODE
Definition: rs_option.h:88
@ RS2_OPTION_ENABLE_MOTION_CORRECTION
Definition: rs_option.h:53
@ RS2_OPTION_ALTERNATE_IR
Definition: rs_option.h:107
@ RS2_OPTION_EMITTER_ENABLED
Definition: rs_option.h:42
@ RS2_OPTION_MOTION_MODULE_TEMPERATURE
Definition: rs_option.h:51
@ RS2_OPTION_VERTICAL_BINNING
Definition: rs_option.h:114
@ RS2_OPTION_ENABLE_MAX_USABLE_RANGE
Definition: rs_option.h:106
@ RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED
Definition: rs_option.h:56
@ RS2_OPTION_EXPOSURE
Definition: rs_option.h:27
@ RS2_OPTION_AUTO_GAIN_LIMIT_TOGGLE
Definition: rs_option.h:117
@ RS2_OPTION_ENABLE_RELOCALIZATION
Definition: rs_option.h:80
@ RS2_OPTION_POWER_LINE_FREQUENCY
Definition: rs_option.h:46
@ RS2_OPTION_MIN_DISTANCE
Definition: rs_option.h:57
@ RS2_OPTION_FILTER_SMOOTH_DELTA
Definition: rs_option.h:62
@ RS2_OPTION_INTER_CAM_SYNC_MODE
Definition: rs_option.h:66
@ RS2_OPTION_TEXTURE_SOURCE
Definition: rs_option.h:59
@ RS2_OPTION_ASIC_TEMPERATURE
Definition: rs_option.h:47
@ RS2_OPTION_ACCURACY
Definition: rs_option.h:38
@ RS2_OPTION_ENABLE_IR_REFLECTIVITY
Definition: rs_option.h:109
@ RS2_OPTION_ZERO_ORDER_POINT_Y
Definition: rs_option.h:72
@ RS2_OPTION_AUTO_EXPOSURE_LIMIT
Definition: rs_option.h:110
@ RS2_OPTION_SEQUENCE_SIZE
Definition: rs_option.h:103
@ RS2_OPTION_PRE_PROCESSING_SHARPENING
Definition: rs_option.h:90
@ RS2_OPTION_ENABLE_MAP_PRESERVATION
Definition: rs_option.h:86
@ RS2_OPTION_STEREO_BASELINE
Definition: rs_option.h:64
@ RS2_OPTION_RESET_CAMERA_ACCURACY_HEALTH
Definition: rs_option.h:99
@ RS2_OPTION_POST_PROCESSING_SHARPENING
Definition: rs_option.h:89
@ RS2_OPTION_HARDWARE_PRESET
Definition: rs_option.h:76
@ RS2_OPTION_GAMMA
Definition: rs_option.h:29
@ RS2_OPTION_OUTPUT_TRIGGER_ENABLED
Definition: rs_option.h:50
@ RS2_OPTION_FILTER_MAGNITUDE
Definition: rs_option.h:60
@ RS2_OPTION_APD_TEMPERATURE
Definition: rs_option.h:78
@ RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH
Definition: rs_option.h:98
@ RS2_OPTION_STREAM_FORMAT_FILTER
Definition: rs_option.h:68
@ RS2_OPTION_VISUAL_PRESET
Definition: rs_option.h:36
@ RS2_OPTION_MC_TEMPERATURE
Definition: rs_option.h:74
@ RS2_OPTION_NOISE_ESTIMATION
Definition: rs_option.h:108
@ RS2_OPTION_AUTO_GAIN_LIMIT
Definition: rs_option.h:111
@ RS2_OPTION_ERROR_POLLING_ENABLED
Definition: rs_option.h:48
@ RS2_OPTION_ENABLE_MAPPING
Definition: rs_option.h:79
@ RS2_OPTION_DEPTH_UNITS
Definition: rs_option.h:52
@ RS2_OPTION_BRIGHTNESS
Definition: rs_option.h:25
@ RS2_OPTION_DIGITAL_GAIN
Definition: rs_option.h:94
@ RS2_OPTION_LED_POWER
Definition: rs_option.h:84
rs2_options_list * rs2_get_options_list(const rs2_options *options, rs2_error **error)
rs2_option rs2_get_option_from_list(const rs2_options_list *options, int i, rs2_error **error)
const char * rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset)
void rs2_delete_options_list(rs2_options_list *list)
int rs2_is_option_read_only(const rs2_options *options, rs2_option option, rs2_error **error)
rs2_digital_gain
digital gain for RS2_OPTION_DIGITAL_GAIN option.
Definition: rs_option.h:191
@ RS2_DIGITAL_GAIN_AUTO
Definition: rs_option.h:192
@ RS2_DIGITAL_GAIN_LOW
Definition: rs_option.h:194
@ RS2_DIGITAL_GAIN_HIGH
Definition: rs_option.h:193
rs2_rs400_visual_preset
For RS400 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:145
@ RS2_RS400_VISUAL_PRESET_DEFAULT
Definition: rs_option.h:147
@ RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY
Definition: rs_option.h:151
@ RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN
Definition: rs_option.h:152
@ RS2_RS400_VISUAL_PRESET_COUNT
Definition: rs_option.h:153
@ RS2_RS400_VISUAL_PRESET_HIGH_DENSITY
Definition: rs_option.h:150
@ RS2_RS400_VISUAL_PRESET_HAND
Definition: rs_option.h:148
@ RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY
Definition: rs_option.h:149
@ RS2_RS400_VISUAL_PRESET_CUSTOM
Definition: rs_option.h:146
const char * rs2_sr300_visual_preset_to_string(rs2_sr300_visual_preset preset)
void rs2_get_option_range(const rs2_options *sensor, rs2_option option, float *min, float *max, float *step, float *def, rs2_error **error)
const char * rs2_get_option_value_description(const rs2_options *options, rs2_option option, float value, rs2_error **error)
const char * rs2_get_option_description(const rs2_options *options, rs2_option option, rs2_error **error)
rs2_emitter_frequency_mode
values for RS2_EMITTER_FREQUENCY option.
Definition: rs_option.h:210
@ RS2_EMITTER_FREQUENCY_91_KHZ
Definition: rs_option.h:212
@ RS2_EMITTER_FREQUENCY_57_KHZ
Definition: rs_option.h:211
@ RS2_EMITTER_FREQUENCY_COUNT
Definition: rs_option.h:213
float rs2_get_option(const rs2_options *options, rs2_option option, rs2_error **error)
int rs2_supports_option(const rs2_options *options, rs2_option option, rs2_error **error)
Exposes RealSense structs.
struct rs2_error rs2_error
Definition: rs_types.h:259
struct rs2_options_list rs2_options_list
Definition: rs_types.h:285
struct rs2_options rs2_options
Definition: rs_types.h:284