Typedefs | Enumerations | Functions
rs_option.h File Reference

Exposes sensor options functionality for C compilers. More...

#include "rs_types.h"
Include dependency graph for rs_option.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef enum rs2_ambient_light rs2_ambient_light
 DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead. More...
 
typedef enum rs2_cah_trigger rs2_cah_trigger
 values for RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH option. More...
 
typedef enum rs2_digital_gain rs2_digital_gain
 digital gain for RS2_OPTION_DIGITAL_GAIN option. More...
 
typedef enum rs2_host_perf_mode rs2_host_perf_mode
 values for RS2_OPTION_HOST_PERFORMANCE option. More...
 
typedef enum rs2_l500_visual_preset rs2_l500_visual_preset
 For L500 devices: provides optimized settings (presets) for specific types of usage. More...
 
typedef enum rs2_option rs2_option
 Defines general configuration controls. These can generally be mapped to camera UVC controls, and can be set / queried at any time unless stated otherwise. More...
 
typedef enum rs2_rs400_visual_preset rs2_rs400_visual_preset
 For RS400 devices: provides optimized settings (presets) for specific types of usage. More...
 
typedef enum rs2_sensor_mode rs2_sensor_mode
 For setting the camera_mode option. More...
 
typedef enum rs2_sr300_visual_preset rs2_sr300_visual_preset
 For SR300 devices: provides optimized settings (presets) for specific types of usage. More...
 

Enumerations

enum  rs2_ambient_light { RS2_AMBIENT_LIGHT_NO_AMBIENT = 1, RS2_AMBIENT_LIGHT_LOW_AMBIENT = 2 }
 DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead. More...
 
enum  rs2_cah_trigger { RS2_CAH_TRIGGER_MANUAL = 0, RS2_CAH_TRIGGER_NOW = 1, RS2_CAH_TRIGGER_AUTO = 2, RS2_CAH_TRIGGER_COUNT }
 values for RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH option. More...
 
enum  rs2_digital_gain { RS2_DIGITAL_GAIN_AUTO = 0, RS2_DIGITAL_GAIN_HIGH = 1, RS2_DIGITAL_GAIN_LOW = 2 }
 digital gain for RS2_OPTION_DIGITAL_GAIN option. More...
 
enum  rs2_host_perf_mode { RS2_HOST_PERF_DEFAULT = 0, RS2_HOST_PERF_LOW = 1, RS2_HOST_PERF_HIGH = 2, RS2_HOST_PERF_COUNT }
 values for RS2_OPTION_HOST_PERFORMANCE option. More...
 
enum  rs2_l500_visual_preset {
  RS2_L500_VISUAL_PRESET_CUSTOM, RS2_L500_VISUAL_PRESET_DEFAULT, RS2_L500_VISUAL_PRESET_NO_AMBIENT, RS2_L500_VISUAL_PRESET_LOW_AMBIENT,
  RS2_L500_VISUAL_PRESET_MAX_RANGE, RS2_L500_VISUAL_PRESET_SHORT_RANGE, RS2_L500_VISUAL_PRESET_AUTOMATIC, RS2_L500_VISUAL_PRESET_COUNT
}
 For L500 devices: provides optimized settings (presets) for specific types of usage. More...
 
