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  {
77  } rs2_option;
78 
79  // 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.
80  const char* rs2_option_to_string(rs2_option option);
81 
84  {
99 
102  {
113 
121  int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
122 
130  float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
131 
139  void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
140 
147 
153  int rs2_get_options_list_size(const rs2_options_list* options, rs2_error** error);
154 
162  const char* rs2_get_option_name(const rs2_options* options, rs2_option option, rs2_error** error);
163 
169  rs2_option rs2_get_option_from_list(const rs2_options_list* options, int i, rs2_error** error);
170 
176 
184  int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
185 
196  void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
197 
205  const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
206 
215  const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 #endif
Definition: rs_option.h:76
Definition: rs_option.h:66
Definition: rs_option.h:49
Definition: rs_option.h:70
float rs2_get_option(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:33
Definition: rs_option.h:106
Definition: rs_option.h:85
Definition: rs_option.h:108
Definition: rs_option.h:94
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:55
rs2_sr300_visual_preset
For SR300 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:83
const char * rs2_option_to_string(rs2_option option)
Definition: rs_option.h:90
Definition: rs_option.h:41
Definition: rs_option.h:64
Definition: rs_option.h:31
Definition: rs_option.h:47
Definition: rs_option.h:45
Definition: rs_option.h:39
Definition: rs_option.h:105
Definition: rs_option.h:26
Definition: rs_option.h:107
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:37
int rs2_supports_option(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:46
Definition: rs_option.h:60
Definition: rs_option.h:103
Definition: rs_option.h:24
Definition: rs_option.h:104
const char * rs2_get_option_name(const rs2_options *options, rs2_option option, rs2_error **error)
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:93
Definition: rs_option.h:89
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:220
Definition: rs_option.h:63
Definition: rs_option.h:72
Definition: rs_option.h:91
Definition: rs_option.h:110
Definition: rs_option.h:92
Definition: rs_option.h:69
Definition: rs_option.h:86
Definition: rs_option.h:58
Definition: rs_option.h:50
rs2_rs400_visual_preset
For RS400 devices: provides optimized settings (presets) for specific types of usage.
Definition: rs_option.h:101
Definition: rs_option.h:27
const char * rs2_get_option_description(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:73
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:95
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:197
Definition: rs_option.h:59
void rs2_delete_options_list(rs2_options_list *list)
Definition: rs_option.h:61
Definition: rs_option.h:32
struct rs2_options_list rs2_options_list
Definition: rs_types.h:221
rs2_option rs2_get_option_from_list(const rs2_options_list *options, int i, rs2_error **error)
Definition: rs_option.h:54
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:96
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