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 {
67 } rs2_option;
68 const char* rs2_option_to_string(rs2_option option);
69 
72 {
86 const char* rs2_sr300_visual_preset_to_string(rs2_sr300_visual_preset preset);
87 
90 {
99 const char* rs2_rs400_visual_preset_to_string(rs2_rs400_visual_preset preset);
100 
108 int rs2_is_option_read_only(const rs2_options* options, rs2_option option, rs2_error** error);
109 
117 float rs2_get_option(const rs2_options* options, rs2_option option, rs2_error** error);
118 
126 void rs2_set_option(const rs2_options* options, rs2_option option, float value, rs2_error** error);
127 
135 int rs2_supports_option(const rs2_options* options, rs2_option option, rs2_error** error);
136 
147 void rs2_get_option_range(const rs2_options* sensor, rs2_option option, float* min, float* max, float* step, float* def, rs2_error** error);
148 
156 const char* rs2_get_option_description(const rs2_options* options, rs2_option option, rs2_error ** error);
157 
166 const char* rs2_get_option_value_description(const rs2_options* options, rs2_option option, float value, rs2_error ** error);
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 #endif
Definition: rs_option.h:66
Definition: rs_option.h:49
float rs2_get_option(const rs2_options *options, rs2_option option, rs2_error **error)
Definition: rs_option.h:33
Definition: rs_option.h:94
Definition: rs_option.h:73
Definition: rs_option.h:96
Definition: rs_option.h:82
Definition: backend.h:378
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:71
const char * rs2_option_to_string(rs2_option option)
Definition: rs_option.h:78
Definition: rs_option.h:41
Definition: rs_option.h:64
Definition: rs_option.h:31
Definition: api.h:18
Definition: rs_option.h:47
Definition: rs_option.h:45
Definition: rs_option.h:39
Definition: rs_option.h:93
Definition: rs_option.h:26
Definition: rs_option.h:95
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:91
Definition: rs_option.h:24
Definition: rs_option.h:92
const char * rs2_get_option_value_description(const rs2_options *options, rs2_option option, float value, rs2_error **error)
Definition: rs_option.h:81
Definition: rs_option.h:77
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:62
struct rs2_options rs2_options
Definition: rs_types.h:170
Definition: rs_option.h:63
Definition: rs_option.h:79
Definition: rs_option.h:97
Definition: rs_option.h:80
Definition: rs_option.h:74
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:89
Definition: rs_option.h:27
const char * rs2_get_option_description(const rs2_options *options, rs2_option option, rs2_error **error)
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:83
Definition: rs_option.h:35
Definition: rs_option.h:53
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)
Definition: rs_option.h:59
Definition: rs_option.h:61
Definition: rs_option.h:32
Definition: rs_option.h:54
Definition: rs_option.h:38
Definition: rs_option.h:36
Definition: rs_option.h:84
Definition: rs_option.h:25
Definition: rs_option.h:40
Definition: rs_option.h:44
Definition: rs_option.h:42