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  {
96  } rs2_option;
97 
98  // 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.
99  const char* rs2_option_to_string(rs2_option option);
100 
103  {
118 
121  {
132 
135  {
145 
147  typedef enum rs2_sensor_mode
148  {
152  } rs2_sensor_mode;
153  const char* rs2_sensor_mode_to_string(rs2_sensor_mode preset);
154 
156  typedef enum rs2_ambient_light
157  {
162 
170  int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
171 
179  float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
180 
188  void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
189 
196 
202  int rs2_get_options_list_size(const rs2_options_list* options, rs2_error** error);
203 
211  const char* rs2_get_option_name(const rs2_options* options, rs2_option option, rs2_error** error);
212 
218  rs2_option rs2_get_option_from_list(const rs2_options_list* options, int i, rs2_error** error);
219 
225 
233  int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
234 
245  void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
246 
254  const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
255 
264  const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
265 
266 #ifdef __cplusplus
267 }
268 #endif
269 #endif
const char * rs2_sensor_mode_to_string(rs2_sensor_mode preset)
Definition: rs_option.h:95
Definition: rs_option.h:66
Definition: rs_option.h:49
Definition: rs_option.h:139
Definition: rs_option.h:70
float rs2_get_option(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:79
Definition: rs_option.h:33
Definition: rs_option.h:140
Definition: rs_option.h:82
Definition: rs_option.h:81
Definition: rs_option.h:125
Definition: rs_option.h:104
Definition: rs_option.h:127
Definition: rs_option.h:113
Definition: rs_option.h:57
rs2_option
Defines general configuration controls. These can generally be mapped to camera UVC controls,...
Definition: rs_option.h:22
Definition: rs_option.h:51
Definition: rs_option.h:150
Definition: rs_option.h:55
Definition: rs_option.h:87
rs2_sr300_visual_preset
For SR300 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:102
const char * rs2_option_to_string(rs2_option option)
Definition: rs_option.h:136
Definition: rs_option.h:159
Definition: rs_option.h:109
Definition: rs_option.h:41
Definition: rs_option.h:64
Definition: rs_option.h:83
Definition: rs_option.h:90
Definition: rs_option.h:149
Definition: rs_option.h:31
Definition: rs_option.h:47
Definition: rs_option.h:45
Definition: rs_option.h:93
Definition: rs_option.h:39
Definition: rs_option.h:124
Definition: rs_option.h:78
Definition: rs_option.h:26
Definition: rs_option.h:126
const char * rs2_sr300_visual_preset_to_string(rs2_sr300_visual_preset preset)
Definition: rs_option.h:52
Definition: rs_option.h:30
Definition: rs_option.h:84
Definition: rs_option.h:91
Definition: rs_option.h:85
Definition: rs_option.h:37
int rs2_supports_option(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:46
Definition: rs_option.h:88
Definition: rs_option.h:60
Definition: rs_option.h:122
Definition: rs_option.h:24
Definition: rs_option.h:123
const char * rs2_get_option_name(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:77
Definition: rs_option.h:137
Exposes RealSense structs.
const char * rs2_get_option_value_description(const rs2_options *options, rs2_option option, float value, rs2_error **error)
Definition: rs_option.h:112
Definition: rs_option.h:108
Definition: rs_option.h:142
Definition: rs_option.h:29
Definition: rs_option.h:28
Definition: rs_option.h:43
void rs2_get_option_range(const rs2_options *sensor, rs2_option option, float *min, float *max, float *step, float *def, rs2_error **error)
Definition: rs_option.h:74
Definition: rs_option.h:62
rs2_options_list * rs2_get_options_list(const rs2_options *options, rs2_error **error)
struct rs2_options rs2_options
Definition: rs_types.h:242
Definition: rs_option.h:92
Definition: rs_option.h:151
Definition: rs_option.h:63
Definition: rs_option.h:72
Definition: rs_option.h:110
Definition: rs_option.h:76
Definition: rs_option.h:129
Definition: rs_option.h:89
Definition: rs_option.h:80
Definition: rs_option.h:111
Definition: rs_option.h:69
rs2_sensor_mode
For setting the camera_mode option.
Definition: rs_option.h:147
Definition: rs_option.h:105
Definition: rs_option.h:86
Definition: rs_option.h:58
Definition: rs_option.h:50
Definition: rs_option.h:138
rs2_rs400_visual_preset
For RS400 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:120
Definition: rs_option.h:27
Definition: rs_option.h:158
const char * rs2_get_option_description(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:73
rs2_ambient_light
ambient light for RS2_OPTION_AMBIENT_LIGHT option.
Definition: rs_option.h:156
Definition: rs_option.h:75
int rs2_is_option_read_only(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:34
Definition: rs_option.h:65
Definition: rs_option.h:114
Definition: rs_option.h:141
Definition: rs_option.h:68
Definition: rs_option.h:35
Definition: rs_option.h:53
Definition: rs_option.h:71
Definition: rs_option.h:48
const char * rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset)
void rs2_set_option(const rs2_options *options, rs2_option option, float value, rs2_error **error)
struct rs2_error rs2_error
Definition: rs_types.h:217
Definition: rs_option.h:59
void rs2_delete_options_list(rs2_options_list *list)
const char * rs2_l500_visual_preset_to_string(rs2_l500_visual_preset preset)
Definition: rs_option.h:61
Definition: rs_option.h:32
struct rs2_options_list rs2_options_list
Definition: rs_types.h:243
rs2_option rs2_get_option_from_list(const rs2_options_list *options, int i, rs2_error **error)
Definition: rs_option.h:54
const char * rs2_ambient_light_to_string(rs2_ambient_light preset)
Definition: rs_option.h:38
Definition: rs_option.h:36
int rs2_get_options_list_size(const rs2_options_list *options, rs2_error **error)
Definition: rs_option.h:94
Definition: rs_option.h:115
Definition: rs_option.h:25
Definition: rs_option.h:67
Definition: rs_option.h:40
Definition: rs_option.h:44
Definition: rs_option.h:42
rs2_l500_visual_preset
For L500 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:134