enum  rs2_option {
  RS2_OPTION_BACKLIGHT_COMPENSATION, RS2_OPTION_BRIGHTNESS, RS2_OPTION_CONTRAST, RS2_OPTION_EXPOSURE,
  RS2_OPTION_GAIN, RS2_OPTION_GAMMA, RS2_OPTION_HUE, RS2_OPTION_SATURATION,
  RS2_OPTION_SHARPNESS, RS2_OPTION_WHITE_BALANCE, RS2_OPTION_ENABLE_AUTO_EXPOSURE, RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE,
  RS2_OPTION_VISUAL_PRESET, RS2_OPTION_LASER_POWER, RS2_OPTION_ACCURACY, RS2_OPTION_MOTION_RANGE,
  RS2_OPTION_FILTER_OPTION, RS2_OPTION_CONFIDENCE_THRESHOLD, RS2_OPTION_EMITTER_ENABLED, RS2_OPTION_FRAMES_QUEUE_SIZE,
  RS2_OPTION_TOTAL_FRAME_DROPS, RS2_OPTION_AUTO_EXPOSURE_MODE, RS2_OPTION_POWER_LINE_FREQUENCY, RS2_OPTION_ASIC_TEMPERATURE,
  RS2_OPTION_ERROR_POLLING_ENABLED, RS2_OPTION_PROJECTOR_TEMPERATURE, RS2_OPTION_OUTPUT_TRIGGER_ENABLED, RS2_OPTION_MOTION_MODULE_TEMPERATURE,
  RS2_OPTION_DEPTH_UNITS, RS2_OPTION_ENABLE_MOTION_CORRECTION, RS2_OPTION_AUTO_EXPOSURE_PRIORITY, RS2_OPTION_COLOR_SCHEME,
  RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED, RS2_OPTION_MIN_DISTANCE, RS2_OPTION_MAX_DISTANCE, RS2_OPTION_TEXTURE_SOURCE,
  RS2_OPTION_FILTER_MAGNITUDE, RS2_OPTION_FILTER_SMOOTH_ALPHA, RS2_OPTION_FILTER_SMOOTH_DELTA, RS2_OPTION_HOLES_FILL,
  RS2_OPTION_STEREO_BASELINE, RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP, RS2_OPTION_INTER_CAM_SYNC_MODE, RS2_OPTION_STREAM_FILTER,
  RS2_OPTION_STREAM_FORMAT_FILTER, RS2_OPTION_STREAM_INDEX_FILTER, RS2_OPTION_EMITTER_ON_OFF, RS2_OPTION_ZERO_ORDER_POINT_X,
  RS2_OPTION_ZERO_ORDER_POINT_Y, RS2_OPTION_LLD_TEMPERATURE, RS2_OPTION_MC_TEMPERATURE, RS2_OPTION_MA_TEMPERATURE,
  RS2_OPTION_HARDWARE_PRESET, RS2_OPTION_GLOBAL_TIME_ENABLED, RS2_OPTION_APD_TEMPERATURE, RS2_OPTION_ENABLE_MAPPING,
  RS2_OPTION_ENABLE_RELOCALIZATION, RS2_OPTION_ENABLE_POSE_JUMPING, RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION, RS2_OPTION_DEPTH_OFFSET,
  RS2_OPTION_LED_POWER, RS2_OPTION_ZERO_ORDER_ENABLED, RS2_OPTION_ENABLE_MAP_PRESERVATION, RS2_OPTION_FREEFALL_DETECTION_ENABLED,
  RS2_OPTION_AVALANCHE_PHOTO_DIODE, RS2_OPTION_POST_PROCESSING_SHARPENING, RS2_OPTION_PRE_PROCESSING_SHARPENING, RS2_OPTION_NOISE_FILTERING,
  RS2_OPTION_INVALIDATION_BYPASS, RS2_OPTION_AMBIENT_LIGHT, RS2_OPTION_DIGITAL_GAIN = RS2_OPTION_AMBIENT_LIGHT, RS2_OPTION_SENSOR_MODE,
  RS2_OPTION_EMITTER_ALWAYS_ON, RS2_OPTION_THERMAL_COMPENSATION, RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH, RS2_OPTION_RESET_CAMERA_ACCURACY_HEALTH,
  RS2_OPTION_HOST_PERFORMANCE, RS2_OPTION_HDR_ENABLED, RS2_OPTION_SEQUENCE_NAME, RS2_OPTION_SEQUENCE_SIZE,
  RS2_OPTION_SEQUENCE_ID, RS2_OPTION_HUMIDITY_TEMPERATURE, RS2_OPTION_ENABLE_MAX_USABLE_RANGE, RS2_OPTION_ALTERNATE_IR,
  RS2_OPTION_NOISE_ESTIMATION, RS2_OPTION_ENABLE_IR_REFLECTIVITY, RS2_OPTION_AUTO_EXPOSURE_LIMIT, RS2_OPTION_AUTO_GAIN_LIMIT,
  RS2_OPTION_COUNT
}
 Defines general configuration controls. These can generally be mapped to camera UVC controls, and can be set / queried at any time unless stated otherwise. More...
 
enum  rs2_rs400_visual_preset {
  RS2_RS400_VISUAL_PRESET_CUSTOM, RS2_RS400_VISUAL_PRESET_DEFAULT, RS2_RS400_VISUAL_PRESET_HAND, RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY,
  RS2_RS400_VISUAL_PRESET_HIGH_DENSITY, RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY, RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN, RS2_RS400_VISUAL_PRESET_COUNT
}
 For RS400 devices: provides optimized settings (presets) for specific types of usage. More...
 
enum  rs2_sensor_mode { RS2_SENSOR_MODE_VGA, RS2_SENSOR_MODE_XGA, RS2_SENSOR_MODE_QVGA, RS2_SENSOR_MODE_COUNT }
 For setting the camera_mode option. More...
 
enum  rs2_sr300_visual_preset {
  RS2_SR300_VISUAL_PRESET_SHORT_RANGE, RS2_SR300_VISUAL_PRESET_LONG_RANGE, RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION, RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION,
  RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING, RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS, RS2_SR300_VISUAL_PRESET_FACE_LOGIN, RS2_SR300_VISUAL_PRESET_GR_CURSOR,
  RS2_SR300_VISUAL_PRESET_DEFAULT, RS2_SR300_VISUAL_PRESET_MID_RANGE, RS2_SR300_VISUAL_PRESET_IR_ONLY, RS2_SR300_VISUAL_PRESET_COUNT
}
 For SR300 devices: provides optimized settings (presets) for specific types of usage. More...
 

Functions

const char * rs2_ambient_light_to_string (rs2_ambient_light preset)
 
const char * rs2_cah_trigger_to_string (rs2_cah_trigger preset)
 
void rs2_delete_options_list (rs2_options_list *list)
 
const char * rs2_digital_gain_to_string (rs2_digital_gain preset)
 
float rs2_get_option (const rs2_options *options, rs2_option option, rs2_error **error)
 
const char * rs2_get_option_description (const rs2_options *options, rs2_option option, rs2_error **error)
 
rs2_option rs2_get_option_from_list (const rs2_options_list *options, int i, rs2_error **error)
 
const char * rs2_get_option_name (const rs2_options *options, rs2_option option, rs2_error **error)
 
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)
 
rs2_options_listrs2_get_options_list (const rs2_options *options, rs2_error **error)
 
int rs2_get_options_list_size (const rs2_options_list *options, rs2_error **error)
 
const char * rs2_host_perf_mode_to_string (rs2_host_perf_mode perf)
 
int rs2_is_option_read_only (const rs2_options *options, rs2_option option, rs2_error **error)
 
const char * rs2_l500_visual_preset_to_string (rs2_l500_visual_preset preset)
 
const char * rs2_option_to_string (rs2_option option)
 
const char * rs2_rs400_visual_preset_to_string (rs2_rs400_visual_preset preset)
 
const char * rs2_sensor_mode_to_string (rs2_sensor_mode preset)
 
void rs2_set_option (const rs2_options *options, rs2_option option, float value, rs2_error **error)
 
const char * rs2_sr300_visual_preset_to_string (rs2_sr300_visual_preset preset)
 
int rs2_supports_option (const rs2_options *options, rs2_option option, rs2_error **error)
 

Detailed Description

Exposes sensor options functionality for C compilers.

Definition in file rs_option.h.

Typedef Documentation

DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead.

values for RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH option.

digital gain for RS2_OPTION_DIGITAL_GAIN option.

values for RS2_OPTION_HOST_PERFORMANCE option.

For L500 devices: provides optimized settings (presets) for specific types of usage.

typedef enum rs2_option rs2_option

Defines general configuration controls. These can generally be mapped to camera UVC controls, and can be set / queried at any time unless stated otherwise.

For RS400 devices: provides optimized settings (presets) for specific types of usage.

For setting the camera_mode option.

For SR300 devices: provides optimized settings (presets) for specific types of usage.

Enumeration Type Documentation

DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead.

Enumerator
RS2_AMBIENT_LIGHT_NO_AMBIENT 
RS2_AMBIENT_LIGHT_LOW_AMBIENT 

Definition at line 175 of file rs_option.h.

values for RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH option.

Enumerator
RS2_CAH_TRIGGER_MANUAL 

not triggered until you give _NOW

RS2_CAH_TRIGGER_NOW 

triggers CAH and leaves previous value intact!

RS2_CAH_TRIGGER_AUTO 

triggered periodically or with certain conditions

RS2_CAH_TRIGGER_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 192 of file rs_option.h.

digital gain for RS2_OPTION_DIGITAL_GAIN option.

Enumerator
RS2_DIGITAL_GAIN_AUTO 
RS2_DIGITAL_GAIN_HIGH 
RS2_DIGITAL_GAIN_LOW 

Definition at line 183 of file rs_option.h.

values for RS2_OPTION_HOST_PERFORMANCE option.

Enumerator
RS2_HOST_PERF_DEFAULT 

no change in settings, use device defaults

RS2_HOST_PERF_LOW 

low performance host mode, if host cannot keep up with workload, this option may improve stability, for example, it sets larger USB transaction granularity, reduces number of transactions and improve performance and stability on relatively weak hosts as compared to the workload

RS2_HOST_PERF_HIGH 

high performance host mode, if host is strong as compared to the work and can handle workload without delay, this option sets smaller USB transactions granularity and as result larger number of transactions and workload on host, but reduces chance in device frame drops

RS2_HOST_PERF_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 202 of file rs_option.h.

For L500 devices: provides optimized settings (presets) for specific types of usage.

Enumerator
RS2_L500_VISUAL_PRESET_CUSTOM 
RS2_L500_VISUAL_PRESET_DEFAULT 
RS2_L500_VISUAL_PRESET_NO_AMBIENT 
RS2_L500_VISUAL_PRESET_LOW_AMBIENT 
RS2_L500_VISUAL_PRESET_MAX_RANGE 
RS2_L500_VISUAL_PRESET_SHORT_RANGE 
RS2_L500_VISUAL_PRESET_AUTOMATIC 
RS2_L500_VISUAL_PRESET_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 151 of file rs_option.h.

enum rs2_option

Defines general configuration controls. These can generally be mapped to camera UVC controls, and can be set / queried at any time unless stated otherwise.

Enumerator
RS2_OPTION_BACKLIGHT_COMPENSATION 

Enable / disable color backlight compensation

RS2_OPTION_BRIGHTNESS 

Color image brightness

RS2_OPTION_CONTRAST 

Color image contrast

RS2_OPTION_EXPOSURE 

Controls exposure time of color camera. Setting any value will disable auto exposure

RS2_OPTION_GAIN 

Color image gain

RS2_OPTION_GAMMA 

Color image gamma setting

RS2_OPTION_HUE 

Color image hue

RS2_OPTION_SATURATION 

Color image saturation setting

RS2_OPTION_SHARPNESS 

Color image sharpness setting

RS2_OPTION_WHITE_BALANCE 

Controls white balance of color image. Setting any value will disable auto white balance

RS2_OPTION_ENABLE_AUTO_EXPOSURE 

Enable / disable color image auto-exposure

RS2_OPTION_ENABLE_AUTO_WHITE_BALANCE 

Enable / disable color image auto-white-balance

RS2_OPTION_VISUAL_PRESET 

Provide access to several recommend sets of option presets for the depth camera

RS2_OPTION_LASER_POWER 

Power of the laser emitter, with 0 meaning projector off

RS2_OPTION_ACCURACY 

Set the number of patterns projected per frame. The higher the accuracy value the more patterns projected. Increasing the number of patterns help to achieve better accuracy. Note that this control is affecting the Depth FPS

RS2_OPTION_MOTION_RANGE 

Motion vs. Range trade-off, with lower values allowing for better motion sensitivity and higher values allowing for better depth range

RS2_OPTION_FILTER_OPTION 

Set the filter to apply to each depth frame. Each one of the filter is optimized per the application requirements

RS2_OPTION_CONFIDENCE_THRESHOLD 

The confidence level threshold used by the Depth algorithm pipe to set whether a pixel will get a valid range or will be marked with invalid range

RS2_OPTION_EMITTER_ENABLED 

Emitter select: 0 – disable all emitters. 1 – enable laser. 2 – enable auto laser. 3 – enable LED.

RS2_OPTION_FRAMES_QUEUE_SIZE 

Number of frames the user is allowed to keep per stream. Trying to hold-on to more frames will cause frame-drops.

RS2_OPTION_TOTAL_FRAME_DROPS 

Total number of detected frame drops from all streams

RS2_OPTION_AUTO_EXPOSURE_MODE 

Auto-Exposure modes: Static, Anti-Flicker and Hybrid

RS2_OPTION_POWER_LINE_FREQUENCY 

Power Line Frequency control for anti-flickering Off/50Hz/60Hz/Auto

RS2_OPTION_ASIC_TEMPERATURE 

Current Asic Temperature

RS2_OPTION_ERROR_POLLING_ENABLED 

disable error handling

RS2_OPTION_PROJECTOR_TEMPERATURE 

Current Projector Temperature

RS2_OPTION_OUTPUT_TRIGGER_ENABLED 

Enable / disable trigger to be outputed from the camera to any external device on every depth frame

RS2_OPTION_MOTION_MODULE_TEMPERATURE 

Current Motion-Module Temperature

RS2_OPTION_DEPTH_UNITS 

Number of meters represented by a single depth unit

RS2_OPTION_ENABLE_MOTION_CORRECTION 

Enable/Disable automatic correction of the motion data

RS2_OPTION_AUTO_EXPOSURE_PRIORITY 

Allows sensor to dynamically ajust the frame rate depending on lighting conditions

RS2_OPTION_COLOR_SCHEME 

Color scheme for data visualization

RS2_OPTION_HISTOGRAM_EQUALIZATION_ENABLED 

Perform histogram equalization post-processing on the depth data

RS2_OPTION_MIN_DISTANCE 

Minimal distance to the target

RS2_OPTION_MAX_DISTANCE 

Maximum distance to the target

RS2_OPTION_TEXTURE_SOURCE 

Texture mapping stream unique ID

RS2_OPTION_FILTER_MAGNITUDE 

The 2D-filter effect. The specific interpretation is given within the context of the filter

RS2_OPTION_FILTER_SMOOTH_ALPHA 

2D-filter parameter controls the weight/radius for smoothing.

RS2_OPTION_FILTER_SMOOTH_DELTA 

2D-filter range/validity threshold

RS2_OPTION_HOLES_FILL 

Enhance depth data post-processing with holes filling where appropriate

RS2_OPTION_STEREO_BASELINE 

The distance in mm between the first and the second imagers in stereo-based depth cameras

RS2_OPTION_AUTO_EXPOSURE_CONVERGE_STEP 

Allows dynamically ajust the converge step value of the target exposure in Auto-Exposure algorithm

RS2_OPTION_INTER_CAM_SYNC_MODE 

Impose Inter-camera HW synchronization mode. Applicable for D400/L500/Rolling Shutter SKUs

RS2_OPTION_STREAM_FILTER 

Select a stream to process

RS2_OPTION_STREAM_FORMAT_FILTER 

Select a stream format to process

RS2_OPTION_STREAM_INDEX_FILTER 

Select a stream index to process

RS2_OPTION_EMITTER_ON_OFF 

When supported, this option make the camera to switch the emitter state every frame. 0 for disabled, 1 for enabled

RS2_OPTION_ZERO_ORDER_POINT_X 

Deprecated!!! - Zero order point x

RS2_OPTION_ZERO_ORDER_POINT_Y 

Deprecated!!! - Zero order point y

RS2_OPTION_LLD_TEMPERATURE 

LDD temperature

RS2_OPTION_MC_TEMPERATURE 

MC temperature

RS2_OPTION_MA_TEMPERATURE 

MA temperature

RS2_OPTION_HARDWARE_PRESET 

Hardware stream configuration

RS2_OPTION_GLOBAL_TIME_ENABLED 

disable global time

RS2_OPTION_APD_TEMPERATURE 

APD temperature

RS2_OPTION_ENABLE_MAPPING 

Enable an internal map

RS2_OPTION_ENABLE_RELOCALIZATION 

Enable appearance based relocalization

RS2_OPTION_ENABLE_POSE_JUMPING 

Enable position jumping

RS2_OPTION_ENABLE_DYNAMIC_CALIBRATION 

Enable dynamic calibration

RS2_OPTION_DEPTH_OFFSET 

Offset from sensor to depth origin in millimetrers

RS2_OPTION_LED_POWER 

Power of the LED (light emitting diode), with 0 meaning LED off

RS2_OPTION_ZERO_ORDER_ENABLED 

DEPRECATED! - Toggle Zero-Order mode

RS2_OPTION_ENABLE_MAP_PRESERVATION 

Preserve previous map when starting

RS2_OPTION_FREEFALL_DETECTION_ENABLED 

Enable/disable sensor shutdown when a free-fall is detected (on by default)

RS2_OPTION_AVALANCHE_PHOTO_DIODE 

Changes the exposure time of Avalanche Photo Diode in the receiver

RS2_OPTION_POST_PROCESSING_SHARPENING 

Changes the amount of sharpening in the post-processed image

RS2_OPTION_PRE_PROCESSING_SHARPENING 

Changes the amount of sharpening in the pre-processed image

RS2_OPTION_NOISE_FILTERING 

Control edges and background noise

RS2_OPTION_INVALIDATION_BYPASS 

Enable pixel invalidation

RS2_OPTION_AMBIENT_LIGHT 

DEPRECATED! - Use RS2_OPTION_DIGITAL_GAIN instead.

RS2_OPTION_DIGITAL_GAIN 

Change the depth digital gain see rs2_digital_gain for values

RS2_OPTION_SENSOR_MODE 

The resolution mode: see rs2_sensor_mode for values

RS2_OPTION_EMITTER_ALWAYS_ON 

Enable Laser On constantly (GS SKU Only)

RS2_OPTION_THERMAL_COMPENSATION 

Depth Thermal Compensation for selected D400 SKUs

RS2_OPTION_TRIGGER_CAMERA_ACCURACY_HEALTH 

Enable depth & color frame sync with periodic calibration for proper alignment

RS2_OPTION_RESET_CAMERA_ACCURACY_HEALTH 
RS2_OPTION_HOST_PERFORMANCE 

Set host performance mode to optimize device settings so host can keep up with workload, for example, USB transaction granularity, setting option to low performance host leads to larger USB transaction size and reduced number of transactions which improves performance and stability if host is relatively weak as compared to workload

RS2_OPTION_HDR_ENABLED 

Enable / disable HDR

RS2_OPTION_SEQUENCE_NAME 

HDR Sequence name

RS2_OPTION_SEQUENCE_SIZE 

HDR Sequence size

RS2_OPTION_SEQUENCE_ID 

HDR Sequence ID - 0 is not HDR; sequence ID for HDR configuration starts from 1

RS2_OPTION_HUMIDITY_TEMPERATURE 

Humidity temperature [Deg Celsius]

RS2_OPTION_ENABLE_MAX_USABLE_RANGE 

Turn on/off the maximum usable depth sensor range given the amount of ambient light in the scene

RS2_OPTION_ALTERNATE_IR 

Turn on/off the alternate IR, When enabling alternate IR, the IR image is holding the amplitude of the depth correlation.

RS2_OPTION_NOISE_ESTIMATION 

Noise estimation - indicates the noise on the IR image

RS2_OPTION_ENABLE_IR_REFLECTIVITY 

Enables data collection for calculating IR pixel reflectivity

RS2_OPTION_AUTO_EXPOSURE_LIMIT 

Set and get auto exposure limit in microseconds. Default is 0 which means full exposure range. If the requested exposure limit is greater than frame time, it will be set to frame time at runtime. Setting will not take effect until next streaming session.

RS2_OPTION_AUTO_GAIN_LIMIT 

Set and get auto gain limits ranging from 16 to 248. Default is 0 which means full gain. If the requested gain limit is less than 16, it will be set to 16. If the requested gain limit is greater than 248, it will be set to 248. Setting will not take effect until next streaming session.

RS2_OPTION_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 22 of file rs_option.h.

For RS400 devices: provides optimized settings (presets) for specific types of usage.

Enumerator
RS2_RS400_VISUAL_PRESET_CUSTOM 
RS2_RS400_VISUAL_PRESET_DEFAULT 
RS2_RS400_VISUAL_PRESET_HAND 
RS2_RS400_VISUAL_PRESET_HIGH_ACCURACY 
RS2_RS400_VISUAL_PRESET_HIGH_DENSITY 
RS2_RS400_VISUAL_PRESET_MEDIUM_DENSITY 
RS2_RS400_VISUAL_PRESET_REMOVE_IR_PATTERN 
RS2_RS400_VISUAL_PRESET_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 137 of file rs_option.h.

For setting the camera_mode option.

Enumerator
RS2_SENSOR_MODE_VGA 
RS2_SENSOR_MODE_XGA 
RS2_SENSOR_MODE_QVGA 
RS2_SENSOR_MODE_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 165 of file rs_option.h.

For SR300 devices: provides optimized settings (presets) for specific types of usage.

Enumerator
RS2_SR300_VISUAL_PRESET_SHORT_RANGE 

Preset for short range

RS2_SR300_VISUAL_PRESET_LONG_RANGE 

Preset for long range

RS2_SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION 

Preset for background segmentation

RS2_SR300_VISUAL_PRESET_GESTURE_RECOGNITION 

Preset for gesture recognition

RS2_SR300_VISUAL_PRESET_OBJECT_SCANNING 

Preset for object scanning

RS2_SR300_VISUAL_PRESET_FACE_ANALYTICS 

Preset for face analytics

RS2_SR300_VISUAL_PRESET_FACE_LOGIN 

Preset for face login

RS2_SR300_VISUAL_PRESET_GR_CURSOR 

Preset for GR cursor

RS2_SR300_VISUAL_PRESET_DEFAULT 

Camera default settings

RS2_SR300_VISUAL_PRESET_MID_RANGE 

Preset for mid-range

RS2_SR300_VISUAL_PRESET_IR_ONLY 

Preset for IR only

RS2_SR300_VISUAL_PRESET_COUNT 

Number of enumeration values. Not a valid input: intended to be used in for-loops.

Definition at line 119 of file rs_option.h.

Function Documentation

const char* rs2_ambient_light_to_string ( rs2_ambient_light  preset)

Definition at line 1280 of file rs.cpp.

const char* rs2_cah_trigger_to_string ( rs2_cah_trigger  preset)

Definition at line 1282 of file rs.cpp.

void rs2_delete_options_list ( rs2_options_list list)

Deletes options list

Parameters
[in]listlist to delete

Definition at line 672 of file rs.cpp.

const char* rs2_digital_gain_to_string ( rs2_digital_gain  preset)

Definition at line 1281 of file rs.cpp.

float rs2_get_option ( const rs2_options options,
rs2_option  option,
rs2_error **  error 
)

read option value from the sensor

Parameters
[in]optionsthe options container
[in]optionoption id to be queried
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
value of the option

Definition at line 628 of file rs.cpp.

const char* rs2_get_option_description ( const rs2_options options,
rs2_option  option,
rs2_error **  error 
)

get option description

Parameters
[in]optionsthe options container
[in]optionoption id to be checked
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
human-readable option description

Definition at line 1007 of file rs.cpp.

rs2_option rs2_get_option_from_list ( const rs2_options_list options,
int  i,
rs2_error **  error 
)

get the specific option from options list

Parameters
[in]ithe index of the option
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 665 of file rs.cpp.

const char* rs2_get_option_name ( const rs2_options options,
rs2_option  option,
rs2_error **  error 
)

get option name

Parameters
[in]optionsthe options container
[in]optionoption id to be checked
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
human-readable option name

Definition at line 651 of file rs.cpp.

void rs2_get_option_range ( const rs2_options sensor,
rs2_option  option,
float *  min,
float *  max,
float *  step,
float *  def,
rs2_error **  error 
)

retrieve the available range of values of a supported option

Parameters
[in]sensorthe RealSense device
[in]optionthe option whose range should be queried
[out]minthe minimum value which will be accepted for this option
[out]maxthe maximum value which will be accepted for this option
[out]stepthe granularity of options which accept discrete values, or zero if the option accepts continuous values
[out]defthe default value of the option
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 686 of file rs.cpp.

const char* rs2_get_option_value_description ( const rs2_options options,
rs2_option  option,
float  value,
rs2_error **  error 
)

get option value description (in case specific option value hold special meaning)

Parameters
[in]optionsthe options container
[in]optionoption id to be checked
[in]valuevalue of the option
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
human-readable description of a specific value of an option or null if no special meaning

Definition at line 1022 of file rs.cpp.

rs2_options_list* rs2_get_options_list ( const rs2_options options,
rs2_error **  error 
)

get the list of supported options of options container

Parameters
[in]optionsthe options container
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 644 of file rs.cpp.

int rs2_get_options_list_size ( const rs2_options_list options,
rs2_error **  error 
)

get the size of options list

Parameters
[in]optionsthe option list
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 658 of file rs.cpp.

const char* rs2_host_perf_mode_to_string ( rs2_host_perf_mode  perf)

Definition at line 1285 of file rs.cpp.

int rs2_is_option_read_only ( const rs2_options options,
rs2_option  option,
rs2_error **  error 
)

check if an option is read-only

Parameters
[in]optionsthe options container
[in]optionoption id to be checked
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
true if option is read-only

Definition at line 621 of file rs.cpp.

const char* rs2_l500_visual_preset_to_string ( rs2_l500_visual_preset  preset)

Definition at line 1278 of file rs.cpp.

const char* rs2_option_to_string ( rs2_option  option)

Definition at line 1265 of file rs.cpp.

const char* rs2_rs400_visual_preset_to_string ( rs2_rs400_visual_preset  preset)

Definition at line 40 of file rs_advanced_mode.cpp.

const char* rs2_sensor_mode_to_string ( rs2_sensor_mode  preset)

Definition at line 1279 of file rs.cpp.

void rs2_set_option ( const rs2_options options,
rs2_option  option,
float  value,
rs2_error **  error 
)

write new value to sensor option

Parameters
[in]optionsthe options container
[in]optionoption id to be queried
[in]valuenew value for the option
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 636 of file rs.cpp.

const char* rs2_sr300_visual_preset_to_string ( rs2_sr300_visual_preset  preset)

Definition at line 1270 of file rs.cpp.

int rs2_supports_option ( const rs2_options options,
rs2_option  option,
rs2_error **  error 
)

check if particular option is supported by a subdevice

Parameters
[in]optionsthe options container
[in]optionoption id to be checked
[out]errorif non-null, receives any error that occurs during this call, otherwise, errors are ignored
Returns
true if option is supported

Definition at line 679 of file rs.cpp.



librealsense2
Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Sat Apr 3 2021 02:51:18